Table of Contents

Class ImageTemplateDocument

Namespace
OdfKit.Image
Assembly
OdfKit.dll

Represents an ODF image template document (OTI). 表示 ODF 影像範本文件（OTI）。

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

Constructors

ImageTemplateDocument(OdfPackage)

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

public ImageTemplateDocument(OdfPackage package)

Parameters

package OdfPackage

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

Methods

Create()

Creates a new OTI image template document. 建立新的 OTI 影像範本文件。

public static ImageTemplateDocument Create()

Returns

ImageTemplateDocument

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

CreateFromDocument(OdfImageDocument)

Creates a new OTI image template document from an existing ODI image document, fully preserving its image frame content. 從現有的 ODI 影像文件建立新的 OTI 影像範本文件，完整保留其影像框架內容。

public static ImageTemplateDocument CreateFromDocument(OdfImageDocument document)

Parameters

document OdfImageDocument

The image document used as the template content source. / 作為範本內容來源的影像文件。

Returns

ImageTemplateDocument

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

Load(Stream)

Loads an OTI image template document from the specified stream. 從指定資料流載入 OTI 影像範本文件。

public static ImageTemplateDocument Load(Stream stream)

Parameters

stream Stream

Returns

ImageTemplateDocument

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

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

Parameters

stream Stream
fileName string

Returns

ImageTemplateDocument

Load(string)

Loads an OTI image template document from the specified path. 從指定路徑載入 OTI 影像範本文件。

public static ImageTemplateDocument Load(string path)

Parameters

path string

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

Returns

ImageTemplateDocument

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

LoadAsync(Stream)

Asynchronously loads an OTI image template document from the specified stream. 非同步從指定資料流載入 OTI 影像範本文件。

public static Task<ImageTemplateDocument> LoadAsync(Stream stream)

Parameters

stream Stream

Returns

Task<ImageTemplateDocument>

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

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

Parameters

stream Stream
fileName string

Returns

Task<ImageTemplateDocument>

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

Parameters

stream Stream
fileName string
cancellationToken CancellationToken

Returns

Task<ImageTemplateDocument>

LoadAsync(Stream, CancellationToken)

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

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

Parameters

stream Stream

The document stream. / 文件資料流。

cancellationToken CancellationToken

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

Returns

Task<ImageTemplateDocument>

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

LoadAsync(string)

Asynchronously loads an OTI image template document from the specified path. 非同步從指定路徑載入 OTI 影像範本文件。

public static Task<ImageTemplateDocument> LoadAsync(string path)

Parameters

path string

Returns

Task<ImageTemplateDocument>

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

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

Parameters

path string
cancellationToken CancellationToken

Returns

Task<ImageTemplateDocument>