Table of Contents

Class FlatSpreadsheetDocument

Namespace
OdfKit.Spreadsheet
Assembly
OdfKit.dll

Represents an ODF flat XML spreadsheet document (FODS). 表示 ODF 扁平 XML 試算表文件（FODS）。

public sealed class FlatSpreadsheetDocument : SpreadsheetDocument, IDisposable, IAsyncDisposable
Inheritance
FlatSpreadsheetDocument
Implements
Inherited Members

Constructors

FlatSpreadsheetDocument(OdfPackage)

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

public FlatSpreadsheetDocument(OdfPackage package)

Parameters

package OdfPackage

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

Methods

Create()

Creates a new FODS flat XML spreadsheet document. 建立新的 FODS 扁平 XML 試算表文件。

public static FlatSpreadsheetDocument Create()

Returns

FlatSpreadsheetDocument

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

CreateFromDocument(SpreadsheetDocument)

Creates an equivalent FODS flat XML spreadsheet document from an existing ODS package spreadsheet document, preserving identical content. 從現有的 ODS（ZIP 封裝）試算表文件建立等價的 FODS 扁平 XML 試算表文件，內容完全相同。

public static FlatSpreadsheetDocument CreateFromDocument(SpreadsheetDocument document)

Parameters

document SpreadsheetDocument

The source ODS spreadsheet document. / 來源 ODS 試算表文件。

Returns

FlatSpreadsheetDocument

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

Load(Stream)

Loads a FODS flat XML spreadsheet document from the specified stream. 從指定資料流載入 FODS 扁平 XML 試算表文件。

public static FlatSpreadsheetDocument Load(Stream stream)

Parameters

stream Stream

Returns

FlatSpreadsheetDocument

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

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

Parameters

stream Stream
fileName string

Returns

FlatSpreadsheetDocument

Load(string)

Loads a FODS flat XML spreadsheet document from the specified path. 從指定路徑載入 FODS 扁平 XML 試算表文件。

public static FlatSpreadsheetDocument Load(string path)

Parameters

path string

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

Returns

FlatSpreadsheetDocument

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

LoadAsync(Stream)

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

public static Task<FlatSpreadsheetDocument> LoadAsync(Stream stream)

Parameters

stream Stream

Returns

Task<FlatSpreadsheetDocument>

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

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

Parameters

stream Stream
fileName string

Returns

Task<FlatSpreadsheetDocument>

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

Parameters

stream Stream
fileName string
cancellationToken CancellationToken

Returns

Task<FlatSpreadsheetDocument>

LoadAsync(Stream, CancellationToken)

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

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

Parameters

stream Stream

The document stream. / 文件資料流。

cancellationToken CancellationToken

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

Returns

Task<FlatSpreadsheetDocument>

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

LoadAsync(string)

Asynchronously loads a FODS flat XML spreadsheet document from the specified path. 非同步從指定路徑載入 FODS 扁平 XML 試算表文件。

public static Task<FlatSpreadsheetDocument> LoadAsync(string path)

Parameters

path string

Returns

Task<FlatSpreadsheetDocument>

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

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

Parameters

path string
cancellationToken CancellationToken

Returns

Task<FlatSpreadsheetDocument>