API Reference
Class
OdsDocument
Native OpenDocument Spreadsheet document.
Inheritance
- OdfDocument
- OdsDocument
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method OdsDocument.Create
- Method OdsDocument.Load
- Method OdsDocument.Load
- Method OdsDocument.LoadAsync
- Method OdsDocument.LoadAsync
- Method OdsDocument.LoadFlatXml
- Method OdsDocument.LoadFlatXml
Accepted by parameters
Methods
public OdsDataStyle AddCurrencyStyle(String name, String currencySymbol, Int32 decimalPlaces = 2) #Returns:
OdsDataStyleAdds a currency style with a visible currency symbol or code.
Parameters
- name System.String
- currencySymbol System.String
- decimalPlaces System.Int32 = 2
public OdsDataStyle AddDateStyle(String name) #Returns:
OdsDataStyleAdds an ISO-style year-month-day date format.
Parameters
- name System.String
public OdsNamedRange AddNamedRange(String name, String cellRangeAddress, String baseCellAddress = null) #Returns:
OdsNamedRangeAdds a workbook-scoped named range using ODF address syntax.
Parameters
- name System.String
- cellRangeAddress System.String
- baseCellAddress System.String = null
public OdsDataStyle AddNumberStyle(String name, Int32 decimalPlaces = 2) #Returns:
OdsDataStyleAdds a decimal number style.
Parameters
- name System.String
- decimalPlaces System.Int32 = 2
public OdsDataStyle AddPercentageStyle(String name, Int32 decimalPlaces = 2) #Returns:
OdsDataStyleAdds a percentage style.
Parameters
- name System.String
- decimalPlaces System.Int32 = 2
public OdsSheet AddSheet(String name) #Returns:
OdsSheetAdds an empty worksheet.
Parameters
- name System.String
public OdsDataStyle AddTimeStyle(String name) #Returns:
OdsDataStyleAdds a 24-hour time format with seconds.
Parameters
- name System.String
public OdsValidation AddValidation(String name, String condition, Boolean allowEmptyCell = true) #Returns:
OdsValidationAdds a validation rule with a preserved ODF condition expression.
Parameters
- name System.String
- condition System.String
- allowEmptyCell System.Boolean = true
public OdsSheet GetSheet(String name) #Returns:
OdsSheetFinds a worksheet by its case-sensitive name.
Parameters
- name System.String
Load 2 overloads
public static OdsDocument Load(String path, OdfLoadOptions options = null) #Returns:
OdsDocumentLoads an ODS document from a path.
Parameters
- path System.String
- options OfficeIMO.OpenDocument.OdfLoadOptions = null
public static OdsDocument Load(Stream stream, OdfLoadOptions options = null) #Returns:
OdsDocumentLoads an ODS document from a stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.OpenDocument.OdfLoadOptions = null
LoadAsync 2 overloads
public static async Task<OdsDocument> LoadAsync(String path, OdfLoadOptions options = null, CancellationToken cancellationToken = null) #Returns:
Task<OdsDocument>Asynchronously loads an ODS document from a path.
Parameters
- path System.String
- options OfficeIMO.OpenDocument.OdfLoadOptions = null
- cancellationToken System.Threading.CancellationToken = null
public static async Task<OdsDocument> LoadAsync(Stream stream, OdfLoadOptions options = null, CancellationToken cancellationToken = null) #Returns:
Task<OdsDocument>Asynchronously loads an ODS document from a caller-owned stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.OpenDocument.OdfLoadOptions = null
- cancellationToken System.Threading.CancellationToken = null
LoadFlatXml 2 overloads
public static OdsDocument LoadFlatXml(Stream stream, OdfLoadOptions options = null) #Returns:
OdsDocumentLoads a flat OpenDocument Spreadsheet XML stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.OpenDocument.OdfLoadOptions = null
public static OdsDocument LoadFlatXml(String path, OdfLoadOptions options = null) #Returns:
OdsDocumentLoads a flat OpenDocument Spreadsheet XML path.
Parameters
- path System.String
- options OfficeIMO.OpenDocument.OdfLoadOptions = null
public Void MoveSheet(String name, Int32 newIndex) #Returns:
VoidMoves a worksheet to a zero-based position.
Parameters
- name System.String
- newIndex System.Int32
public OdsRecalculationReport Recalculate(OdsFormulaEvaluationOptions options = null) #Returns:
OdsRecalculationReportEvaluates the supported OpenFormula subset and updates cached values within configured bounds.
Parameters
- options OfficeIMO.OpenDocument.OdsFormulaEvaluationOptions = null
public Boolean RemoveSheet(String name) #Returns:
BooleanRemoves a worksheet.
Parameters
- name System.String
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
public Byte[] GetPackageEntryBytes(String path) #Returns:
Byte[]Inherited from OdfDocument
Parameters
- path String
Save 3 overloads
public OdfSaveResult Save(OdfSaveOptions options = null) #Returns:
OdfSaveResultInherited from OdfDocument
Parameters
- options OdfSaveOptions = null
public OdfSaveResult Save(String path, OdfSaveOptions options = null) #Returns:
OdfSaveResultInherited from OdfDocument
Parameters
- path String
- options OdfSaveOptions = null
public OdfSaveResult Save(Stream destination, OdfSaveOptions options = null) #Returns:
OdfSaveResultInherited from OdfDocument
Parameters
- destination Stream
- options OdfSaveOptions = null
SaveAsync 4 overloads
public Task<OdfSaveResult> SaveAsync(CancellationToken cancellationToken = null) #Returns:
Task<OdfSaveResult>Inherited from OdfDocument
Parameters
- cancellationToken CancellationToken = null
public Task<OdfSaveResult> SaveAsync(OdfSaveOptions options, CancellationToken cancellationToken = null) #Returns:
Task<OdfSaveResult>Inherited from OdfDocument
Parameters
- options OdfSaveOptions
- cancellationToken CancellationToken = null
public async Task<OdfSaveResult> SaveAsync(String path, OdfSaveOptions options = null, CancellationToken cancellationToken = null) #Returns:
Task<OdfSaveResult>Inherited from OdfDocument
Parameters
- path String
- options OdfSaveOptions = null
- cancellationToken CancellationToken = null
public async Task<OdfSaveResult> SaveAsync(Stream destination, OdfSaveOptions options = null, CancellationToken cancellationToken = null) #Returns:
Task<OdfSaveResult>Inherited from OdfDocument
Parameters
- destination Stream
- options OdfSaveOptions = null
- cancellationToken CancellationToken = null
public OdfSaveResult SaveCopy(String path, OdfSaveOptions options = null) #Returns:
OdfSaveResultInherited from OdfDocument
Parameters
- path String
- options OdfSaveOptions = null
public async Task<OdfSaveResult> SaveCopyAsync(String path, OdfSaveOptions options = null, CancellationToken cancellationToken = null) #Returns:
Task<OdfSaveResult>Inherited from OdfDocument
Parameters
- path String
- options OdfSaveOptions = null
- cancellationToken CancellationToken = null
SaveFlatXml 2 overloads
public OdfSaveResult SaveFlatXml(Stream destination) #Returns:
OdfSaveResultInherited from OdfDocument
Parameters
- destination Stream
public OdfSaveResult SaveFlatXml(String path) #Returns:
OdfSaveResultInherited from OdfDocument
Parameters
- path String
public OdfSaveResult Serialize(OdfSaveOptions options = null) #Returns:
OdfSaveResultInherited from OdfDocument
Parameters
- options OdfSaveOptions = null
public Byte[] ToBytes(OdfSaveOptions options = null) #Returns:
Byte[]Inherited from OdfDocument
Parameters
- options OdfSaveOptions = null
public MemoryStream ToStream(OdfSaveOptions options = null) #Returns:
MemoryStreamInherited from OdfDocument
Parameters
- options OdfSaveOptions = null
Properties
public IReadOnlyList<OdsDataStyle> DataStyles { get; } #Number and date/time styles available in this spreadsheet.
public IReadOnlyList<OdsSheet> Sheets { get; } #Worksheets in document order.
public IReadOnlyList<OdsNamedRange> NamedRanges { get; } #Named ranges stored at workbook scope.
public IReadOnlyList<OdsValidation> Validations { get; } #Content validation rules stored at workbook scope.
Inherited Properties
public OdfDocumentKind Kind { get; } #Inherited from OdfDocument
public String FilePath { get; } #Inherited from OdfDocument
public OdfVersion Version { get; } #Inherited from OdfDocument
public OdfDocumentMetadata Metadata { get; } #Inherited from OdfDocument
public OdfStyleRepository Styles { get; } #Inherited from OdfDocument
public IReadOnlyList<OdfDiagnostic> Diagnostics { get; } #Inherited from OdfDocument
public IReadOnlyList<String> PackageEntries { get; } #Inherited from OdfDocument