ExcelSheet

Adds an AutoFilter to the worksheet or table.

Parameters

range System.String requiredposition: 0

The cell range to apply the filter to.

filterCriteria System.Collections.Generic.Dictionary{System.UInt32,System.Collections.Generic.IEnumerable{System.String}} = null optionalposition: 1

Optional filter criteria to apply.

Adds a bubble chart using explicit X/Y/size ranges.

Parameters

seriesRanges System.Collections.Generic.IEnumerable{OfficeIMO.Excel.ExcelChartSeriesRange} requiredposition: 0

row System.Int32 requiredposition: 1

column System.Int32 requiredposition: 2

widthPixels System.Int32 = 640 optionalposition: 3

heightPixels System.Int32 = 360 optionalposition: 4

title System.String = null optionalposition: 5

Adds a chart using an A1 range on this sheet.

Parameters

dataRangeA1 System.String requiredposition: 0

row System.Int32 requiredposition: 1

column System.Int32 requiredposition: 2

widthPixels System.Int32 = 640 optionalposition: 3

heightPixels System.Int32 = 360 optionalposition: 4

type OfficeIMO.Excel.ExcelChartType = ColumnClustered optionalposition: 5

hasHeaders System.Boolean = true optionalposition: 6

title System.String = null optionalposition: 7

includeCachedData System.Boolean = true optionalposition: 8

Adds a chart from a table name on this sheet.

Parameters

tableName System.String requiredposition: 0

row System.Int32 requiredposition: 1

column System.Int32 requiredposition: 2

widthPixels System.Int32 = 640 optionalposition: 3

heightPixels System.Int32 = 360 optionalposition: 4

type OfficeIMO.Excel.ExcelChartType = ColumnClustered optionalposition: 5

title System.String = null optionalposition: 6

includeCachedData System.Boolean = true optionalposition: 7

Adds a conditional formatting rule to the specified range.

Parameters

range System.String requiredposition: 0

A1-style range to apply the rule to.

operator DocumentFormat.OpenXml.Spreadsheet.ConditionalFormattingOperatorValues requiredposition: 1

Comparison operator for the rule.

formula1 System.String requiredposition: 2

Primary formula or value.

formula2 System.String = null optionalposition: 3

Optional secondary formula or value.

Adds an image anchored to the specified cell. The top-left of the image will align to the cell's top-left, with optional pixel offsets. Size is specified in pixels and converted to EMUs.

Parameters

row System.Int32 requiredposition: 0

1-based row index.

column System.Int32 requiredposition: 1

1-based column index.

imageBytes System.Byte[] requiredposition: 2

Image bytes.

contentType System.String = "image/png" optionalposition: 3

Content type, e.g. image/png or image/jpeg.

widthPixels System.Int32 = 96 optionalposition: 4

Width in pixels.

heightPixels System.Int32 = 32 optionalposition: 5

Height in pixels.

offsetXPixels System.Int32 = 0 optionalposition: 6

Optional X offset from cell origin in pixels.

offsetYPixels System.Int32 = 0 optionalposition: 7

Optional Y offset from cell origin in pixels.

Downloads an image from URL (with timeout and size limits) and anchors it to the specified cell.

Parameters

row System.Int32 requiredposition: 0

1-based row index where the top edge of the image will be anchored.

column System.Int32 requiredposition: 1

1-based column index where the left edge of the image will be anchored.

url System.String requiredposition: 2

Remote image URL to download. Requests timeout after 5 seconds and must be smaller than 2 MB.

widthPixels System.Int32 = 96 optionalposition: 3

Desired image width in pixels. Defaults to 96 px, converted to English Metric Units (EMUs) for OpenXML positioning.

heightPixels System.Int32 = 32 optionalposition: 4

Desired image height in pixels. Defaults to 32 px, converted to EMUs.

offsetXPixels System.Int32 = 0 optionalposition: 5

Optional horizontal offset in pixels from the cell's left boundary. Positive values move the image right; defaults to 0 px.

offsetYPixels System.Int32 = 0 optionalposition: 6

Optional vertical offset in pixels from the cell's top boundary. Positive values move the image down; defaults to 0 px.

Adds a basic pivot table based on a source range and places it at a destination cell.

Parameters

sourceRange System.String requiredposition: 0

Source data range (including header row), e.g. "A1:D100".

destinationCell System.String requiredposition: 1

Top-left cell for the pivot table (e.g. "F2").

name System.String = null optionalposition: 2

Optional pivot table name. Defaults to "PivotTable1" style.

rowFields System.Collections.Generic.IEnumerable{System.String} = null optionalposition: 3

Optional row fields (header names).

columnFields System.Collections.Generic.IEnumerable{System.String} = null optionalposition: 4

Optional column fields (header names).

pageFields System.Collections.Generic.IEnumerable{System.String} = null optionalposition: 5

Optional page fields (header names) used as filters.

dataFields System.Collections.Generic.IEnumerable{OfficeIMO.Excel.ExcelPivotDataField} = null optionalposition: 6

Optional data field definitions. Defaults to last column with Sum.

showRowGrandTotals System.Boolean = true optionalposition: 7

Show row grand totals.

showColumnGrandTotals System.Boolean = true optionalposition: 8

Show column grand totals.

pivotStyleName System.String = null optionalposition: 9

Optional pivot table style name.

layout OfficeIMO.Excel.ExcelPivotLayout = Compact optionalposition: 10

