Table of Contents

Class FlatChartDocument

Namespace
OdfKit.Chart
Assembly
OdfKit.dll

Represents an ODF flat XML chart document (FODC). 表示 ODF 扁平 XML 圖表文件(FODC)。

public sealed class FlatChartDocument : ChartDocument, IDisposable, IAsyncDisposable
Inheritance
FlatChartDocument
Implements
Inherited Members

Constructors

FlatChartDocument(OdfPackage)

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

public FlatChartDocument(OdfPackage package)

Parameters

package OdfPackage

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

FlatChartDocument(OdfPackage, string)

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

public FlatChartDocument(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 FODC flat XML chart document. 建立新的 FODC 扁平 XML 圖表文件。

public static FlatChartDocument Create()

Returns

FlatChartDocument

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

CreateFromDocument(ChartDocument)

Creates an equivalent FODC flat XML chart document from an existing ODC (ZIP package) chart document, with identical content. 從現有的 ODC(ZIP 封裝)圖表文件建立等價的 FODC 扁平 XML 圖表文件,內容完全相同。

public static FlatChartDocument CreateFromDocument(ChartDocument document)

Parameters

document ChartDocument

The source ODC chart document. / 來源 ODC 圖表文件。

Returns

FlatChartDocument

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

Load(Stream)

Loads a FODC flat XML chart document from the specified stream. 從指定資料流載入 FODC 扁平 XML 圖表文件。

public static FlatChartDocument Load(Stream stream)

Parameters

stream Stream

Returns

FlatChartDocument

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

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

Parameters

stream Stream
fileName string

Returns

FlatChartDocument

Load(string)

Loads a FODC flat XML chart document from the specified path. 從指定路徑載入 FODC 扁平 XML 圖表文件。

public static FlatChartDocument Load(string path)

Parameters

path string

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

Returns

FlatChartDocument

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

LoadAsync(Stream)

Asynchronously loads a FODC flat XML chart document from the specified stream. 非同步從指定資料流載入 FODC 扁平 XML 圖表文件。

public static Task<FlatChartDocument> LoadAsync(Stream stream)

Parameters

stream Stream

Returns

Task<FlatChartDocument>

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

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

Parameters

stream Stream
fileName string

Returns

Task<FlatChartDocument>

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

Parameters

stream Stream
fileName string
cancellationToken CancellationToken

Returns

Task<FlatChartDocument>

LoadAsync(Stream, CancellationToken)

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

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

Parameters

stream Stream

The document stream. / 文件資料流。

cancellationToken CancellationToken

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

Returns

Task<FlatChartDocument>

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

LoadAsync(string)

Asynchronously loads a FODC flat XML chart document from the specified path. 非同步從指定路徑載入 FODC 扁平 XML 圖表文件。

public static Task<FlatChartDocument> LoadAsync(string path)

Parameters

path string

Returns

Task<FlatChartDocument>

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

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

Parameters

path string
cancellationToken CancellationToken

Returns

Task<FlatChartDocument>