ExcelSheet

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

Parameters

seriesRanges System.Collections.Generic.IEnumerable<OfficeIMO.Excel.ExcelChartSeriesRange> required

row int required

column int required

width OfficeIMO.OfficeLength? = null optional

height OfficeIMO.OfficeLength? = null optional

title string? = null optional

Adds an editable chart of any type whose series reference their own worksheet ranges, which need not be adjacent.

Parameters

type OfficeIMO.OfficeChartType required

series System.Collections.Generic.IEnumerable<OfficeIMO.Excel.ExcelChartSeriesRange> required

options OfficeIMO.OfficeChartOptions? = null optional

Adds a rule from the format-neutral conditional-formatting model.

Parameters

definition OfficeIMO.Excel.ExcelConditionalFormattingInfo required

Adds a centered funnel-compatible stacked bar chart from category values.

Parameters

categories System.Collections.Generic.IEnumerable<string> required

values System.Collections.Generic.IEnumerable<double> required

row int required

column int required

title string = "Funnel" optional

sortDescending bool = true optional

width OfficeIMO.OfficeLength? = null optional

height OfficeIMO.OfficeLength? = null optional

Adds a histogram-compatible column chart after calculating bins from raw numeric observations.

Parameters

values System.Collections.Generic.IEnumerable<double> required

row int required

column int required

title string = "Histogram" optional

binCount int? = null optional

binWidth double? = null optional

width OfficeIMO.OfficeLength? = null optional

height OfficeIMO.OfficeLength? = null optional

Adds ignored-error metadata for one or more regions.

Parameters

ranges System.Collections.Generic.IEnumerable<string> required

errors OfficeIMO.Excel.ExcelIgnoredErrorKind required

Adds a manual worksheet column page break after the specified one-based column.

Parameters

column int required

save bool = true optional

Adds a manual worksheet row page break after the specified one-based row.

Parameters

row int required

save bool = true optional

Adds a native ChartEx chart backed by OfficeIMO's shared hidden chart-data owner.

Parameters

data OfficeIMO.Excel.ExcelChartData required

row int required

column int required

chartType OfficeIMO.Excel.ExcelModernChartType required

title string? = null optional

width OfficeIMO.OfficeLength? = null optional

height OfficeIMO.OfficeLength? = null optional

Adds a Pareto-compatible column and cumulative-percentage line chart.

Parameters

categories System.Collections.Generic.IEnumerable<string> required

values System.Collections.Generic.IEnumerable<double> required

row int required

column int required

title string = "Pareto" optional

width OfficeIMO.OfficeLength? = null optional

height OfficeIMO.OfficeLength? = null optional

Adds a chart using an A1 range and marks it as sourced from an existing pivot table.

Parameters

pivotTableName string required

dataRangeA1 string required

row int required

column int required

width OfficeIMO.OfficeLength? = null optional

height OfficeIMO.OfficeLength? = null optional

type OfficeIMO.OfficeChartType = Column optional

hasHeaders bool = true optional

title string? = null optional

includeCachedData bool = true optional

formatId uint = 0 optional

Adds a derived manual text grouping field and hides selected group labels.

Parameters

pivotTableName string required

sourceFieldName string required

groupFieldName string required

groups System.Collections.Generic.IReadOnlyDictionary<string, string[]> required

hiddenGroupItems System.Collections.Generic.IReadOnlyCollection<string>? = null optional

Adds a scatter chart using explicit X/Y ranges.

Parameters

seriesRanges System.Collections.Generic.IEnumerable<OfficeIMO.Excel.ExcelChartSeriesRange> required

row int required

column int required

width OfficeIMO.OfficeLength? = null optional

height OfficeIMO.OfficeLength? = null optional

title string? = null optional

Adds comments and replies as one prevalidated batch, indexing workbook identities and saving each part once. Replies must refer to an existing root or an earlier root in the batch, on this worksheet and cell.

Parameters

options System.Collections.Generic.IEnumerable<OfficeIMO.Excel.ExcelThreadedCommentOptions> required

Comment options, captured before package mutation.

Adds a waterfall-compatible stacked column chart from signed changes and an optional final total.

Parameters

categories System.Collections.Generic.IEnumerable<string> required

changes System.Collections.Generic.IEnumerable<double> required

