API Reference
Class
OdsDocument
Native OpenDocument Spreadsheet document.
Inheritance
- OdfDocument
- OdsDocument
Usage
Explore 6 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 4
- Method OdsDocument.Create
- Method OdsDocument.Load
- Method OdsDocument.LoadAsync
- Method OdsDocument.LoadFlatXml
Accepted by parameters 2
Methods
public OdsDataStyle AddCurrencyStyle(String name, String currencySymbol, Int32 decimalPlaces = 2, Boolean useGrouping = false) #Returns:
OdsDataStyleAdds a currency style with a visible currency symbol or code.
Parameters
- name System.String
- currencySymbol System.String
- decimalPlaces System.Int32 = 2
- useGrouping System.Boolean = false
public OdsDataPilotTable AddDataPilotTable(String name, String sourceRangeAddress, String targetRangeAddress) #Returns:
OdsDataPilotTableAdds a local-range ODF data pilot table; the caller supplies the complete output range.
Parameters
- name System.String
- sourceRangeAddress System.String
- targetRangeAddress System.String
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, Boolean useGrouping = false) #Returns:
OdsDataStyleAdds a decimal number style.
Parameters
- name System.String
- decimalPlaces System.Int32 = 2
- useGrouping System.Boolean = false
public OdsDataStyle AddPercentageStyle(String name, Int32 decimalPlaces = 2, Boolean useGrouping = false) #Returns:
OdsDataStyleAdds a percentage style.
Parameters
- name System.String
- decimalPlaces System.Int32 = 2
- useGrouping System.Boolean = false
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
AddValidation 2 overloads
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 OdsValidation AddValidation(String name, OdsValidationConditionSyntax condition, Boolean allowEmptyCell = true) #Returns:
OdsValidationAdds a validation rule from typed interoperable condition syntax.
Parameters
- name System.String
- condition OfficeIMO.OpenDocument.OdsValidationConditionSyntax
- allowEmptyCell System.Boolean = true
public OdsSheet? GetSheet(String name) #Returns:
OdsSheet?Finds 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 = default) #Returns:
Task<OdsDocument>Asynchronously loads an ODS document from a path.
Parameters
- path System.String
- options OfficeIMO.OpenDocument.OdfLoadOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static async Task<OdsDocument> LoadAsync(Stream stream, OdfLoadOptions? options = null, CancellationToken cancellationToken = default) #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 = default
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 virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
public IReadOnlyList<OfficeEmbeddedPayloadInfo> GetEmbeddedPayloads(OfficeEmbeddedPayloadInspectionOptions options, CancellationToken cancellationToken = default) #Returns:
IReadOnlyList<OfficeEmbeddedPayloadInfo>Inherited from OdfDocument
Parameters
- options OfficeEmbeddedPayloadInspectionOptions
- cancellationToken CancellationToken = default
public Int64 GetPackageEntryByteLength(String reference) #Returns:
Int64Inherited from OdfDocument
Parameters
- reference String
GetPackageEntryBytes 2 overloads
public Byte[] GetPackageEntryBytes(String path) #Returns:
Byte[]Inherited from OdfDocument
Parameters
- path String
public Byte[] GetPackageEntryBytes(String path, Int64 maximumBytes) #Returns:
Byte[]Inherited from OdfDocument
Parameters
- path String
- maximumBytes Int64
public String? GetPackageEntryMediaType(String reference) #Returns:
String?Inherited from OdfDocument
Parameters
- reference String
public OdfPackageEntryPayloadState GetPackageEntryPayloadState(String reference) #Returns:
OdfPackageEntryPayloadStateInherited from OdfDocument
Parameters
- reference String
public OfficeEmbeddedPayloadInspection InspectEmbeddedPayloads(OfficeEmbeddedPayloadInspectionOptions? options = null, CancellationToken cancellationToken = default) #Returns:
OfficeEmbeddedPayloadInspectionInherited from OdfDocument
Parameters
- options OfficeEmbeddedPayloadInspectionOptions? = null
- cancellationToken CancellationToken = default
InspectFeatures 2 overloads
public OdfFeatureReport InspectFeatures(CancellationToken cancellationToken) #Returns:
OdfFeatureReportInherited from OdfDocument
Parameters
- cancellationToken CancellationToken
public OfficeContentSafetyReport InspectLoadedContentSafety(OfficeContentSafetyOptions? options = null, CancellationToken cancellationToken = default) #Returns:
OfficeContentSafetyReportInherited from OdfDocument
Parameters
- options OfficeContentSafetyOptions? = null
- cancellationToken CancellationToken = default
public Stream OpenEmbeddedPayload(String id, Int64 maximumBytes, CancellationToken cancellationToken = default) #Returns:
StreamInherited from OdfDocument
Parameters
- id String
- maximumBytes Int64
- cancellationToken CancellationToken = default
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 = default) #Returns:
Task<OdfSaveResult>Inherited from OdfDocument
Parameters
- cancellationToken CancellationToken = default
public Task<OdfSaveResult> SaveAsync(OdfSaveOptions? options, CancellationToken cancellationToken = default) #Returns:
Task<OdfSaveResult>Inherited from OdfDocument
Parameters
- options OdfSaveOptions?
- cancellationToken CancellationToken = default
public async Task<OdfSaveResult> SaveAsync(String path, OdfSaveOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<OdfSaveResult>Inherited from OdfDocument
Parameters
- path String
- options OdfSaveOptions? = null
- cancellationToken CancellationToken = default
public async Task<OdfSaveResult> SaveAsync(Stream destination, OdfSaveOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<OdfSaveResult>Inherited from OdfDocument
Parameters
- destination Stream
- options OdfSaveOptions? = null
- cancellationToken CancellationToken = default
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 = default) #Returns:
Task<OdfSaveResult>Inherited from OdfDocument
Parameters
- path String
- options OdfSaveOptions? = null
- cancellationToken CancellationToken = default
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<OdsNamedRange> NamedRanges { get; } #Named ranges stored at workbook scope.
public IReadOnlyList<OdsValidation> Validations { get; } #Content validation rules stored at workbook scope.
public IReadOnlyList<OdsDataPilotTable> DataPilotTables { get; } #Native data pilot tables in document order.
Inherited Properties
public IReadOnlyList<OdfDiagnostic> Diagnostics { get; } #Inherited from OdfDocument
public IReadOnlyList<String> PackageEntries { get; } #Inherited from OdfDocument
public IReadOnlyList<String> BinaryPayloadEntries { get; } #Inherited from OdfDocument