API Reference
Class
OdtDocument
Native OpenDocument Text document.
Inheritance
- OdfDocument
- OdtDocument
Usage
Explore 4 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 OdtDocument.Create
- Method OdtDocument.Load
- Method OdtDocument.LoadAsync
- Method OdtDocument.LoadFlatXml
Methods
public Boolean AcceptTrackedChange(String id) #Returns:
BooleanAccepts one tracked insertion or deletion.
Parameters
- id System.String
public OdtParagraph AddHeading(String text, Int32 level = 1) #Returns:
OdtParagraphAdds a heading with an outline level from 1 through 10.
Parameters
- text System.String
- level System.Int32 = 1
public OdtList AddList(Boolean ordered = false) #Returns:
OdtListAdds an ordered or unordered list.
Parameters
- ordered System.Boolean = false
public OdtParagraph AddPageBreak() #Returns:
OdtParagraphAdds an empty paragraph that starts on a new page.
public OdtParagraph AddParagraph(String? text = null) #Returns:
OdtParagraphAdds a paragraph to the document body.
Parameters
- text System.String? = null
public OdtSection AddSection(String name) #Returns:
OdtSectionAdds a named section to the document body.
Parameters
- name System.String
public OdtTable AddTable(Int32 rows, Int32 columns, String? name = null) #Returns:
OdtTableAdds a table initialized with the requested row and column count.
Parameters
- rows System.Int32
- columns System.Int32
- name System.String? = null
public OdtTrackedChange AddTrackedParagraphInsertion(String? text, String creator, DateTimeOffset? date = null) #Returns:
OdtTrackedChangeAppends a tracked paragraph insertion.
Parameters
- text System.String?
- creator System.String
- date System.DateTimeOffset? = null
public OdtTrackedChange DeleteParagraphTracked(OdtParagraph paragraph, String creator, DateTimeOffset? date = null) #Returns:
OdtTrackedChangeMarks an existing top-level body paragraph or heading as deleted while retaining its XML in change metadata.
Parameters
- paragraph OfficeIMO.OpenDocument.OdtParagraph
- creator System.String
- date System.DateTimeOffset? = null
Load 2 overloads
public static OdtDocument Load(String path, OdfLoadOptions? options = null) #Returns:
OdtDocumentLoads an ODT document from a path.
Parameters
- path System.String
- options OfficeIMO.OpenDocument.OdfLoadOptions? = null
public static OdtDocument Load(Stream stream, OdfLoadOptions? options = null) #Returns:
OdtDocumentLoads an ODT document from a stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.OpenDocument.OdfLoadOptions? = null
LoadAsync 2 overloads
public static async Task<OdtDocument> LoadAsync(String path, OdfLoadOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<OdtDocument>Asynchronously loads an ODT document from a path.
Parameters
- path System.String
- options OfficeIMO.OpenDocument.OdfLoadOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static async Task<OdtDocument> LoadAsync(Stream stream, OdfLoadOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<OdtDocument>Asynchronously loads an ODT 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 OdtDocument LoadFlatXml(Stream stream, OdfLoadOptions? options = null) #Returns:
OdtDocumentLoads a flat OpenDocument Text XML stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.OpenDocument.OdfLoadOptions? = null
public static OdtDocument LoadFlatXml(String path, OdfLoadOptions? options = null) #Returns:
OdtDocumentLoads a flat OpenDocument Text XML path.
Parameters
- path System.String
- options OfficeIMO.OpenDocument.OdfLoadOptions? = null
public Boolean RejectTrackedChange(String id) #Returns:
BooleanRejects one tracked insertion or deletion.
Parameters
- id 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<OdtParagraph> Paragraphs { get; } #Paragraphs and headings in document body order.
public IReadOnlyList<OdtTable> Tables { get; } #Top-level tables in the document body.
public IReadOnlyList<OdtList> Lists { get; } #Top-level lists in the document body.
public IReadOnlyList<OdtSection> Sections { get; } #Top-level named sections in the document body.
public IReadOnlyList<OdtContentBlock> ContentBlocks { get; } #Paragraph, heading, and table blocks in reading order without duplicating table-cell paragraphs.
public OdtPageLayout PageLayout { get; } #Page layout, margins, header, and footer through the first master page.
public IReadOnlyList<OdtTrackedChange> TrackedChanges { get; } #Tracked changes declared by the document.
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