row int required

column int required

title string = "Waterfall" optional

includeTotal bool = true optional

totalLabel string = "Total" optional

width OfficeIMO.OfficeLength? = null optional

height OfficeIMO.OfficeLength? = null optional

Appends rows from a DataTable to an existing Excel table and expands the table range.

Parameters

dataTable System.Data.DataTable required

Source DataTable containing rows to append.

tableName string required

Existing table name or display name.

matchColumnsByHeader bool = true optional

When true, DataTable columns are matched to table columns by header text. When false, columns are appended by position.

mode OfficeIMO.Excel.ExcelExecutionMode? = null optional

Optional execution mode override.

ct System.Threading.CancellationToken = default optional

Cancellation token.

Exceptions

• ArgumentNullException – Thrown when dataTable or tableName is null.
• ArgumentException – Thrown when the source columns cannot be mapped to the existing table.
• InvalidOperationException – Thrown when the table cannot be found or cannot be safely expanded.

Applies reusable header-based column number formats to the worksheet.

Parameters

plan OfficeIMO.Excel.ExcelColumnFormatPlan required

Column format plan to apply.

includeHeader bool = false optional

True to include header cells in every rule unless a rule already includes them.

autoFit bool = false optional

True to auto-fit every resolved formatted column.

headerRow int? = null optional

Optional one-based row containing the headers used to resolve column names.

options OfficeIMO.Excel.ExcelReaderOptions? = null optional

Read options used while resolving headers.

Applies a workbook named style to a range with cancellation and a hard cell budget.

Parameters

name string required

range string required

maximumCells int = 1000000 optional

cancellationToken System.Threading.CancellationToken = default optional

Repeats a single template row for each supplied row value dictionary, inserting additional worksheet rows as needed.

Parameters

templateRow int required

1-based row number containing template markers.

rows System.Collections.Generic.IEnumerable<System.Collections.Generic.IDictionary<string, object?>> required

Row value dictionaries. Each dictionary is bound to one copied row.

options OfficeIMO.Excel.ExcelTemplateOptions? = null optional

Optional template binding options.

Repeats a single template row for each supplied row model, inserting additional worksheet rows as needed. Public properties are exposed as marker names, including nested dotted names.

Type Parameters

T

Parameters

templateRow int required

1-based row number containing template markers.

rows System.Collections.Generic.IEnumerable<T> required

Row models. Each model is bound to one copied row.

options OfficeIMO.Excel.ExcelTemplateOptions? = null optional

Optional template binding options.

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

Parameters

columnIndex int required

1-based column index.

Automatically fits all columns based on their content.

Parameters

mode OfficeIMO.Excel.ExcelExecutionMode? = null optional

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

ct System.Threading.CancellationToken = default optional

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<int> required

1-based column indexes that should not be resized.

mode OfficeIMO.Excel.ExcelExecutionMode? = null optional

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

ct System.Threading.CancellationToken = default optional

Cancels the auto-fit pass before it completes.

Automatically fits the supplied set of column indexes.

Parameters

columnIndexes System.Collections.Generic.IEnumerable<int> required

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

mode OfficeIMO.Excel.ExcelExecutionMode? = null optional

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

ct System.Threading.CancellationToken = default optional

Cancels the auto-fit pass for the selected columns.

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

Parameters

rowIndex int required

1-based row index.

Automatically fits all rows based on their content.

Parameters

mode OfficeIMO.Excel.ExcelExecutionMode? = null optional

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

ct System.Threading.CancellationToken = default optional

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

Executes multiple worksheet mutations under a single workbook write lock. Cell styling inside the batch (bold, fills, fonts, wrapping, number formats and similar) looks formats up through an index and saves the stylesheet once when the batch ends, so styling cells row by row stays proportional to the cells styled.

Parameters

action System.Action<OfficeIMO.Excel.ExcelSheet> required

The worksheet updates to execute.

Creates a sequential chart layout helper for dashboard-style worksheets that use the default Excel row and column grid.

Parameters

row int required

One-based worksheet row for the first chart.

column int required

One-based worksheet column for the first chart.

width OfficeIMO.OfficeLength? = null optional

Default chart physical width.

height OfficeIMO.OfficeLength? = null optional

Default chart physical height.

