Class FlatTextDocument

Namespace

OdfKit.Text

Assembly

OdfKit.dll

Represents an ODF flat XML text document (FODT). 表示 ODF 扁平 XML 文字文件（FODT）。

public sealed class FlatTextDocument : TextDocument, IDisposable, IAsyncDisposable

Inheritance

object

OdfDocument

TextDocument

FlatTextDocument

Implements

IDisposable

IAsyncDisposable

Inherited Members

TextDocument.CreateFromTemplate(TextTemplateDocument)

TextDocument.CreateFromTemplate(TextTemplateDocument, bool)

TextDocument.CreateFromFlatDocument(FlatTextDocument)

TextDocument.CreateFromWebDocument(TextWebDocument)

TextDocument.Builder()

TextDocument.AddTable(int, int)

TextDocument.AppendList()

TextDocument.AppendList(string)

TextDocument.ApplyCjkFontFallback()

TextDocument.AddTableOfContents()

TextDocument.AddTableOfContents(string)

TextDocument.AddTableOfContents(string, int)

TextDocument.InsertTableOfContents()

TextDocument.InsertTableOfContents(string)

TextDocument.InsertTableOfContents(string, int)

TextDocument.ShiftHeadingOutlineLevels(int)

TextDocument.GetDefaultPageSetup()

TextDocument.GetPageSetup(string)

TextDocument.AddPageStyle(string)

TextDocument.AddPageStyle(string, Action<OdfPageSetup>)

TextDocument.GetPageSetups()

TextDocument.GetPageStyleNames()

TextDocument.AddSection(string, int, OdfLength)

TextDocument.AddSubDocumentReference(string, string)

TextDocument.AddSubDocumentReference(string, string, bool)

TextDocument.GetComments()

TextDocument.GetCommentInfos()

TextDocument.AddFontFace(string, string)

TextDocument.AddFontFace(string, string, string)

TextDocument.AddFontFace(string, string, string, string)

TextDocument.MailMerge<T>(T)

TextDocument.MailMerge(IReadOnlyDictionary<string, object>)

TextDocument.MailMerge<T>(IEnumerable<T>)

TextDocument.MailMerge(IEnumerable<IReadOnlyDictionary<string, object>>)

TextDocument.StreamingMailMergeAsync(Stream, IDictionary<string, object>)

TextDocument.StreamingMailMergeAsync(Stream, IDictionary<string, object>, CancellationToken)

TextDocument.StreamingMailMerge(Stream, IDictionary<string, object>)

TextDocument.StreamingMailMerge(string, Stream, IDictionary<string, object>)

TextDocument.AddParagraph()

TextDocument.AddParagraph(string)

TextDocument.BeginParagraphPrebinding()

TextDocument.BeginParagraphPrebinding(string)

TextDocument.AddHeading(string, int)

TextDocument.AddList()

TextDocument.AddList(string)

TextDocument.AddListWithStyle(string, IReadOnlyList<OdfListLevelStyle>)

TextDocument.ExtractFields()

TextDocument.ExtractFields(string)

TextDocument.ExtractFields(string, string)

TextDocument.ExtractFieldInfos()

TextDocument.ExtractFieldInfos(string)

TextDocument.ExtractFieldInfos(string, string)

TextDocument.AddAlphabeticalIndex()

TextDocument.AddAlphabeticalIndex(string)

TextDocument.AddBibliography()

TextDocument.AddBibliography(string)

TextDocument.GetIndexes()

TextDocument.UpdateIndexes()

TextDocument.GetIndexInfos()

TextDocument.GetIndexMarks()

TextDocument.AddTableIndex()

TextDocument.GetBookmarks()

TextDocument.GetHyperlinks()

TextDocument.GetReferenceMarks()

TextDocument.GetFootnotes()

TextDocument.GetEndnotes()

TextDocument.AddImageFrame(OdfParagraph, byte[], OdfLength, OdfLength)

TextDocument.AddImageFrame(OdfParagraph, byte[], OdfLength, OdfLength, string)

TextDocument.AddChart(OdfParagraph, OdfChartDefinition, OdfLength, OdfLength)

TextDocument.AddFormControl(OdfControlType, string, OdfLength, OdfLength, OdfLength, OdfLength)

TextDocument.AddFormControl(OdfControlType, string, OdfLength, OdfLength, OdfLength, OdfLength, string)

TextDocument.AddFormControl(OdfControlType, string, OdfLength, OdfLength, OdfLength, OdfLength, string, IReadOnlyList<string>)

TextDocument.GetFormControls()

TextDocument.ImportHtmlStyles(string)