Layout mode (Compact, Outline, Tabular).

dataOnRows System.Nullable{System.Boolean} = null optionalposition: 11

Whether to show data fields on rows instead of columns.

showHeaders System.Nullable{System.Boolean} = null optionalposition: 12

Whether to show field headers.

showEmptyRows System.Nullable{System.Boolean} = null optionalposition: 13

Whether to show empty rows.

showEmptyColumns System.Nullable{System.Boolean} = null optionalposition: 14

Whether to show empty columns.

showDrill System.Nullable{System.Boolean} = null optionalposition: 15

Whether to show drill indicators.

Adds a scatter chart using explicit X/Y ranges.

Parameters

seriesRanges System.Collections.Generic.IEnumerable{OfficeIMO.Excel.ExcelChartSeriesRange} requiredposition: 0

row System.Int32 requiredposition: 1

column System.Int32 requiredposition: 2

widthPixels System.Int32 = 640 optionalposition: 3

heightPixels System.Int32 = 360 optionalposition: 4

title System.String = null optionalposition: 5

Attaches an AutoFilter to the given A1 range (e.g., "A1:C200").

Parameters

a1Range System.String requiredposition: 0

Applies an AutoFilter numeric inclusive range filter to a column resolved by header within the current AutoFilter range.

Parameters

header System.String requiredposition: 0

minimumInclusive System.Double requiredposition: 1

maximumInclusive System.Double requiredposition: 2

Applies an AutoFilter text contains filter to a column resolved by header within the current AutoFilter range. Uses wildcard pattern matching ("*text*") via CustomFilters with Equal operator. When the header is missing the operation is skipped.

Parameters

header System.String requiredposition: 0

containsText System.String requiredposition: 1

Applies an AutoFilter text does-not-contain filter to a column resolved by header within the current AutoFilter range. Uses wildcard pattern matching ("*text*") via CustomFilters with NotEqual operator.

Parameters

header System.String requiredposition: 0

containsText System.String requiredposition: 1

Applies an AutoFilter text ends-with filter to a column resolved by header within the current AutoFilter range. Uses wildcard pattern matching ("*text") via CustomFilters with Equal operator.

Parameters

header System.String requiredposition: 0

endsWithText System.String requiredposition: 1

Applies an AutoFilter equals filter to a column resolved by header within the current AutoFilter range. Ensures an AutoFilter exists over the sheet's UsedRange when none is present. When the header is missing the operation is skipped.

Parameters

header System.String requiredposition: 0

values System.Collections.Generic.IEnumerable{System.String} requiredposition: 1

Applies an AutoFilter numeric greater-than-or-equal filter to a column resolved by header within the current AutoFilter range.

Parameters

header System.String requiredposition: 0

value System.Double requiredposition: 1

Applies an AutoFilter numeric less-than-or-equal filter to a column resolved by header within the current AutoFilter range.

Parameters

header System.String requiredposition: 0

value System.Double requiredposition: 1

Applies an AutoFilter numeric outside-range filter to a column resolved by header within the current AutoFilter range. Values lower than minimumExclusive or higher than maximumExclusive remain visible.

Parameters

header System.String requiredposition: 0

minimumExclusive System.Double requiredposition: 1

maximumExclusive System.Double requiredposition: 2

Applies an AutoFilter numeric not-equal filter to a column resolved by header within the current AutoFilter range.

Parameters

header System.String requiredposition: 0

value System.Double requiredposition: 1

Applies equals filters for multiple headers at once (AND semantics across columns, OR semantics within a column). Headers that cannot be resolved are ignored.

Parameters

filters System.ValueTuple{System.String,System.Collections.Generic.IEnumerable{System.String}}[] requiredposition: 0

Applies an AutoFilter text starts-with filter to a column resolved by header within the current AutoFilter range. Uses wildcard pattern matching ("text*") via CustomFilters with Equal operator.

Parameters

header System.String requiredposition: 0

startsWithText System.String requiredposition: 1

Clears any AutoFilter from the worksheet.

Auto-fits the width of the specified column based on its contents.

Parameters

columnIndex System.Int32 requiredposition: 0

1-based column index.

Automatically fits all columns based on their content.

Parameters

mode System.Nullable{OfficeIMO.Excel.ExecutionMode} = null optionalposition: 0

Overrides how the auto-fit work is scheduled across columns.

ct System.Threading.CancellationToken = null optionalposition: 1

Cancels the auto-fit pass while widths are being measured or applied.

Automatically fits all columns except the supplied indexes.

Parameters

columnsToSkip System.Collections.Generic.IEnumerable{System.Int32} requiredposition: 0

1-based column indexes that should not be resized.

mode System.Nullable{OfficeIMO.Excel.ExecutionMode} = null optionalposition: 1

Overrides how the auto-fit work is scheduled for the remaining columns.

ct System.Threading.CancellationToken = null optionalposition: 2

Cancels the auto-fit pass before it completes.

Automatically fits the supplied set of column indexes.

Parameters

columnIndexes System.Collections.Generic.IEnumerable{System.Int32} requiredposition: 0

1-based column indexes that should be resized to fit their content.

mode System.Nullable{OfficeIMO.Excel.ExecutionMode} = null optionalposition: 1

Overrides how the auto-fit work is scheduled across the selected columns.

ct System.Threading.CancellationToken = null optionalposition: 2

Cancels the auto-fit pass for the selected columns.

Auto-fits the height of the specified row based on its contents.

Parameters