chartsPerRow int = 2 optional

Number of charts to place before wrapping to the next row.

horizontalGap OfficeIMO.OfficeLength? = null optional

Minimum horizontal physical gap between chart slots, calculated against default-width Excel columns.

verticalGapRows int = 2 optional

Minimum vertical gap between chart rows, in worksheet rows, calculated against default-height Excel rows.

Clears an array formula whose reference overlaps the supplied range or cell.

Parameters

a1RangeOrCell string required

Removes cached values from formula cells on this sheet.

Clears Excel outline grouping metadata from a contiguous range of worksheet columns.

Parameters

startColumn int required

First 1-based column to clear.

endColumn int required

Last 1-based column to clear.

unhide bool = true optional

Whether hidden columns in the cleared range should be shown.

Removes comments that match the supplied filter.

Parameters

filter OfficeIMO.Excel.ExcelCommentFilter required

Author, text, and/or A1 range filter used to choose comments.

Clears conditional formatting rules, optionally restricted to a range.

Parameters

a1Range string? = null optional

Clears the cached header map.

Clears all standard ignored-error regions.

Clears all manual worksheet column page breaks.

Parameters

save bool = true optional

Clears all manual worksheet row and column page breaks.

Parameters

save bool = true optional

Clears all manual worksheet row page breaks.

Parameters

save bool = true optional

Clears Excel outline grouping metadata from a contiguous range of worksheet rows.

Parameters

startRow int required

First 1-based row to clear.

endRow int required

Last 1-based row to clear.

unhide bool = true optional

Whether hidden rows in the cleared range should be shown.

Removes all worksheet sparkline groups.

Clears the worksheet tab color.

Clears totals-row settings for the table identified by range, name, or display name.

Parameters

tableOrRange string required

Table range, name, or display name.

Clones a rule, including unrecognized attributes and child markup, to another range.

Parameters

rule OfficeIMO.Excel.ExcelConditionalFormattingInfo required

targetRange string required

priority int? = null optional

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 string required

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

includeHeader bool = false optional

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

options OfficeIMO.Excel.ExcelReaderOptions? = null optional

Read options that control header normalization and other resolution behavior.

Creates a forward-only data reader over this worksheet in the current open workbook, including unsaved edits.

Parameters

options OfficeIMO.Excel.ExcelReaderOptions? = null optional

Creates a format-neutral visual snapshot for a worksheet range or the used range.

Parameters

options OfficeIMO.Excel.ExcelImageExportOptions? = null optional

Creates or replaces a workbook named style from a cell's current formatting.

Parameters

name string required

sourceRow int required

sourceColumn int required

hidden bool = false optional

Transactionally deletes cells.

Parameters

range string required

direction OfficeIMO.Excel.ExcelCellShiftDirection required

options OfficeIMO.Excel.ExcelMutationPlanOptions? = null optional

cancellationToken System.Threading.CancellationToken = default optional

Deletes worksheet columns starting at firstColumn and shifts following columns left. Formula references to cells fully removed by the operation become #REF!; partially overlapping ranges are reduced to the surviving cells. Use ExcelSheet.DeleteColumnsTransactional for rollback and post-edit diagnostics.

Parameters

firstColumn int required

count int = 1 optional

Exceptions

• ArgumentOutOfRangeException – The requested columns fall outside the worksheet column limit.
• InvalidOperationException – The deletion would remove every column of a table, or intersect an array formula, data table or PivotTable output range, or the worksheet contains unsupported controls.

Plans and transactionally deletes columns with bounded rollback and post-edit diagnostics.

Parameters

firstColumn int required

count int = 1 optional

options OfficeIMO.Excel.ExcelMutationPlanOptions? = null optional

cancellationToken System.Threading.CancellationToken = default optional

Deletes worksheet rows starting at firstRow and shifts following rows up. Formula references to cells fully removed by the operation become #REF!; partially overlapping ranges are reduced to the surviving cells.

Parameters

firstRow int required

The 1-based first row to delete.

count int = 1 optional

The number of rows to delete.

Exceptions