TextDocument.OptimizeMedia(double, int)

TextDocument.OptimizeMedia(double, int, OdfMediaOptimizer)

TextDocument.ReplaceText(string, string)

TextDocument.ReplaceText(string, string, Action<OdfTextRun>)

TextDocument.ReplaceText(Regex, string)

TextDocument.ReplaceText(Regex, string, Action<OdfTextRun>)

TextDocument.GetUserFieldDeclarations()

TextDocument.AddUserFieldDeclaration(string, string, string)

TextDocument.SetUserFieldValue(string, string)

TextDocument.AcceptAllTrackedChanges()

TextDocument.RejectAllTrackedChanges()

TextDocument.AcceptChange(string)

TextDocument.RejectChange(string)

TextDocument.RecordTrackedChange(string)

TextDocument.RecordTrackedChange(string, OdfNode)

TextDocument.RecordTrackedChange(string, OdfNode, string)

TextDocument.RecordTrackedChange(string, OdfNode, string, string)

TextDocument.AddTrackedChange(string, string, DateTime)

TextDocument.AddTrackedChange(string, string, DateTime, OdfNode)

TextDocument.AddTrackedChange(string, string, DateTime, OdfNode, string)

TextDocument.AddTrackedChange(string, string, DateTime, OdfNode, string, string)

TextDocument.AcceptAllChanges()

TextDocument.RejectAllChanges()

TextDocument.GetTrackedChanges()

TextDocument.GetTableStructuralChanges()

TextDocument.TrackFormatChange(OdfNode, string)

TextDocument.DeleteNode(OdfNode)

TextDocument.BodyTextRoot

TextDocument.Body

TextDocument.Metadata

TextDocument.FormFields

TextDocument.TrackedChanges

TextDocument.TrackChanges

OdfDocument.Create(OdfDocumentKind)

OdfDocument.Load(string, OdfLoadOptions)

OdfDocument.LoadAsync(string, OdfLoadOptions)

OdfDocument.LoadAsync(string, OdfLoadOptions, CancellationToken)

OdfDocument.Load(Stream, OdfLoadOptions)

OdfDocument.Load(Stream, OdfLoadOptions, string)

OdfDocument.LoadAsync(Stream, OdfLoadOptions)

OdfDocument.LoadAsync(Stream, OdfLoadOptions, string)

OdfDocument.LoadAsync(Stream, OdfLoadOptions, string, CancellationToken)

OdfDocument.SanitizeMacros()

OdfDocument.Dispose()

OdfDocument.DisposeAsync()

OdfDocument.ExportToPdf(Stream)

OdfDocument.ExportToPdf(Stream, X509Certificate2)

OdfDocument.GetEmbeddedDocument<T>(string)

OdfDocument.CreateEmbeddedDocument<T>(string)

OdfDocument.SaveEncryptedAsync(string, OdfEncryptionAlgorithm, CancellationToken)

OdfDocument.SaveEncryptedAsync(string, string, OdfEncryptionAlgorithm, CancellationToken)

OdfDocument.SaveEncryptedAsync(Stream, string, OdfEncryptionAlgorithm, CancellationToken)

OdfDocument.LoadEncryptedAsync(string, string, CancellationToken)

OdfDocument.LoadEncryptedAsync(Stream, string, string, CancellationToken)

OdfDocument.Save()

OdfDocument.Save(OdfSaveOptions)

OdfDocument.Save(string)

OdfDocument.Save(string, OdfSaveOptions)

OdfDocument.SaveAsync()

OdfDocument.SaveAsync(OdfSaveOptions)

OdfDocument.SaveAsync(OdfSaveOptions, CancellationToken)

OdfDocument.SaveAsync(string)

OdfDocument.SaveAsync(string, CancellationToken)

OdfDocument.SaveAsync(string, OdfSaveOptions)

OdfDocument.SaveAsync(string, OdfSaveOptions, CancellationToken)

OdfDocument.SaveToBytes()

OdfDocument.SaveToStream(Stream)

OdfDocument.SaveToStream(Stream, OdfSaveOptions)

OdfDocument.SaveAsync(Stream)

OdfDocument.SaveAsync(Stream, CancellationToken)

OdfDocument.SaveAsync(Stream, OdfSaveOptions)

OdfDocument.SaveAsync(Stream, OdfSaveOptions, CancellationToken)

OdfDocument.SaveToStreamAsync(Stream)

OdfDocument.SaveToStreamAsync(Stream, CancellationToken)

OdfDocument.SaveToStreamAsync(Stream, OdfSaveOptions)

OdfDocument.SaveToStreamAsync(Stream, OdfSaveOptions, CancellationToken)

