Table of Contents

Class FlatImageDocument

Namespace
OdfKit.Image
Assembly
OdfKit.dll

Represents an ODF flat XML image document (FODI). 表示 ODF 扁平 XML 影像文件（FODI）。

public sealed class FlatImageDocument : OdfImageDocument, IDisposable, IAsyncDisposable
Inheritance
FlatImageDocument
Implements
Inherited Members

Constructors

FlatImageDocument(OdfPackage)

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

public FlatImageDocument(OdfPackage package)

Parameters

package OdfPackage

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

Methods

Create()

Creates a new FODI flat XML image document. 建立新的 FODI 扁平 XML 影像文件。

public static FlatImageDocument Create()

Returns

FlatImageDocument

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

CreateFromDocument(OdfImageDocument)

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

public static FlatImageDocument CreateFromDocument(OdfImageDocument document)

Parameters

document OdfImageDocument

The source ODI image document. / 來源 ODI 影像文件。

Returns

FlatImageDocument

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

Load(Stream)

Loads a FODI flat XML image document from the specified stream. 從指定資料流載入 FODI 扁平 XML 影像文件。

public static FlatImageDocument Load(Stream stream)

Parameters

stream Stream

Returns

FlatImageDocument

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

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

Parameters

stream Stream
fileName string

Returns

FlatImageDocument

Load(string)

Loads a FODI flat XML image document from the specified path. 從指定路徑載入 FODI 扁平 XML 影像文件。

public static FlatImageDocument Load(string path)

Parameters

path string

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

Returns

FlatImageDocument

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

LoadAsync(Stream)

Asynchronously loads a FODI flat XML image document from the specified stream. 非同步從指定資料流載入 FODI 扁平 XML 影像文件。

public static Task<FlatImageDocument> LoadAsync(Stream stream)

Parameters

stream Stream

Returns

Task<FlatImageDocument>

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

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

Parameters

stream Stream
fileName string

Returns

Task<FlatImageDocument>

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

Parameters

stream Stream
fileName string
cancellationToken CancellationToken

Returns

Task<FlatImageDocument>

LoadAsync(Stream, CancellationToken)

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

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

Parameters

stream Stream

The document stream. / 文件資料流。

cancellationToken CancellationToken

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

Returns

Task<FlatImageDocument>

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

LoadAsync(string)

Asynchronously loads a FODI flat XML image document from the specified path. 非同步從指定路徑載入 FODI 扁平 XML 影像文件。

public static Task<FlatImageDocument> LoadAsync(string path)

Parameters

path string

Returns

Task<FlatImageDocument>

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

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

Parameters

path string
cancellationToken CancellationToken

Returns

Task<FlatImageDocument>