• ArgumentOutOfRangeException – Thrown when the requested rows fall outside the worksheet row limit.
• InvalidOperationException – Thrown when the deletion would remove an owned table boundary or intersect an array-formula, data-table, or PivotTable output range that cannot be rebuilt safely, when the workbook uses R1C1 reference mode, or when the worksheet contains unsupported form controls, OLE objects, or single-cell XML mappings.

Plans and transactionally deletes rows with bounded rollback and post-edit diagnostics.

Parameters

firstRow int required

count int = 1 optional

options OfficeIMO.Excel.ExcelMutationPlanOptions? = null optional

cancellationToken System.Threading.CancellationToken = default optional

Releases resources held by this worksheet.

Streams the non-empty cells in this worksheet without probing every coordinate in its used range. Enumerate the returned sequence while the owning ExcelDocument is still open.

Parameters

options OfficeIMO.Excel.ExcelReaderOptions? = null optional

Optional read options.

cancellationToken System.Threading.CancellationToken = default optional

Cancellation token observed during enumeration.

Streams the non-empty cells in the specified A1 range without probing every coordinate in the range. Enumerate the returned sequence while the owning ExcelDocument is still open.

Parameters

a1Range string required

Inclusive A1 range (for example, "A1:C100").

options OfficeIMO.Excel.ExcelReaderOptions? = null optional

Optional read options.

cancellationToken System.Threading.CancellationToken = default optional

Cancellation token observed during enumeration.

Finds legacy worksheet comments (notes) that match the supplied filter.

Parameters

filter OfficeIMO.Excel.ExcelCommentFilter? required

Optional author, text, and A1 range filter.

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 string required

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

Parameters

a1 string required

A1 range without a sheet prefix.

action System.Action<int> required

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 string required

A1 range without a sheet prefix.

action System.Action<int> required

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

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

Lists allowed-edit regions without exposing Open XML types.

Reads worksheet and table AutoFilter criteria/state.

Reads the native value metadata of one column for a range of rows in a single pass.

Parameters

column int required

The 1-based column index to read.

firstRow int required

The 1-based first row to read.

lastRow int required

The 1-based last row to read.

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

Parameters

name string required

Resolves the data range for a worksheet or table column by matching its header text.

Parameters

headerName string required

Header or table column name to match.

tableName string? = null optional

Optional table name, display name, or range. When omitted, the worksheet header row is scanned.

headerRow int = 0 optional

Worksheet header row to scan when tableName is omitted. Use 0 to scan the first row of the used range.

includeHeader bool = false optional

Include the matched header cell in the returned range.

normalizeHeader bool = true optional

Normalize repeated whitespace before comparing headers.

Gets all legacy worksheet comments (notes) on this sheet.

Lists conditional formatting rules on the worksheet.

Parameters

a1Range string? = null optional

Lists data validation rules on the worksheet.

Parameters

a1Range string? = null optional

Returns formula cells on this sheet without changing workbook contents.

Returns the formula text from a cell, if present.

Parameters

row int required

column int required

Builds or returns a cached case-insensitive map of header name to 1-based column index using the first row of UsedRange. Cache reuse respects the used range, header conversion options and named-style replacements.

Parameters

options OfficeIMO.Excel.ExcelReaderOptions? = null optional

Gets worksheet hyperlinks keyed by their A1 cell or range reference.

Lists standard ignored-error regions without exposing Open XML types.

Returns an image by non-visual drawing name, or null if it was not found.

Parameters

name string required

Reads native in-cell images with a deterministic aggregate payload budget.

Parameters

maximumTotalImageBytes long = 64000000 optional

Gets one-based worksheet columns that have a manual page break after them.

Gets one-based worksheet rows that have a manual page break after them.

Returns a native or imported ChartEx drawing by non-visual name.

Parameters

name string required

Gets the range a defined name refers to, preferring a name local to this sheet over a workbook name.

Parameters

name string required

Defined name to resolve.

Reads a value from a saved pivot view, without refreshing its source or cache. Supports saved hierarchies, qualified date, numeric and manual text groups, default subtotals, collapsed groups and multiple measures. Unknown fields, items, measures or pivots return a typed #REF! error.

Parameters

pivotTableName string required

Saved pivot definition on this worksheet.

dataField string required

Measure caption or unique source field name.

items System.Collections.Generic.IReadOnlyDictionary<string, object?>? = null optional