rowIndex System.Int32 requiredposition: 0

1-based row index.

Automatically fits all rows based on their content.

Parameters

mode System.Nullable{OfficeIMO.Excel.ExecutionMode} = null optionalposition: 0

Overrides how the auto-fit work is scheduled across rows.

ct System.Threading.CancellationToken = null optionalposition: 1

Cancels the row auto-fit pass while heights are being calculated or applied.

Begin a no-lock context where operations bypass locking.

Sets the value, formula, and number format of a cell in a single operation.

Parameters

row System.Int32 requiredposition: 0

The 1-based row index.

column System.Int32 requiredposition: 1

The 1-based column index.

value System.Object = null optionalposition: 2

Optional value to assign.

formula System.String = null optionalposition: 3

Optional formula to apply.

numberFormat System.String = null optionalposition: 4

Optional number format code.

Applies a horizontal alignment to a single cell.

Parameters

row System.Int32 requiredposition: 0

The 1-based row index of the cell to align.

column System.Int32 requiredposition: 1

The 1-based column index of the cell to align.

alignment DocumentFormat.OpenXml.Spreadsheet.HorizontalAlignmentValues requiredposition: 2

The horizontal alignment value to apply.

Applies bold font to a single cell.

Parameters

row System.Int32 requiredposition: 0

The 1-based row index of the cell to modify.

column System.Int32 requiredposition: 1

The 1-based column index of the cell to modify.

bold System.Boolean = true optionalposition: 2

Whether the font should be bold (true) or regular (false).

Applies a font color (ARGB hex or #RRGGBB) to a single cell.

Parameters

row System.Int32 requiredposition: 0

The 1-based row index of the cell to recolor.

column System.Int32 requiredposition: 1

The 1-based column index of the cell to recolor.

hexColor System.String requiredposition: 2

The desired font color expressed as an ARGB or RGB hex string.

Sets a formula in the specified cell.

Parameters

row System.Int32 requiredposition: 0

The 1-based row index.

column System.Int32 requiredposition: 1

The 1-based column index.

formula System.String requiredposition: 2

The formula expression.

Writes multiple cell values efficiently, using parallelization when beneficial.

Parameters

cells System.Collections.Generic.IEnumerable{System.ValueTuple{System.Int32,System.Int32,System.Object}} requiredposition: 0

Collection of cell coordinates and values.

mode System.Nullable{OfficeIMO.Excel.ExecutionMode} = null optionalposition: 1

Optional execution mode override.

ct System.Threading.CancellationToken = null optionalposition: 2

Cancellation token.

Obsolete. Use CancellationToken) with Parallel instead.

Parameters

cells System.Collections.Generic.IEnumerable{System.ValueTuple{System.Int32,System.Int32,System.Object}} requiredposition: 0

Collection of cell coordinates and values.

Sets the value of a cell using a nullable struct.

Type Parameters

T

The value type.

Parameters

row System.Int32 required

The 1-based row index.

column System.Int32 required

The 1-based column index.

value System.Nullable{``0} required

The nullable value to assign.

Clears the cached header map.

Compute-only coercion for parallel scenarios. Does not mutate DOM. Uses SharedStringPlanner for string values.

Parameters

arg1 System.Object required

arg2 OfficeIMO.Excel.SharedStringPlanner required

Returns a builder for styling a column resolved by header with discoverable methods. When the header cannot be resolved an inert builder is returned so calls become no-ops.

Parameters

header System.String requiredposition: 0

Header text used to resolve the target column after applying any configured normalization.

includeHeader System.Boolean = false optionalposition: 1

True to include the header row when styling; false to begin styling from the first data row.

options OfficeIMO.Excel.ExcelReadOptions = null optionalposition: 2

Read options that control header normalization and other resolution behavior.

Persists pending changes on this worksheet to its underlying OpenXml part.

Releases resources held by this worksheet.

Ensures required default style primitives exist and their counts are consistent. Excel expects at least 1 Font, 2 Fills (None, Gray125), 1 Border, 1 CellStyleFormat, and 1 CellFormat present.

Parameters

arg1 DocumentFormat.OpenXml.Spreadsheet.Stylesheet required

Ensures a valid and unique table name according to OfficeIMO rules. Rules: - Allowed characters: letters, digits, underscore; spaces become underscores. - Names cannot start with a digit; an underscore is prefixed if necessary. - Names are scoped per workbook and checked case-insensitively. - When mode is Strict, throws for invalid input. Examples: - "My Table" ⇒ "My_Table" - "Sales#2025" ⇒ "Sales_2025" - "123Report" ⇒ "_123Report" - If "Table" already exists, next becomes "Table2" ("Table3", ...)

Parameters

arg1 System.String required

arg2 OfficeIMO.Excel.TableNameValidationMode required

Ensures all worksheet elements are in the correct order according to OpenXML schema. This must be called before saving to prevent validation errors.

Core execution helper that handles a compute/apply split with optional parallelization. Compute runs without locks; only the apply stage is serialized under a document-level lock.

Parameters

opName System.String required

A short operation name used for diagnostics and policy decisions.

itemCount System.Int32 required

Approximate number of items to process; used to decide parallel vs sequential. This does not have to be exact but should reflect relative workload.

overrideMode System.Nullable{OfficeIMO.Excel.ExecutionMode} required

Force a specific execution mode (Sequential/Parallel); null to use policy (Automatic).

sequentialCore System.Action required