OdfDocument.SaveAsFlatXml(string)

OdfDocument.SaveAsFlatXml(string, OdfSaveOptions)

OdfDocument.SaveAsFlatXml(Stream)

OdfDocument.SaveAsFlatXml(Stream, OdfSaveOptions)

OdfDocument.LoadFromFlatXml(string)

OdfDocument.LoadFromFlatXml(string, OdfLoadOptions)

OdfDocument.LoadFromFlatXml(Stream)

OdfDocument.LoadFromFlatXml(Stream, OdfLoadOptions)

OdfDocument.ConvertZipToFlatXml(string, string)

OdfDocument.ConvertZipToFlatXml(string, string, OdfLoadOptions)

OdfDocument.ConvertZipToFlatXml(string, string, OdfLoadOptions, OdfSaveOptions)

OdfDocument.ConvertFlatXmlToZip(string, string)

OdfDocument.ConvertFlatXmlToZip(string, string, OdfLoadOptions)

OdfDocument.ConvertFlatXmlToZip(string, string, OdfLoadOptions, OdfSaveOptions)

OdfDocument.AdoptNode(OdfNode)

OdfDocument.AdoptNode(OdfDocument, OdfNode)

OdfDocument.AppendDocument(OdfDocument)

OdfDocument.AppendDocument(OdfDocument, OdfMergeOptions)

OdfDocument.SetCustomProperty(string, string)

OdfDocument.SetCustomProperty(string, int)

OdfDocument.SetCustomProperty(string, double)

OdfDocument.SetCustomProperty(string, bool)

OdfDocument.SetCustomProperty(string, DateTime)

OdfDocument.FindCustomProperty(string)

OdfDocument.FindCustomProperty<T>(string)

OdfDocument.GetAllCustomProperties()

OdfDocument.Sign(X509Certificate2)

OdfDocument.SignAsync(X509Certificate2)

OdfDocument.SignAsync(X509Certificate2, CancellationToken)

OdfDocument.SignDocumentAsync(X509Certificate2)

OdfDocument.SignDocumentAsync(X509Certificate2, CancellationToken)

OdfDocument.SignDocumentAsync(X509Certificate2, OdfSigningOptions)

OdfDocument.SignDocumentAsync(X509Certificate2, OdfSigningOptions, CancellationToken)

OdfDocument.GetSignatureSummary()

OdfDocument.VerifySignatures(out X509Certificate2Collection)

OdfDocument.VerifySignatures()

OdfDocument.VerifySignatures(OdfSigningOptions)

OdfDocument.VerifySignaturesAsync()

OdfDocument.VerifySignaturesAsync(CancellationToken)

OdfDocument.VerifySignaturesAsync(OdfSigningOptions)

OdfDocument.VerifySignaturesAsync(OdfSigningOptions, CancellationToken)

OdfDocument.GetMasterPages()

OdfDocument.AddMasterPage(string)

OdfDocument.BeginUpdate()

OdfDocument.EndUpdate()

OdfDocument.Validate()

OdfDocument.Validate(OdfComplianceProfile)

OdfDocument.ValidateAsync()

OdfDocument.ValidateAsync(OdfComplianceProfile)

OdfDocument.ValidateAsync(OdfComplianceProfile, CancellationToken)

OdfDocument.Package

OdfDocument.DocumentKind

OdfDocument.Format

OdfDocument.ContentKind

OdfDocument.IsTemplate

OdfDocument.IsMasterDocument

OdfDocument.IsFlatXml

OdfDocument.TargetVersion

OdfDocument.Styles

OdfDocument.SubPath

OdfDocument.ZoomLevel

OdfDocument.Bookmarks

OdfDocument.LinkUpdateMode

OdfDocument.AutoCalculate

OdfDocument.Title

OdfDocument.Creator

OdfDocument.Description

OdfDocument.Subject

OdfDocument.Language

OdfDocument.CreationDate

OdfDocument.ModificationDate

OdfDocument.TemplateMetadata

OdfDocument.IsUpdateActive

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

FlatTextDocument(OdfPackage)

Initializes a new instance of the FlatTextDocument class. 初始化 FlatTextDocument 類別的新執行個體。

public FlatTextDocument(OdfPackage package)

Parameters

package OdfPackage

The ODF package or flat XML container. / ODF 封裝或扁平 XML 容器。

Methods

Create()

Creates a new FODT flat XML text document. 建立新的 FODT 扁平 XML 文字文件。

public static FlatTextDocument Create()

Returns

FlatTextDocument

A new FlatTextDocument instance. / 新的 FlatTextDocument 執行個體。