Field criteria. Dates accept DateTime or workbook serials; error items use an ExcelCellData error, distinct from text with the same spelling.

Exceptions

• NotSupportedException – The view has no materialized items or uses an unsupported layout or exceeds lookup limits.

Resolves the output range for a pivot table on this worksheet.

Parameters

pivotTableName string required

target OfficeIMO.Excel.ExcelPivotRangeTarget = WholeTable optional

Returns pivot tables defined on this worksheet.

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

Parameters

a1 string required

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

Exceptions

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

Returns the authored dimensions of an A1 range using current column widths, row heights and hidden cells.

Parameters

range string required

Gets explicit worksheet row definitions such as custom heights and hidden rows.

Lists authored worksheet sparklines in package order.

Gets the A1 range covered by a table on this worksheet.

Parameters

tableName string required

Table name or display name.

Returns the named Excel table definitions owned by this worksheet. Ordinary cell grids are not named tables. Metadata is read through the same locked snapshot owner as ExcelDocument.GetTables.

Exceptions

• InvalidOperationException – The worksheet was removed or no longer belongs to the current workbook package.

Gets a threaded comment or reply by id, or null when it is not present on this worksheet.

Parameters

id string required

Gets all threaded comments and replies on this worksheet.

Groups a contiguous range of worksheet columns by applying an Excel outline level.

Parameters

startColumn int required

First 1-based column in the group.

endColumn int required

Last 1-based column in the group.

outlineLevel byte = 1 optional

Excel outline level from 1 through 7.

collapsed bool = false optional

Whether to hide the grouped columns and mark the summary column as collapsed.

hidden bool = false optional

Whether to hide the grouped columns without marking the group as collapsed.

Groups a contiguous range of worksheet rows by applying an Excel outline level.

Parameters

startRow int required

First 1-based row in the group.

endRow int required

Last 1-based row in the group.

outlineLevel byte = 1 optional

Excel outline level from 1 through 7.

collapsed bool = false optional

Whether to hide the grouped rows and mark the summary row as collapsed.

hidden bool = false optional

Whether to hide the grouped rows without marking the group as collapsed.

Returns true when a comment exists for the specified cell.

Parameters

row int required

1-based row index.

column int required

1-based column index.

Transactionally inserts cells.

Parameters

range string required

direction OfficeIMO.Excel.ExcelCellShiftDirection required

options OfficeIMO.Excel.ExcelMutationPlanOptions? = null optional

cancellationToken System.Threading.CancellationToken = default optional

Inserts blank worksheet columns immediately before firstColumn and shifts existing columns right. Formulas, defined names, tables, merges, comments, hyperlinks, validations, conditional formatting, drawings, page breaks and connection parameters are adjusted where supported. Use ExcelSheet.InsertColumnsTransactional for rollback and post-edit diagnostics.

Parameters

firstColumn int required

count int = 1 optional

Exceptions

• ArgumentOutOfRangeException – The requested columns fall outside the worksheet column limit.
• InvalidOperationException – Content or a dependent reference would exceed the column limit, or the insertion would split an array formula, data table or PivotTable output range, or the worksheet contains unsupported controls.

Plans and transactionally inserts columns with bounded rollback and post-edit diagnostics.

Parameters

firstColumn int required

count int = 1 optional

options OfficeIMO.Excel.ExcelMutationPlanOptions? = null optional

cancellationToken System.Threading.CancellationToken = default optional

Streams rows from an IDataReader (including provider-owned DbDataReader implementations) into the worksheet and optionally creates an Excel table. The caller owns the connection, command, query, and provider. Null and DBNull values remain blank cells; an empty string remains text.

Parameters

reader System.Data.IDataReader required

Open data reader positioned before the first row.

startRow int = 1 optional

1-based start row.

startColumn int = 1 optional

1-based start column.

includeHeaders bool = true optional

Write field names as the first row.

tableName string? = null optional

Optional Excel table name.

style OfficeIMO.Excel.ExcelTableStyle = TableStyleMedium2 optional

Excel table style to use when createTable is true.

includeAutoFilter bool = true optional

Include table AutoFilter dropdowns when creating a table.

createTable bool = true optional

Create an Excel table over the imported range.

autoFit bool = false optional

Auto-fit imported columns after rows are written.

ct System.Threading.CancellationToken = default optional