Single-threaded path. Used either when policy decides sequential or when compute/apply are not provided.

computeParallel System.Action required

Compute phase that is safe to run without locks and must not mutate the OpenXML DOM.

applySequential System.Action required

Apply phase that writes to the DOM. This runs once under a serialized lock.

ct System.Threading.CancellationToken required

Cancellation token for the compute phase.

Finds the first cell text that contains the specified value. Returns the A1 address or null. Searches values rendered as text (shared strings, inline strings, numbers as invariant strings).

Parameters

text System.String requiredposition: 0

Iterates over column indices inside an A1 range and invokes action for each column.

Parameters

a1 System.String requiredposition: 0

A1 range without a sheet prefix.

action System.Action{System.Int32} requiredposition: 1

Callback receiving a 1-based column index.

Examples

sheet.ForEachRow("A2:A10", r => sheet.SetInternalLink(r, 1, "'Summary'!A1", "Back"));

Iterates over row indices inside an A1 range and invokes action for each row.

Parameters

a1 System.String requiredposition: 0

A1 range without a sheet prefix.

action System.Action{System.Int32} requiredposition: 1

Callback receiving a 1-based row index.

Examples

var bounds = sheet.GetRangeBounds("A2:D20"); // bounds.r1=2, bounds.c1=1, bounds.r2=20, bounds.c2=4

Applies a number format to the specified cell.

Parameters

row System.Int32 requiredposition: 0

The 1-based row index.

column System.Int32 requiredposition: 1

The 1-based column index.

numberFormat System.String requiredposition: 2

The number format code to apply.

Freezes panes on the worksheet.

Parameters

topRows System.Int32 = 0 optionalposition: 0

Number of rows at the top to freeze.

leftCols System.Int32 = 0 optionalposition: 1

Number of columns on the left to freeze.

Returns all defined names visible to this sheet with their A1 ranges.

Returns a chart by name (non-visual name), or null if not found.

Parameters

name System.String requiredposition: 0

Returns a snapshot of the current header and footer strings (odd pages) split into left/center/right sections, including flags and whether a picture placeholder (&G) is present.

Builds or returns a cached case-insensitive map of header name to 1-based column index using the first row of UsedRange. Cache is keyed by UsedRange A1 and NormalizeHeaders option.

Parameters

options OfficeIMO.Excel.ExcelReadOptions = null optionalposition: 0

Gets the A1 range for the given defined name, scoped to this sheet when applicable.

Parameters

name System.String requiredposition: 0

Defined name to resolve.

Returns

A1 range (e.g. "A1:B5") or null if not found.

Returns pivot tables defined on this worksheet.

Parses an A1 range and returns 1-based bounds (r1, c1, r2, c2).

Parameters

a1 System.String requiredposition: 0

A1 range without a sheet prefix (e.g., "A2:D20").

Returns

Tuple of (r1, c1, r2, c2) with normalized bounds.

Exceptions

• ArgumentException – Thrown when the input is not a valid A1 range.

Returns the used range of this worksheet as an A1 string by leveraging the read bridge.

Parameters

arg1 System.String required

Examples

sheet.SetHyperlinkHost(7, 1, "https://learn.microsoft.com/office/open-xml/"); // displays "learn.microsoft.com"

Returns true when a comment exists for the specified cell.

Parameters

row System.Int32 requiredposition: 0

1-based row index.

column System.Int32 requiredposition: 1

1-based column index.

Fluent header/footer configuration using the same builder as SheetComposer.

Parameters

configure System.Action{OfficeIMO.Excel.Fluent.HeaderFooterBuilder} requiredposition: 0

Convenience: sets a header logo from URL in the given position. Optional page text can be supplied.

Parameters

url System.String requiredposition: 0

position OfficeIMO.Excel.HeaderFooterPosition = Right optionalposition: 1

widthPoints System.Nullable{System.Double} = null optionalposition: 2

heightPoints System.Nullable{System.Double} = null optionalposition: 3

leftText System.String = null optionalposition: 4

centerText System.String = null optionalposition: 5

rightText System.String = null optionalposition: 6

Inserts a DataTable into the worksheet starting at the specified cell. Uses the batch CellValues compute/apply model with SharedString and Style planners.

Parameters

table System.Data.DataTable requiredposition: 0

Source DataTable.

startRow System.Int32 = 1 optionalposition: 1

1-based start row.

startColumn System.Int32 = 1 optionalposition: 2

1-based start column.

includeHeaders System.Boolean = true optionalposition: 3

Whether to write column headers.

mode System.Nullable{OfficeIMO.Excel.ExecutionMode} = null optionalposition: 4

Optional execution mode override.

ct System.Threading.CancellationToken = null optionalposition: 5

Cancellation token.

Inserts a DataTable and immediately creates an Excel Table over the written range. Returns the A1-style range of the created table.

Parameters

table System.Data.DataTable requiredposition: 0

startRow System.Int32 = 1 optionalposition: 1

startColumn System.Int32 = 1 optionalposition: 2

includeHeaders System.Boolean = true optionalposition: 3

tableName System.String = null optionalposition: 4

style OfficeIMO.Excel.TableStyle = TableStyleMedium2 optionalposition: 5

includeAutoFilter System.Boolean = true optionalposition: 6

mode System.Nullable{OfficeIMO.Excel.ExecutionMode} = null optionalposition: 7

ct System.Threading.CancellationToken = null optionalposition: 8

Type Parameters

T

Parameters