CreateFromDocument(TextDocument)

Creates an equivalent FODT flat XML text document from an existing ODT (ZIP package) text document, with identical content. 從現有的 ODT（ZIP 封裝）文字文件建立等價的 FODT 扁平 XML 文字文件，內容完全相同。

public static FlatTextDocument CreateFromDocument(TextDocument document)

Parameters

document TextDocument

The source ODT text document. / 來源 ODT 文字文件。

Returns

FlatTextDocument

The created FlatTextDocument instance. / 建立完成的 FlatTextDocument 執行個體。

Load(Stream)

Loads a FODT flat XML text document from the specified stream. 從指定資料流載入 FODT 扁平 XML 文字文件。

public static FlatTextDocument Load(Stream stream)

Parameters

stream Stream

Returns

FlatTextDocument

The loaded FlatTextDocument instance. / 載入完成的 FlatTextDocument 執行個體。

Load(Stream, string?)

Short overload of Load that accepts stream and fileName; remaining optional parameters use defaults and forward to the full overload. 便利多載：提供 stream 與 fileName；其餘可選參數使用預設值並轉呼叫最長 Load 多載。

public static FlatTextDocument Load(Stream stream, string? fileName)

Parameters

stream Stream

fileName string

Returns

FlatTextDocument

Load(string)

Loads a FODT flat XML text document from the specified path. 從指定路徑載入 FODT 扁平 XML 文字文件。

public static FlatTextDocument Load(string path)

Parameters

path string

The FODT document path. / FODT 文件路徑。

Returns

FlatTextDocument

The loaded FlatTextDocument instance. / 載入完成的 FlatTextDocument 執行個體。

LoadAsync(Stream)

Asynchronously loads a FODT flat XML text document from the specified stream. 非同步從指定資料流載入 FODT 扁平 XML 文字文件。

public static Task<FlatTextDocument> LoadAsync(Stream stream)

Parameters

stream Stream

Returns

Task<FlatTextDocument>

A task representing the asynchronous load operation, whose result is the loaded FlatTextDocument. / 代表非同步載入作業的工作，其結果為載入完成的 FlatTextDocument。

LoadAsync(Stream, string?)

Short overload of LoadAsync that accepts stream and fileName; remaining optional parameters use defaults and forward to the full overload. 便利多載：提供 stream 與 fileName；其餘可選參數使用預設值並轉呼叫最長 LoadAsync 多載。

public static Task<FlatTextDocument> LoadAsync(Stream stream, string? fileName)

Parameters

stream Stream

fileName string

Returns

Task<FlatTextDocument>

LoadAsync(Stream, string?, CancellationToken)

Short overload of LoadAsync that accepts stream, fileName, and cancellationToken; remaining optional parameters use defaults and forward to the full overload. 便利多載：提供 stream、fileName 與 cancellationToken；其餘可選參數使用預設值並轉呼叫最長 LoadAsync 多載。

public static Task<FlatTextDocument> LoadAsync(Stream stream, string? fileName, CancellationToken cancellationToken)

Parameters

stream Stream

fileName string

cancellationToken CancellationToken

Returns

Task<FlatTextDocument>

LoadAsync(Stream, CancellationToken)

Asynchronously loads the document from a stream with a cancellation token. 以取消語彙基元非同步從資料流載入文件。

public static Task<FlatTextDocument> LoadAsync(Stream stream, CancellationToken cancellationToken)

Parameters

stream Stream

The document stream. / 文件資料流。

cancellationToken CancellationToken

The cancellation token. / 取消語彙基元。

Returns

Task<FlatTextDocument>

A task whose result is the loaded document. / 代表非同步載入作業的工作，其結果為載入完成的文件。

LoadAsync(string)

Asynchronously loads a FODT flat XML text document from the specified path. 非同步從指定路徑載入 FODT 扁平 XML 文字文件。

public static Task<FlatTextDocument> LoadAsync(string path)

Parameters

path string

Returns

Task<FlatTextDocument>

A task representing the asynchronous load operation, whose result is the loaded FlatTextDocument. / 代表非同步載入作業的工作，其結果為載入完成的 FlatTextDocument。

LoadAsync(string, CancellationToken)

Short overload of LoadAsync that accepts path and cancellationToken; remaining optional parameters use defaults and forward to the full overload. 便利多載：提供 path 與 cancellationToken；其餘可選參數使用預設值並轉呼叫最長 LoadAsync 多載。

public static Task<FlatTextDocument> LoadAsync(string path, CancellationToken cancellationToken)

Parameters

path string

cancellationToken CancellationToken

Returns

Task<FlatTextDocument>