Table of Contents

Class DatabaseDocument

Namespace
OdfKit.Database
Assembly
OdfKit.dll

Represents a high-level ODF database document. 表示高階 ODF 資料庫文件（Database Document）的類別。

public class DatabaseDocument : OdfDatabaseDocument, IDisposable, IAsyncDisposable
Inheritance
DatabaseDocument
Implements
Inherited Members

Constructors

DatabaseDocument(OdfPackage)

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

public DatabaseDocument(OdfPackage package)

Parameters

package OdfPackage

The ODF package instance. / ODF 封裝執行個體。

Methods

Create()

Creates a new high-level ODB database document. 建立新的高階 ODB 資料庫文件。

public static DatabaseDocument Create()

Returns

DatabaseDocument

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

Load(Stream)

Loads a high-level ODB database document from the specified stream. 從指定資料流載入高階 ODB 資料庫文件。

public static DatabaseDocument Load(Stream stream)

Parameters

stream Stream

Returns

DatabaseDocument

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

Load(Stream, string?)

Full overload of Load that accepts stream and fileName. Load 完整多載：接受 stream 與 fileName。

public static DatabaseDocument Load(Stream stream, string? fileName)

Parameters

stream Stream
fileName string

Returns

DatabaseDocument

Load(string)

Loads a high-level ODB database document from the specified path. 從指定路徑載入高階 ODB 資料庫文件。

public static DatabaseDocument Load(string path)

Parameters

path string

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

Returns

DatabaseDocument

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

LoadAsync(Stream)

Asynchronously loads a high-level ODB database document from the specified stream. 非同步從指定資料流載入高階 ODB 資料庫文件。

public static Task<DatabaseDocument> LoadAsync(Stream stream)

Parameters

stream Stream

Returns

Task<DatabaseDocument>

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

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

Parameters

stream Stream
fileName string

Returns

Task<DatabaseDocument>

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

Parameters

stream Stream
fileName string
cancellationToken CancellationToken

Returns

Task<DatabaseDocument>

LoadAsync(Stream, CancellationToken)

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

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

Parameters

stream Stream

The document stream. / 文件資料流。

cancellationToken CancellationToken

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

Returns

Task<DatabaseDocument>

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

LoadAsync(string)

Asynchronously loads a high-level ODB database document from the specified path. 非同步從指定路徑載入高階 ODB 資料庫文件。

public static Task<DatabaseDocument> LoadAsync(string path)

Parameters

path string

Returns

Task<DatabaseDocument>

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

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

Parameters

path string
cancellationToken CancellationToken

Returns

Task<DatabaseDocument>