items IEnumerable<T> requiredposition: 0

includeHeaders Boolean = true requiredposition: 1

startRow Int32 = 1 requiredposition: 2

Links a column identified by header to internal sheets using each cell's text. Defaults to linking to a sheet with the same name as the cell text. When the header is missing the operation is skipped.

Parameters

header System.String requiredposition: 0

Header text of the column to process.

rowFrom System.Int32 = 2 optionalposition: 1

First data row (1-based). Defaults to 2 (skip header).

rowTo System.Int32 = -1 optionalposition: 2

Last data row (inclusive). When <= 0, uses the bottom of the used range.

destinationSheetForCellText System.Func{System.String,System.String} = null optionalposition: 3

Maps cell text to a destination sheet name; defaults to identity.

targetA1 System.String = "A1" optionalposition: 4

Destination cell on the target sheet (default "A1").

display System.Func{System.String,System.String} = null optionalposition: 5

Optional display selector; defaults to the cell text.

styled System.Boolean = true optionalposition: 6

Apply hyperlink styling (blue + underline).

Links a column identified by header within a rectangular A1 range to internal sheets. Uses the first row of the range as the header row and links rows r1+1..r2.

Parameters

rangeA1 System.String requiredposition: 0

A1 range (e.g., "A1:D50"). The first row is treated as the header row.

header System.String requiredposition: 1

Header text to match (case-insensitive).

destinationSheetForCellText System.Func{System.String,System.String} = null optionalposition: 2

Maps cell text to destination sheet name (defaults to identity).

targetA1 System.String = "A1" optionalposition: 3

Destination cell on the target sheet (default "A1").

display System.Func{System.String,System.String} = null optionalposition: 4

Optional display selector; defaults to the cell text.

styled System.Boolean = true optionalposition: 5

Apply hyperlink styling (blue + underline).

Links a column within a table to internal sheets. The table range determines the row bounds.

Parameters

tableName System.String requiredposition: 0

Name of the table (as shown in Excel's Name Manager).

header System.String requiredposition: 1

Header text of the column inside the table.

destinationSheetForCellText System.Func{System.String,System.String} = null optionalposition: 2

Maps cell text to a destination sheet name (defaults to identity).

targetA1 System.String = "A1" optionalposition: 3

Destination cell on the target sheet (default "A1").

display System.Func{System.String,System.String} = null optionalposition: 4

Optional display selector; defaults to the cell text.

styled System.Boolean = true optionalposition: 5

Apply hyperlink styling (blue + underline).

Examples

// Internal: link "Domain" column to same-named sheets, rows 2..used bottom sheet.LinkByHeaderToInternalSheets("Domain"); // External: link "RFC" column to IETF datatracker pages sheet.LinkByHeaderToUrls("RFC", urlForCellText: rfc => $"https://datatracker.ietf.org/doc/html/{rfc}");

Links a column identified by header to external URLs built from each cell's text. When the header is missing the operation is skipped.

Parameters

header System.String requiredposition: 0

Header text of the column to process.

rowFrom System.Int32 = 2 optionalposition: 1

First data row (1-based). Defaults to 2 (skip header).

rowTo System.Int32 = -1 optionalposition: 2

Last data row (inclusive). When <= 0, uses the bottom of the used range.

urlForCellText System.Func{System.String,System.String} = null optionalposition: 3

Maps cell text to URL.

titleForCellText System.Func{System.String,System.String} = null optionalposition: 4

Optional display selector; when null, a smart display (RFC/host) is used.

styled System.Boolean = true optionalposition: 5

Apply hyperlink styling (blue + underline).

Links a column identified by header within a rectangular A1 range to external URLs. Uses the first row of the range as the header row and links rows r1+1..r2.

Parameters

rangeA1 System.String requiredposition: 0

A1 range (e.g., "A1:D50"). The first row is treated as the header row.

header System.String requiredposition: 1

Header text to match (case-insensitive).

urlForCellText System.Func{System.String,System.String} requiredposition: 2

Maps cell text to URL.

titleForCellText System.Func{System.String,System.String} = null optionalposition: 3

Optional display selector; when null, a smart display (RFC/host) is used.

styled System.Boolean = true optionalposition: 4

Apply hyperlink styling (blue + underline).

Links a column within a table to external URLs. The table range determines the row bounds.

Parameters

tableName System.String requiredposition: 0

Name of the table.

header System.String requiredposition: 1

Header text of the column inside the table.

urlForCellText System.Func{System.String,System.String} requiredposition: 2

Maps cell text to URL.

titleForCellText System.Func{System.String,System.String} = null optionalposition: 3

Optional display selector; when null, a smart display (RFC/host) is used.

styled System.Boolean = true optionalposition: 4

Apply hyperlink styling (blue + underline).

Converts each non-empty cell in the A1 range into an internal hyperlink. The destination sheet name is computed from the cell's text using destinationSheetForCellText.

Parameters

a1 System.String requiredposition: 0

A1 range to process (e.g., a column of names).

destinationSheetForCellText System.Func{System.String,System.String} requiredposition: 1

Maps the cell text to a destination sheet name.

targetA1 System.String = "A1" optionalposition: 2

Destination cell on the target sheet (default "A1").

display System.Func{System.String,System.String} = null optionalposition: 3

Optional display text selector. Defaults to the cell text.

styled System.Boolean = true optionalposition: 4

When true, applies hyperlink styling (blue + underline).

Examples

sheet.ForEachColumn("A1:E1", c => sheet.CellBold(1, c, true));

Removes empty containers and orphaned references on this worksheet to prevent Excel repairs.

Applies worksheet protection using the provided options.

Parameters

options OfficeIMO.Excel.ExcelSheetProtectionOptions = null optionalposition: 0

Protection options (defaults allow selection of locked/unlocked cells).

Forces rebuilding the header map for the current UsedRange and options.

Parameters

options OfficeIMO.Excel.ExcelReadOptions = null optionalposition: 0

Removes a defined name scoped to this sheet.

Parameters

name System.String requiredposition: 0

Defined name to remove.

save System.Boolean = true optionalposition: 1

When true, saves the workbook after removal.

Returns

True if removed; false if not found.

Replaces all occurrences of oldText with newText in string cells. Returns the number of replacements performed.

Parameters

oldText System.String requiredposition: 0

newText System.String requiredposition: 1

Type Parameters

T

Parameters

a1Range String requiredposition: 0

options ExcelReadOptions = null optionalposition: 1

Maps the specified A1 range to a sequence of T using header-to-property mapping.

Parameters

a1Range System.String required

options OfficeIMO.Excel.ExcelReadOptions required

Sets a cell value in the specified row by resolving the column using the header name. Does nothing when the header cannot be found.

Parameters

rowIndex System.Int32 requiredposition: 0

header System.String requiredposition: 1

value System.Object requiredposition: 2

options OfficeIMO.Excel.ExcelReadOptions = null optionalposition: 3

Obsolete. Use CancellationToken) instead.

