Table of Contents

Class FlatFormulaDocument

Namespace
OdfKit.Formula
Assembly
OdfKit.dll

Represents an ODF flat XML formula document (FDF). 表示 ODF 扁平 XML 公式文件(FDF)。

public sealed class FlatFormulaDocument : FormulaDocument, IDisposable, IAsyncDisposable
Inheritance
FlatFormulaDocument
Implements
Inherited Members

Constructors

FlatFormulaDocument(OdfPackage)

Initializes a new instance of the FlatFormulaDocument class with the specified ODF package. 使用指定的 ODF 封裝初始化 FlatFormulaDocument 類別的新執行個體。

public FlatFormulaDocument(OdfPackage package)

Parameters

package OdfPackage

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

FlatFormulaDocument(OdfPackage, string)

Initializes a new instance of the FlatFormulaDocument class with the specified ODF package and sub-path. 使用指定的 ODF 封裝與子路徑初始化 FlatFormulaDocument 類別的新執行個體。

public FlatFormulaDocument(OdfPackage package, string subPath)

Parameters

package OdfPackage

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

subPath string

The sub-path within the package. / 封裝內的子路徑。

Methods

Create()

Creates a new FDF flat XML formula document. 建立新的 FDF 扁平 XML 公式文件。

public static FlatFormulaDocument Create()

Returns

FlatFormulaDocument

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

CreateFromDocument(FormulaDocument)

Creates an equivalent FDF flat XML formula document from an existing ODF (ZIP package) formula document, preserving the same content. 從現有的 ODF(ZIP 封裝)公式文件建立等價的 FDF 扁平 XML 公式文件,內容完全相同。

public static FlatFormulaDocument CreateFromDocument(FormulaDocument document)

Parameters

document FormulaDocument

The source ODF formula document. / 來源 ODF 公式文件。

Returns

FlatFormulaDocument

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

Load(Stream)

Loads an FDF flat XML formula document from the specified stream. 從指定資料流載入 FDF 扁平 XML 公式文件。

public static FlatFormulaDocument Load(Stream stream)

Parameters

stream Stream

Returns

FlatFormulaDocument

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

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 FlatFormulaDocument Load(Stream stream, string? fileName)

Parameters

stream Stream
fileName string

Returns

FlatFormulaDocument

Load(string)

Loads an FDF flat XML formula document from the specified path. 從指定路徑載入 FDF 扁平 XML 公式文件。

public static FlatFormulaDocument Load(string path)

Parameters

path string

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

Returns

FlatFormulaDocument

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

LoadAsync(Stream)

Asynchronously loads an FDF flat XML formula document from the specified stream. 非同步從指定資料流載入 FDF 扁平 XML 公式文件。

public static Task<FlatFormulaDocument> LoadAsync(Stream stream)

Parameters

stream Stream

Returns

Task<FlatFormulaDocument>

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

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<FlatFormulaDocument> LoadAsync(Stream stream, string? fileName)

Parameters

stream Stream
fileName string

Returns

Task<FlatFormulaDocument>

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<FlatFormulaDocument> LoadAsync(Stream stream, string? fileName, CancellationToken cancellationToken)

Parameters

stream Stream
fileName string
cancellationToken CancellationToken

Returns

Task<FlatFormulaDocument>

LoadAsync(Stream, CancellationToken)

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

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

Parameters

stream Stream

The document stream. / 文件資料流。

cancellationToken CancellationToken

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

Returns

Task<FlatFormulaDocument>

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

LoadAsync(string)

Asynchronously loads an FDF flat XML formula document from the specified path. 非同步從指定路徑載入 FDF 扁平 XML 公式文件。

public static Task<FlatFormulaDocument> LoadAsync(string path)

Parameters

path string

Returns

Task<FlatFormulaDocument>

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

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<FlatFormulaDocument> LoadAsync(string path, CancellationToken cancellationToken)

Parameters

path string
cancellationToken CancellationToken

Returns

Task<FlatFormulaDocument>