ExcelWorkbookWriter
OfficeIMO.Excel
Writes XLSX worksheets as rows arrive, retaining schemas and workbook metadata rather than source rows.
Inheritance
- object
- ExcelWorkbookWriter
Remarks
Each table returns its observed row count and occupied range. Dispose completes the package; file destinations are published only after every table succeeds. Disposing before any table was written throws InvalidOperationException and leaves the destination untouched.
Usage
Explore 1 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 1
- Method ExcelDocument.CreateWriter
Methods
public void Dispose() #Completes and publishes a successful workbook, or discards a failed file export.
public ExcelDataSetImportResult WriteTable(string name, DataTable table, CancellationToken cancellationToken = default) #Writes the rows and schema of an existing data table without copying its rows.
Parameters
- name string
- table System.Data.DataTable
- cancellationToken System.Threading.CancellationToken = default
Returns
ExcelDataSetImportResultpublic ExcelDataSetImportResult WriteTable(string name, IDataReader reader, CancellationToken cancellationToken = default) #Writes a forward-only reader in one pass. The caller retains ownership of the reader.
Parameters
- name string
- reader System.Data.IDataReader
- cancellationToken System.Threading.CancellationToken = default
Returns
ExcelDataSetImportResultpublic ExcelDataSetImportResult WriteTable<T>(string name, IEnumerable<T?> rows, CancellationToken cancellationToken = default) #Writes one worksheet and its table from the readable scalar properties of T.
Type Parameters
- T
Parameters
- name string
- rows System.Collections.Generic.IEnumerable<T?>
- cancellationToken System.Threading.CancellationToken = default
Returns
ExcelDataSetImportResultpublic Task<ExcelDataSetImportResult> WriteTable<T>(string name, IAsyncEnumerable<T?> rows, CancellationToken cancellationToken = default) #Writes one worksheet from an asynchronous sequence, awaiting and releasing one row at a time.
Type Parameters
- T
Parameters
- name string
- rows System.Collections.Generic.IAsyncEnumerable<T?>
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<ExcelDataSetImportResult>public ExcelDataSetImportResult WriteTable<T>(string name, IEnumerable<T?> rows, IReadOnlyList<string> headers, Action<ExcelTabularRowWriter, T?> writeRow, CancellationToken cancellationToken = default) #Writes a single-pass sequence using an explicit column schema and a row callback.
Type Parameters
- T
Parameters
- name string
- rows System.Collections.Generic.IEnumerable<T?>
- headers System.Collections.Generic.IReadOnlyList<string>
- writeRow System.Action<OfficeIMO.Excel.ExcelDocument.ExcelTabularRowWriter, T?>
- cancellationToken System.Threading.CancellationToken = default
Returns
ExcelDataSetImportResultpublic Task<ExcelDataSetImportResult> WriteTable<T>(string name, IAsyncEnumerable<T?> rows, IReadOnlyList<string> headers, Action<ExcelTabularRowWriter, T?> writeRow, CancellationToken cancellationToken = default) #Writes an asynchronous single-pass sequence using an explicit schema and a row callback.
Type Parameters
- T
Parameters
- name string
- rows System.Collections.Generic.IAsyncEnumerable<T?>
- headers System.Collections.Generic.IReadOnlyList<string>
- writeRow System.Action<OfficeIMO.Excel.ExcelDocument.ExcelTabularRowWriter, T?>
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<ExcelDataSetImportResult>