Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

ExcelWriterOptions

OfficeIMO.Excel

Namespace
OfficeIMO.Excel
Assembly
OfficeIMO.Excel
Source revision
e163ccb36643 with working tree changes
Modifiers
sealed

Configures package-native tabular XLSX exports.

Inheritance

  • object
  • ExcelWriterOptions

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.

Accepted by parameters 1

Constructors

public ExcelWriterOptions() #

Properties

public bool RequireStreaming { get; set; } #

Rejects settings that require materializing the source rows before writing. For data readers, disable shared strings and automatic sizing; tables require headers. The workbook writer always enforces bounded streaming, including tables with headers.

public string SheetName { get; set; } #

Worksheet name.

public bool IncludeHeaders { get; set; } #

Writes column names as the first worksheet row.

public bool CreateTable { get; set; } #

Creates an Excel table over the exported range.

public string? TableName { get; set; } #

Optional Excel table name.

public ExcelTableStyle TableStyle { get; set; } #

Excel table style used when ExcelWriterOptions.CreateTable is enabled.

public bool IncludeAutoFilter { get; set; } #

Includes table filter buttons when a table is created.

public bool AutoFit { get; set; } #

Calculates worksheet column widths from exported values.

public bool UseCellValueNumberFormats { get; set; } #

Uses the workbook's CellValue date and time number formats.

public bool IncludeCellReferences { get; set; } #

Writes explicit row and cell references. Disable for a smaller contiguous worksheet package.

public bool UseSharedStrings { get; set; } #

Requests shared-string storage. The bounded writer rejects this setting; use an editable workbook for shared-string planning. Defaults to false (inline text).

public ExcelDateSystem DateSystem { get; set; } #

Excel date system used for temporal values.

public IReadOnlyDictionary<string, ExcelStyleDefinition>? Styles { get; set; } #

Named complete styles, copied and compiled before reading source rows or preparing the first row. Styles cannot be registered during a row callback. Memory depends on the declared catalog and columns.

public string? DefaultRowStyle { get; set; } #

Optional declared style used as the default for each data row. Headers are excluded. Row defaults override column defaults as complete styles, without merging properties.

public IReadOnlyDictionary<int, string>? ColumnStyles { get; set; } #

Declared defaults for 1-based columns within the exported schema. Column formatting applies to the entire worksheet column, including headers and cells outside the data range.