Parameters

cells System.Collections.Generic.IEnumerable{System.ValueTuple{System.Int32,System.Int32,System.Object}} requiredposition: 0

mode System.Nullable{OfficeIMO.Excel.ExecutionMode} = null optionalposition: 1

ct System.Threading.CancellationToken = null optionalposition: 2

Hides or shows the specified column.

Parameters

columnIndex System.Int32 requiredposition: 0

1-based column index.

hidden System.Boolean requiredposition: 1

True to hide the column; false to show it.

Sets the width of the specified column.

Parameters

columnIndex System.Int32 requiredposition: 0

1-based column index.

width System.Double requiredposition: 1

The column width.

Adds an image to the worksheet footer at the given position. This will also ensure the footer text contains the picture placeholder (&G) in the corresponding section. Subsequent calls replace any previously set header/footer images for this sheet.

Parameters

position OfficeIMO.Excel.HeaderFooterPosition requiredposition: 0

imageBytes System.Byte[] requiredposition: 1

contentType System.String = "image/png" optionalposition: 2

widthPoints System.Nullable{System.Double} = null optionalposition: 3

heightPoints System.Nullable{System.Double} = null optionalposition: 4

Downloads an image from URL and sets it in the footer at the given position (convenience wrapper).

Parameters

position OfficeIMO.Excel.HeaderFooterPosition requiredposition: 0

url System.String requiredposition: 1

widthPoints System.Nullable{System.Double} = null optionalposition: 2

heightPoints System.Nullable{System.Double} = null optionalposition: 3

Shows or hides gridlines on the current sheet (view-level setting).

Parameters

visible System.Boolean requiredposition: 0

Sets the header and/or footer text for this worksheet.

Parameters

headerLeft System.String = null optionalposition: 0

Left header text (optional).

headerCenter System.String = null optionalposition: 1

Center header text (optional).

headerRight System.String = null optionalposition: 2

Right header text (optional).

footerLeft System.String = null optionalposition: 3

Left footer text (optional).

footerCenter System.String = null optionalposition: 4

Center footer text (optional).

footerRight System.String = null optionalposition: 5

Right footer text (optional).

differentFirstPage System.Boolean = false optionalposition: 6

Use a different header/footer on the first page.

differentOddEven System.Boolean = false optionalposition: 7

Use different headers/footers for odd and even pages.

alignWithMargins System.Boolean = true optionalposition: 8

Align header/footer with page margins.

scaleWithDoc System.Boolean = true optionalposition: 9

Scale header/footer with document scaling.

Adds an image to the worksheet header at the given position. This will also ensure the header text contains the picture placeholder (&G) in the corresponding section. Subsequent calls replace any previously set header/footer images for this sheet.

Parameters

position OfficeIMO.Excel.HeaderFooterPosition requiredposition: 0

Left, Center, or Right header section.

imageBytes System.Byte[] requiredposition: 1

Image bytes.

contentType System.String = "image/png" optionalposition: 2

e.g. image/png, image/jpeg. Defaults to image/png.

widthPoints System.Nullable{System.Double} = null optionalposition: 3

Optional width in points. If omitted, inferred from image size at 96 DPI.

heightPoints System.Nullable{System.Double} = null optionalposition: 4

Optional height in points. If omitted, inferred proportionally.

Downloads an image from URL and sets it in the header at the given position (convenience wrapper).

Parameters

position OfficeIMO.Excel.HeaderFooterPosition requiredposition: 0

url System.String requiredposition: 1

widthPoints System.Nullable{System.Double} = null optionalposition: 2

heightPoints System.Nullable{System.Double} = null optionalposition: 3

Hides or shows the worksheet in the workbook.

Parameters

hidden System.Boolean requiredposition: 0

Creates an external hyperlink showing only the host (e.g., example.org) as display text.

Parameters

row System.Int32 requiredposition: 0

1-based row index.

column System.Int32 requiredposition: 1