Cancellation token.

Streams rows from an IDataReader into the worksheet and returns the occupied range, actual table name, and imported dimensions.

Parameters

reader System.Data.IDataReader required

Open data reader positioned before the first row.

startRow int = 1 optional

1-based start row.

startColumn int = 1 optional

1-based start column.

includeHeaders bool = true optional

Write field names as the first row.

tableName string? = null optional

Optional Excel table name.

style OfficeIMO.Excel.ExcelTableStyle = TableStyleMedium2 optional

Excel table style to use when createTable is true.

includeAutoFilter bool = true optional

Include table AutoFilter dropdowns when creating a table.

createTable bool = true optional

Create an Excel table over the imported range.

autoFit bool = false optional

Auto-fit imported columns after rows are written.

ct System.Threading.CancellationToken = default optional

Cancellation token.

Inserts blank worksheet rows immediately before firstRow and shifts existing rows down. Formulas, defined names, tables, merges, comments, hyperlinks, validations, conditional formatting, sparklines, drawings, and chart references owned by the workbook are adjusted where supported.

Parameters

firstRow int required

The 1-based row before which new rows are inserted.

count int = 1 optional

The number of rows to insert.

Exceptions

• ArgumentOutOfRangeException – Thrown when the requested rows fall outside the worksheet row limit.
• InvalidOperationException – Thrown when content or a dependent reference would exceed the worksheet row limit, or when the insertion would split an array formula, data-table, or PivotTable output range, when the workbook uses R1C1 reference mode, or when the worksheet contains unsupported form controls, OLE objects, or single-cell XML mappings.

Plans and transactionally inserts rows with bounded rollback and post-edit diagnostics.

Parameters

firstRow int required

count int = 1 optional

options OfficeIMO.Excel.ExcelMutationPlanOptions? = null optional

cancellationToken System.Threading.CancellationToken = default optional

Inspects formula cells on this sheet without changing workbook contents.

Marks all formula cells on this sheet dirty.

Determines whether an image content type can be stored in an Excel image part.

Parameters

contentType string? required

The MIME content type to inspect.

Turns each non-empty cell under a header into a link to a worksheet or URL built from the cell text.

Parameters

header string required

Header text of the column to link (case-insensitive).

target OfficeIMO.Excel.ExcelLinkTarget required

Where each cell points: ExcelLinkTarget.Sheet or ExcelLinkTarget.Url.

options OfficeIMO.Excel.ExcelLinkByHeaderOptions? = null optional

Optional range or table scope, row bounds, display text and styling.

Examples

sheet.LinkByHeader("Domain", ExcelLinkTarget.Sheet()); sheet.LinkByHeader("RFC", ExcelLinkTarget.Url(rfc => $"https://datatracker.ietf.org/doc/html/{rfc}"), new ExcelLinkByHeaderOptions { Table = "Summary" });

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 string required

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

destinationSheetForCellText System.Func<string, string> required

Maps the cell text to a destination sheet name.

targetA1 string = "A1" optional

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

display System.Func<string, string>? = null optional

Optional display text selector. Defaults to the cell text.

styled bool = true optional

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

Examples

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

Generates saved pivot views and their shared source cache from current worksheet values. Supports up to 256 measures and fields across ordinary, numeric-range, derived date and manual text group axes, selected page items, hidden row, column, or page items, deterministic first-seen key order, and optional grand totals. Source formulas use their saved typed caches.

Parameters

pivotTableName string required

Pivot definition on this worksheet.

options OfficeIMO.Excel.ExcelMutationPlanOptions? = null optional

Source, measure-input, output and rollback limits. Each cell/work budget uses MaximumAffectedCells, capped at one million.

cancellationToken System.Threading.CancellationToken = default optional

Cancels preparation or rolls back an interrupted write.

referenceDate System.DateTime? = null optional

Local calendar date used for relative date filters. Defaults to today's date, captured once for all shared-cache views.

Exceptions

• NotSupportedException – A cache view uses an unqualified grouping, filter, calculated field, measure layout, or incompatible cache representation.
• InvalidOperationException – A budget or destination collision prevents generation.

Plans a formula-aware cell-range copy.

Parameters

sourceRange string required

destinationTopLeft string required