1-based column index.

url System.String requiredposition: 2

Target URL.

style System.Boolean = true optionalposition: 3

When true, applies hyperlink styling (blue + underline).

Examples

sheet.SetHyperlinkSmart(5, 1, "https://datatracker.ietf.org/doc/html/rfc7208"); // displays "RFC 7208" sheet.SetHyperlinkSmart(6, 1, "https://example.org/path", title: "Spec"); // displays "Spec"

Creates an external hyperlink using a smart display strategy: prefer title, then an RFC label (e.g., "RFC 7208") when detected, otherwise the URL host.

Parameters

row System.Int32 requiredposition: 0

1-based row index.

column System.Int32 requiredposition: 1

1-based column index.

url System.String requiredposition: 2

Target URL.

title System.String = null optionalposition: 3

Optional preferred display text.

style System.Boolean = true optionalposition: 4

When true, applies hyperlink styling (blue + underline).

Examples

// Given a summary table where column A contains sheet names, link each cell to its sheet sheet.LinkCellsToInternalSheets("A2:A51", text => text, targetA1: "A1", styled: true);

Sets page margins in inches.

Parameters

left System.Double requiredposition: 0

right System.Double requiredposition: 1

top System.Double requiredposition: 2

bottom System.Double requiredposition: 3

header System.Double = 0.3 optionalposition: 4

footer System.Double = 0.3 optionalposition: 5

Applies a preset set of margins.

Parameters

preset OfficeIMO.Excel.ExcelMarginPreset requiredposition: 0

Sets page orientation (Portrait or Landscape) on the sheet's PageSetup.

Parameters

orientation OfficeIMO.Excel.ExcelPageOrientation requiredposition: 0

Configures basic print/page setup for the sheet.

Parameters

fitToWidth System.Nullable{System.UInt32} = null optionalposition: 0

Number of pages to fit horizontally (1 = fit to one page).

fitToHeight System.Nullable{System.UInt32} = null optionalposition: 1

Number of pages to fit vertically (0 = unlimited).

scale System.Nullable{System.UInt32} = null optionalposition: 2

Manual scale (10-400). Ignored if FitToWidth/Height are specified.

Enables a totals row for the table covering range and assigns per-column functions by header name. Supported functions are those in TotalsRowFunctionValues (Sum, Average, Count, Min, Max, etc.).

Parameters

range System.String requiredposition: 0

Address of the table range (for example, "A1:D10") whose totals row should be displayed.

byHeader System.Collections.Generic.Dictionary{System.String,DocumentFormat.OpenXml.Spreadsheet.TotalsRowFunctionValues} requiredposition: 1

Mapping of table header names to the totals function that should be applied for each column.

Sorts the sheet's UsedRange rows in-place (excluding header) by the column resolved via header. Values-only: rewrites cell values; formulas and styles are not preserved. When the header cannot be resolved the sort is skipped.

Parameters

header System.String requiredposition: 0

ascending System.Boolean = true optionalposition: 1

Sorts the sheet's UsedRange rows in-place by multiple headers in the given order (excluding header row). Values-only: rewrites cell values; formulas and styles are not preserved. Missing headers are ignored and when no valid headers remain the sort is skipped.

Parameters

keys System.ValueTuple{System.String,System.Boolean}[] requiredposition: 0

Tries to read the display text of a cell at the given position. Returns false if the cell is blank or out of bounds.

Parameters

row System.Int32 requiredposition: 0

The 1-based row index of the cell to inspect.

column System.Int32 requiredposition: 1

The 1-based column index of the cell to inspect.

text System.String@ requiredposition: 2

When this method returns, contains the extracted cell text if successful; otherwise, an empty string.

Returns

true if text was read successfully; otherwise, false.

Tries to resolve a 1-based column index for a given header. Returns false without throwing when the header cannot be found.

Parameters

header System.String requiredposition: 0

columnIndex System.Int32@ requiredposition: 1

options OfficeIMO.Excel.ExcelReadOptions = null optionalposition: 2

Non-throwing variant of Boolean). Returns false when the header cannot be found or inputs are invalid.

Parameters

header System.String requiredposition: 0

rowFrom System.Int32 = 2 optionalposition: 1

rowTo System.Int32 = -1 optionalposition: 2

destinationSheetForCellText System.Func{System.String,System.String} = null optionalposition: 3

targetA1 System.String = "A1" optionalposition: 4

display System.Func{System.String,System.String} = null optionalposition: 5

styled System.Boolean = true optionalposition: 6

Non-throwing variant of Boolean). Returns false when the range cannot be parsed or the header is missing.

Parameters

rangeA1 System.String requiredposition: 0

header System.String requiredposition: 1

targetA1 System.String = "A1" optionalposition: 2

destinationSheetForCellText System.Func{System.String,System.String} = null optionalposition: 3

display System.Func{System.String,System.String} = null optionalposition: 4

styled System.Boolean = true optionalposition: 5

Non-throwing variant of Boolean). Returns false when the table or header cannot be found.

Parameters

tableName System.String requiredposition: 0

header System.String requiredposition: 1

destinationSheetForCellText System.Func{System.String,System.String} = null optionalposition: 2

targetA1 System.String = "A1" optionalposition: 3

display System.Func{System.String,System.String} = null optionalposition: 4

styled System.Boolean = true optionalposition: 5

Non-throwing variant of Boolean). Returns false when the header cannot be found or inputs are invalid.