options OfficeIMO.Excel.ExcelMutationPlanOptions? = null optional

Plans deletion of a rectangular cell block.

Parameters

range string required

direction OfficeIMO.Excel.ExcelCellShiftDirection required

options OfficeIMO.Excel.ExcelMutationPlanOptions? = null optional

Builds a bounded dry-run plan for deleting complete worksheet columns.

Parameters

firstColumn int required

count int = 1 optional

options OfficeIMO.Excel.ExcelMutationPlanOptions? = null optional

Validates and describes a deletion without changing the workbook.

Parameters

firstRow int required

count int = 1 optional

options OfficeIMO.Excel.ExcelMutationPlanOptions? = null optional

Plans insertion of a rectangular cell block.

Parameters

range string required

direction OfficeIMO.Excel.ExcelCellShiftDirection required

options OfficeIMO.Excel.ExcelMutationPlanOptions? = null optional

Builds a bounded dry-run plan for inserting complete worksheet columns.

Parameters

firstColumn int required

count int = 1 optional

options OfficeIMO.Excel.ExcelMutationPlanOptions? = null optional

Validates and describes an insertion without changing the workbook.

Parameters

firstRow int required

count int = 1 optional

options OfficeIMO.Excel.ExcelMutationPlanOptions? = null optional

Plans a formula-aware cell-range move.

Parameters

sourceRange string required

destinationTopLeft string required

options OfficeIMO.Excel.ExcelMutationPlanOptions? = null optional

Plans a formula-aware transposed copy.

Parameters

sourceRange string required

destinationTopLeft string required

options OfficeIMO.Excel.ExcelMutationPlanOptions? = null optional

Applies worksheet protection using the provided options.

Parameters

options OfficeIMO.Excel.ExcelSheetProtectionOptions? = null optional

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

Applies worksheet protection with permissions for common Excel table editing workflows.

Parameters

password string? = null optional

Evaluates supported formulas on this sheet and writes cached results.

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

Parameters

options OfficeIMO.Excel.ExcelReaderOptions? = null optional

Removes a named allowed-edit region.

Parameters

name string required

Removes one attached conditional-formatting rule.

Parameters

rule OfficeIMO.Excel.ExcelConditionalFormattingInfo required

Removes data validation rules, optionally restricted to a range.

Parameters

a1Range string? = null optional

Removes every standard ignored-error region overlapping the supplied A1 cell or range.

Parameters

range string required

Removes the in-cell image value from one cell. Shared rich-data assets remain available to copied cells.

Parameters

row int required

column int required

Removes a manual worksheet column page break.

Parameters

column int required

save bool = true optional

Removes a manual worksheet row page break.

Parameters

row int required

save bool = true optional

Removes a defined name scoped to this sheet.

Parameters

name string required

Defined name to remove.

save bool = true optional

When true, saves the workbook after removal.

Removes every sparkline whose destination intersects a range and prunes empty groups.

Parameters

locationRange string required

Removes an optional worksheet row block and shifts following worksheet rows up.

Parameters

firstRow int required

1-based first row in the optional block.

rowCount int required

Number of rows in the optional block.

Removes a threaded comment. Root-comment removal includes its reply tree by default.

Parameters

id string required

Threaded comment id.

removeReplies bool = true optional

Whether replies and imported descendant replies should be removed with the comment.

Removes every threaded comment and reply attached to a worksheet cell.

Parameters

address string required

Renames a table and every parsed structured reference to it across the workbook.

Parameters

tableOrRange string required

newName string required

validationMode OfficeIMO.Excel.ExcelTableNameValidationMode = Strict optional

Reassigns consecutive priorities in the supplied order. The sequence must contain every currently attached rule exactly once.

Parameters

orderedRules System.Collections.Generic.IReadOnlyList<OfficeIMO.Excel.ExcelConditionalFormattingInfo> required

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

Parameters

oldText string required

newText string required

Adds a reply using the worksheet and cell of an existing root threaded comment.

Parameters

parentId string required

text string required

author string = "OfficeIMO" optional

date System.DateTime? = null optional

id string? = null optional

Starts a report builder on this worksheet. Existing cells are retained until report content writes them.

Parameters

options OfficeIMO.Excel.ExcelReportOptions? = null optional

Resizes a table while retaining its current ordered column names.

Parameters

tableOrRange string required

newRange string required

Saves the selected worksheet images without retaining their encoded payloads, and returns an aggregate report.

Parameters

folderPath string required

options OfficeIMO.Excel.ExcelImageExportOptions? = null optional

cancellationToken System.Threading.CancellationToken = default optional

Asynchronously saves the selected worksheet images without retaining payloads, and returns an aggregate report.

Parameters

folderPath string required

options OfficeIMO.Excel.ExcelImageExportOptions? = null optional

cancellationToken System.Threading.CancellationToken = default optional

Searches formula text, function calls, or parsed references on this worksheet.

Parameters

options OfficeIMO.Excel.ExcelFormulaSearchOptions required

Adds or replaces a named allowed-edit region on a protected worksheet.

Parameters

name string required

ranges System.Collections.Generic.IEnumerable<string> required

password string? = null optional

securityDescriptor string? = null optional

Sets a shared-free array formula over a range. The top-left cell owns the formula metadata.

Parameters

a1Range string required

formula string 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 int required

header string required

value object? required

options OfficeIMO.Excel.ExcelReaderOptions? = null optional

Hides or shows the specified column.

Parameters

columnIndex int required

1-based column index.

hidden bool required

True to hide the column; false to show it.

Sets column outline metadata used by Excel grouping.

Parameters

columnIndex int required

One-based column index.

outlineLevel byte required

Outline level from 0 through 7.

collapsed bool = false optional

Whether the column is shown as collapsed.

save bool = true optional

Whether to save the worksheet XML immediately.

Sets the width of the specified column.

Parameters

columnIndex int required

1-based column index.

width OfficeIMO.Excel.ExcelColumnWidth required

The column width.

Applies positive custom widths together and saves the worksheet XML once. Existing column styles, visibility and outline metadata are preserved.

Parameters

columnWidths System.Collections.Generic.IReadOnlyDictionary<int, OfficeIMO.Excel.ExcelColumnWidth> required

Widths keyed by 1-based column index. Widths above 255 are clamped.

Exceptions

• ArgumentNullException – The width map is null.
• ArgumentOutOfRangeException – An index is outside the worksheet or a width is non-positive or non-finite.

Sets supplied text and solid-fill colors on an attached conditional rule, preserving its other native styling. Returns a fresh editable snapshot. If both colors are omitted, applies the creation theme's Danger text and light Danger fill. When one color is supplied, the other remains unchanged. Native theme roles stay linked to the workbook.

Parameters

rule OfficeIMO.Excel.ExcelConditionalFormattingInfo required

color OfficeIMO.OfficeColor? = null optional

fillColor OfficeIMO.OfficeColor? = null optional

Applies prompt/error-message metadata to existing validations that overlap the range.

Parameters

a1Range string required

options OfficeIMO.Excel.ExcelDataValidationMessageOptions required

Sets the worksheet default column width from characters or a physical length.

Parameters

width OfficeIMO.Excel.ExcelColumnWidth required

Default column width. Excel supports resolved widths up to 255 character units.

save bool = true optional

Whether to save the worksheet XML immediately.

Sets the worksheet default row height from characters or a physical length.

Parameters

height OfficeIMO.Excel.ExcelColumnWidth required

Default row height. Excel supports physical heights up to 409 points.

hidden bool = false optional

Whether empty rows should be hidden by default.

save bool = true optional

Whether to save the worksheet XML immediately.

Authors a dynamic array at one anchor cell. Calculation determines its bounded spill range.

Parameters

a1Cell string required

formula string required

Hides or shows the worksheet in the workbook.

Parameters

hidden bool required

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

Parameters

row int required

1-based row index.

column int required

1-based column index.

url string required

Target URL.

style bool = true optional

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"

Attaches an external hyperlink to an existing cell without replacing its value or rich-text runs.

Parameters

row int required

1-based row index.

column int required

1-based column index.

url string required

Target URL.

style bool = true optional

When true, applies the cell-level hyperlink style.

tooltip string? = null optional

Optional ScreenTip text shown by spreadsheet applications.

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 int required

1-based row index.

column int required

1-based column index.

url string required

Target URL.

title string? = null optional

Optional preferred display text.

style bool = true optional

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