Parameters

header System.String requiredposition: 0

rowFrom System.Int32 = 2 optionalposition: 1

rowTo System.Int32 = -1 optionalposition: 2

urlForCellText System.Func{System.String,System.String} = null optionalposition: 3

titleForCellText System.Func{System.String,System.String} = null optionalposition: 4

styled System.Boolean = true optionalposition: 5

Non-throwing variant of Boolean). Returns false when the range cannot be parsed or the header is missing.

Parameters

rangeA1 System.String requiredposition: 0

header System.String requiredposition: 1

urlForCellText System.Func{System.String,System.String} requiredposition: 2

titleForCellText System.Func{System.String,System.String} = null optionalposition: 3

styled System.Boolean = true optionalposition: 4

Non-throwing variant of Boolean). Returns false when the table or header cannot be found.

Parameters

tableName System.String requiredposition: 0

header System.String requiredposition: 1

urlForCellText System.Func{System.String,System.String} requiredposition: 2

titleForCellText System.Func{System.String,System.String} = null optionalposition: 3

styled System.Boolean = true optionalposition: 4

Removes worksheet protection.

Updates the SheetDimension element to reflect the current used range. Helps avoid rare "dimension" repair messages in Excel when generating sheets programmatically.

Applies a custom formula validation to the specified A1 range.

Parameters

a1Range System.String requiredposition: 0

formula System.String requiredposition: 1

allowBlank System.Boolean = true optionalposition: 2

errorTitle System.String = null optionalposition: 3

errorMessage System.String = null optionalposition: 4

Applies a date validation to the specified A1 range.

Parameters

a1Range System.String requiredposition: 0

operator DocumentFormat.OpenXml.Spreadsheet.DataValidationOperatorValues requiredposition: 1

formula1 System.DateTime requiredposition: 2

formula2 System.Nullable{System.DateTime} = null optionalposition: 3

allowBlank System.Boolean = true optionalposition: 4

errorTitle System.String = null optionalposition: 5

errorMessage System.String = null optionalposition: 6

Applies a decimal number validation to the specified A1 range.

Parameters

a1Range System.String requiredposition: 0

operator DocumentFormat.OpenXml.Spreadsheet.DataValidationOperatorValues requiredposition: 1

formula1 System.Double requiredposition: 2

formula2 System.Nullable{System.Double} = null optionalposition: 3

allowBlank System.Boolean = true optionalposition: 4

errorTitle System.String = null optionalposition: 5

errorMessage System.String = null optionalposition: 6

Applies a list validation to the specified A1 range using explicit items.

Parameters

a1Range System.String requiredposition: 0

items System.Collections.Generic.IEnumerable{System.String} requiredposition: 1

allowBlank System.Boolean = true optionalposition: 2

Applies a list validation to the specified A1 range using a workbook or sheet-local named range.

Parameters

a1Range System.String requiredposition: 0

namedRange System.String requiredposition: 1

allowBlank System.Boolean = true optionalposition: 2

Applies a list validation to the specified A1 range using a referenced worksheet range. When sourceSheetName is omitted, the current worksheet is used.

Parameters

a1Range System.String requiredposition: 0

sourceA1Range System.String requiredposition: 1

sourceSheetName System.String = null optionalposition: 2

allowBlank System.Boolean = true optionalposition: 3

Applies a text length validation to the specified A1 range.

Parameters

a1Range System.String requiredposition: 0

operator DocumentFormat.OpenXml.Spreadsheet.DataValidationOperatorValues requiredposition: 1

formula1 System.Int32 requiredposition: 2

formula2 System.Nullable{System.Int32} = null optionalposition: 3

allowBlank System.Boolean = true optionalposition: 4

errorTitle System.String = null optionalposition: 5

errorMessage System.String = null optionalposition: 6

Applies a time validation to the specified A1 range.

Parameters

a1Range System.String requiredposition: 0

operator DocumentFormat.OpenXml.Spreadsheet.DataValidationOperatorValues requiredposition: 1

formula1 System.TimeSpan requiredposition: 2

formula2 System.Nullable{System.TimeSpan} = null optionalposition: 3

allowBlank System.Boolean = true optionalposition: 4

errorTitle System.String = null optionalposition: 5

errorMessage System.String = null optionalposition: 6

Applies a whole number validation to the specified A1 range.

Parameters

a1Range System.String requiredposition: 0

operator DocumentFormat.OpenXml.Spreadsheet.DataValidationOperatorValues requiredposition: 1

formula1 System.Int32 requiredposition: 2

formula2 System.Nullable{System.Int32} = null optionalposition: 3

allowBlank System.Boolean = true optionalposition: 4

errorTitle System.String = null optionalposition: 5

errorMessage System.String = null optionalposition: 6

Writes chart data into the worksheet and returns the corresponding data range.

Parameters

data OfficeIMO.Excel.ExcelChartData requiredposition: 0

startRow System.Int32 = 1 optionalposition: 1

startColumn System.Int32 = 1 optionalposition: 2

categoryHeader System.String = null optionalposition: 3

includeHeaderRow System.Boolean = true optionalposition: 4

numericCategories System.Boolean = false optionalposition: 5

Enumerates charts on the worksheet.

Gets or sets the worksheet name.

Override execution policy for this sheet. Null = inherit from document.

Gets the effective execution policy for this sheet.

Gets whether the worksheet is protected.

Returns the used range A1 address for this sheet. Alias property for API ergonomics.