Telerik.Documents.SpreadsheetStreaming
Initializes a new instance of the class with default values from the current culture for delimiter, quote, and encoding.
Gets or sets the character used to separate values in CSV data, defaulting to the list separator of the current culture.
The delimiter symbol.
Gets or sets the character used to quote values containing delimiters or line breaks, defaulting to double-quote (\").
The quote symbol.
Gets or sets a value indicating whether the first row of CSV data contains column headers rather than data, defaulting to false.
The has header row.
Gets or sets the text encoding used for reading and writing CSV files, defaulting to UTF-8 with BOM.
The encoding.
Gets or sets a value indicating whether empty cell values are included in the CSV export, affecting trailing delimiters on rows.
True if the empty values are exported; otherwise false.
Determines whether two instances are equal by comparing their delimiter, quote, header row, and encoding settings.
The first value.
The second value.
The result of the operator.
Determines whether two instances are not equal by comparing their delimiter, quote, header row, and encoding settings.
The first value.
The second value.
The result of the operator.
Determines whether the specified object is a instance with equal delimiter, quote, header row, and encoding values.
The object to compare with the current object.
true if the specified is equal to the
current ; otherwise, false.
Computes a hash code by combining the hash codes of delimiter, quote, header row, and encoding properties.
A hash code for the current .
Performs application-defined tasks associated with freeing, releasing,
or resetting unmanaged resources.
Disposes the specified clean up managed resources.
The clean up managed resources.
Configuration for CSV import controlling delimiter, quote character, and text encoding used while streaming worksheet data.
Initializes a new instance of the class with culture-aware defaults.
By default, is the current culture's list separator, is '"',
and is UTF-8 with BOM (Excel-compatible).
Gets or sets the character that separates fields in each record, falling back to the current culture list separator when unset.
The delimiter symbol.
Gets or sets the text qualifier enclosing field values that contain the delimiter or line breaks (defaults to ").
The quote symbol.
Gets or sets the character encoding applied when reading the CSV stream (defaults to Excel's UTF-8 with BOM for compatibility).
The encoding.
Provides utility methods for cell value formatting, date-time conversion, culture handling, and number format string parsing.
Defines the earliest date the RadSpreadsheet recognizes.
Gets or sets the culture helper used for resolving locale-specific formatting settings such as decimal separators, currency symbols, and list separators.
Builds number format strings with optional thousands separator and specified decimal places following the current culture's conventions.
Builds a list of number format strings with the specified decimal places and optional thousands separator.
The decimal places.
The use thousand separator.
Provides culture-specific separators, parsing, and formatting rules for cell values, formulas, numbers, dates, and currency in spreadsheet operations.
Initializes a new culture helper bound to the specified culture, which determines separators and number formats.
The culture for the new instance.
The culture used by this helper to determine separators, number formats, and parsing rules.
Provides culture-aware factory methods for Excel built-in number formats whose formatCode is implied (not explicitly written) on export.
Returns the General number format string for the current culture (e.g. en-US: General).
The number format string.
Returns the basic integer number format (e.g. en-US: 0).
The number format string.
Returns a number format with two decimal places and no thousands separator (e.g. en-US: 0.00).
The number format string.
Returns an integer number format including thousands separators (e.g. en-US: #,##0).
The number format string.
Returns a number format with two decimal places and thousands separators (e.g. en-US: #,##0.00).
The number format string.
Returns a currency format with no decimals and standard positive/negative patterns (e.g. en-US: $#,##0_);($#,##0)).
The number format string.
Returns a currency format with no decimals using red for negative values (e.g. en-US: $#,##0_);[Red]($#,##0)).
The number format string.
Returns a currency format with two decimals and standard positive/negative patterns (e.g. en-US: $#,##0.00_);($#,##0.00)).
The number format string.
Returns a currency format with two decimals using red for negative values (e.g. en-US: $#,##0.00_);[Red]($#,##0.00)).
The number format string.
Returns a percent format with no decimal places (e.g. en-US: 0%).
The number format string.
Returns a percent format with two decimal places (e.g. en-US: 0.00%).
The number format string.
Generates a cuture dependent Scientific number format string.
Example format in en-US culture: 0.00E+00.
The number format string.
Generates a Fraction number format for up to one digit.
Example format in en-US culture: # ?/?.
The number format string.
Generates a Fraction number format for up to two digit.
Example format in en-US culture: # ??/??.
The number format string.
Generates a Date number format for short date.
Example format in en-US culture: m/d/yyyy.
The number format string.
Generates a Date number format with day, month and year.
Example format in en-US culture: d-mmm-yy.
The number format string.
Generates a Date number format with day and month.
Example format in en-US culture: d-mmm.
The number format string.
Generates a Date number format with month and year.
Example format in en-US culture: mmm-yy.
The number format string.
Generates a Time number format with hours, minutes and AM/PM.
Example format in en-US culture: h:mm AM/PM.
The number format string.
Generates a Time number format with hours, minutes, seconds and AM/PM.
Example format in en-US culture: h:mm:ss AM/PM.
The number format string.
Generates a Time number format with hours and minutes.
Example format in en-US culture: h:mm.
The number format string.
Generates a Time number format with hours, minutes and seconds.
Example format in en-US culture: h:mm:ss.
The number format string.
Generates a Time number format with short date, hours and minutes.
Example format in en-US culture: m/d/yyyy h:mm.
The number format string.
Generates a Date number format with day, month and year.
Example format in en-US culture: m/d/yyyy.
The number format string.
Generates a Currency number format string with no decimal places, a thousand separator, and positive and negative format pattern and alignment.
Example format in en-US culture: #,##0_);(#,##0).
The number format string.
Generates a Currency number format string with no decimal places, a thousand separator, and positive and negative format with red digits patterns and alignment.
Example format in en-US culture: #,##0_);[Red](#,##0).
The number format string.
Generates a Currency number format string with two decimal places, a thousand separator, and positive and negative format pattern and alignment.
Example format in en-US culture: #,##0.00_);(#,##0.00).
The number format string.
Generates a Currency number format string with two decimal places, a thousand separator, and positive and negative format with red digits patterns and alignment.
Example format in en-US culture: #,##0.00_);[Red](#,##0.00).
The number format string.
Generates a Currency number format string.
Example format in en-US culture: _(*#,##0_);_(*(#,##0);_(* "-"_);_(@_).
The number format string.
Generates a Currency number format string.
Example format in en-US culture: _($*#,##0_);_($*(#,##0);_($* "-"_);_(@_).
The number format string.
Generates a Currency number format string.
Example format in en-US culture: _(*#,##0.00_);_(*(#,##0.00);_(*"-"??_);_(@_).
The number format string.
Generates a Currency number format string.
Example format in en-US culture: _($*#,##0.00_);_($*(#,##0.00);_($*"-"??_);_(@_).
The number format string.
Generates a culture dependent Scientific number format string.
Example format in en-US culture: ##0.0E+0.
The number format string.
Returns built in format with the specified id.
The searched format id.
The format string.
Initializes a new instance of the class.
The underlying stream to write to.
The encoding for the stream.
Initializes a new instance of the class.
The stream.
Initializes a new instance of the class using default encoding.
The underlying stream to write to.
The encoding.
Determines whether the passed stream should be disposed when
is disposed.
Disposes of the stream writer.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Identifies the type of value stored in a .
A string cell value.
A numeric (double) cell value.
A boolean cell value.
A DateTime cell value.
A formula cell with no cached value.
A formula cell with a pre-computed cached value.
Stores a buffered cell value captured during a block.
The property is typed as , which causes boxing for
value types (double, bool, DateTime). This is an accepted trade-off for API simplicity
given that these objects are short-lived and collected promptly after row replay.
Initializes a new instance of the class.
The type of cell value.
The boxed cell value.
Initializes a new instance of the class with a cached formula value.
The type of cell value (should be ).
The formula text.
The pre-computed cached value string.
Gets the type of cell value.
Gets the boxed cell value.
Gets the cached formula value string, or null if not a formula-with-cache.
Lazily cached string representation of the cell value. Set by
on first access
to avoid repeated allocations when multiple filter columns evaluate the same cell.
A buffering row exporter used during blocks.
Rows are buffered until disposal; cells are replayed to the real exporter in original order.
Row-level setters (Hidden, OutlineLevel, HeightInPoints) replay BEFORE the first cell creation.
Filter evaluation determines whether the row should be hidden based on the active auto-filter.
Buffering lifecycle:
- Cells are captured into the cells list and their values into columnValues.
- On dispose, the filter evaluator checks columnValues against the active auto-filter.
- Buffered cells are replayed to a real with the computed hidden state.
- After replay, both cells and columnValues are cleared to release memory promptly.
Evaluates buffered row data against AutoFilter criteria to determine visibility.
String-typed cells containing date-formatted text are not parsed as dates by design.
Callers who need date filtering should pass DateTime via
.
OADate range is approximately years 100 AD – 9999 AD; values outside this range
are treated as non-dates and excluded from date-based filter evaluation.
The today parameter is captured at
time and held constant for the entire filtering block, ensuring consistency even across midnight.
Wildcard pattern length is capped at characters to guard
against pathological regex construction.
This class is not thread-safe. is documented as
single-writer per worksheet.
Maximum number of cached wildcard regex entries in the LRU cache.
Acts as a DoS guard to prevent unbounded memory growth.
Maximum allowed wildcard pattern length. Patterns exceeding this limit are rejected
to prevent pathological regex construction times.
NumberStyles used when parsing filter values and cached formula values as numbers.
Excludes so hex strings like "0xFF"
are not silently parsed as numeric values.
Evaluates whether a buffered row matches all filter columns defined in the given auto-filter.
The parameter must be or a test-injected
value used for deterministic verification. String-typed cells containing date-formatted text
are NOT parsed as dates by design; callers who need date filtering should pass DateTime via
.
Appends the accumulated literal character run [literalStart .. endExclusive) as a single
Regex.Escape call, then resets literalStart to -1. This avoids per-character Regex.Escape
overhead for runs of safe characters.
Simple LRU (Least Recently Used) cachefor compiled wildcard regex patterns.
On hit, the entry is promoted to the front. On miss, a new entry is added to the front.
When the cache exceeds its maximum size, the least recently used entry is evicted.
All access must be externally synchronized via .
The method uses
(the O(1) node overload) — NOT (the O(n) value overload).
The dictionary stores references so promotion is always O(1).
Attempts to retrieve a cached regex for the given key and promotes it to
the front of the LRU list on hit.
The wildcard pattern key.
The cached regex, or null if not found.
true if the key was found; otherwise false.
Adds a new key/value pair to the front of the cache. Evicts the least recently
used entry if the cache has reached .
The wildcard pattern key.
The compiled regex to cache.
After calling this method, value changes are forbidden.
Serializes and deserializes the OOXML <autoFilter> element (§18.3.1.2).
Typical worksheets have 1-4 active filter columns. Used as initial capacity
to avoid resizing the list in the common case.
Serializes and deserializes the OOXML <filterColumn> element (§18.3.2.7).
Serializes and deserializes the OOXML <filters> element (§18.3.2.7)
containing <filter> and <dateGroupItem> children.
Serializes and deserializes the OOXML <filter> element (§18.3.2.5).
Serializes and deserializes the OOXML <dateGroupItem> element (§18.3.2.4).
Serializes and deserializes the OOXML <customFilters> element (§18.3.2.2).
Serializes and deserializes the OOXML <customFilter> element (§18.3.2.1).
Serializes and deserializes the OOXML <top10> element (§18.3.2.9).
Serializes and deserializes the OOXML <dynamicFilter> element (§18.3.2.5).
Streams page layout settings (paper, orientation, scaling) for a worksheet prior to print/export operations.
Set the target paper size used for pagination.
The paper size.
Set portrait or landscape orientation.
The page orientation.
Define the traversal order (over then down or vice versa) when printing multi-page sheets.
The page order.
Constrain the vertical page count target for automatic scaling (fit-to-pages tall).
The number of pages.
Constrain the horizontal page count target for automatic scaling (fit-to-pages wide).
The number of pages.
Set an explicit scale factor (0.1–4.0) overriding fit-to-pages behavior when specified.
The scale factor.
Streams worksheet viewport and selection state (scroll position, panes, zoom, grid/headers visibility, selection).
Set the first visible cell (scroll origin) of the worksheet view.
The row index.
The column index.
Freeze the specified number of top rows and left columns to keep them visible while scrolling.
The number of frozen rows.
The number of frozen column.
Freeze panes and specify the first visible cell within the scrollable (bottom-right) pane.
The number of frozen rows.
The number of frozen column.
The scrollable pane first visible cell row index.
The scrollable pane first visible cell column index.
Set the zoom percentage (scale factor) applied to the sheet view.
The percentage that the viewport will be scaled to.
Show or hide gridlines in the worksheet viewport.
True for visible gridlines, otherwise False.
Show or hide the row and column headers.
True for visible row and column headers, otherwise False.
Set the active (anchor) cell of the current selection.
The row index of the active cell.
The column index of the active cell.
Add a rectangular range to the multi-range selection.
The row index of the top left cell of the range.
The column index of the top left cell of the range.
The row index of the bottom right cell of the range.
The column index of the bottom right cell of the range.
Represents an auto-filter range applied to a worksheet with optional filter column definitions.
When is empty, all data rows remain visible (no filtering criteria
are evaluated). Dropdown buttons are still emitted on the header row columns.
Use to emit filter rules only
(no row hiding). Use /
to emit filter rules AND hide non-matching rows during streaming.
Initializes a new instance of the class with a range only (no filter columns).
The start row index of the auto-filter range.
The start column index of the auto-filter range.
The end row index of the auto-filter range.
The end column index of the auto-filter range.
Thrown when any index is negative, exceeds the maximum Excel row,
exceeds the maximum Excel column, or the from-indices exceed the to-indices.
Initializes a new instance of the class with a range and filter columns.
The start row index of the auto-filter range.
The start column index of the auto-filter range.
The end row index of the auto-filter range.
The end column index of the auto-filter range.
The filter column definitions. Can be null.
Thrown when any index is out of the valid Excel range.
Thrown when a exceeds the auto-filter column span,
or when two filter columns share the same .
Gets the start row index of the auto-filter range.
Gets the start column index of the auto-filter range.
Gets the end row index of the auto-filter range.
Gets the end column index of the auto-filter range.
Gets the filter column definitions applied to specific columns within the auto-filter range.
Marker interface for all auto-filter filter types.
Implemented by , ,
, and .
Represents a filter applied to a specific column within an auto-filter range.
is relative to the parent .
For example, if the auto-filter starts at column 2 and the filter column targets column 4, set
to 2.
Initializes a new instance of the class.
The zero-based column index relative to the auto-filter range start column.
The filter criteria to apply to the column.
Gets the zero-based column index relative to the auto-filter range start column.
Gets the filter criteria applied to this column.
Represents a value-based filter that shows only rows matching specific string values,
date groups, or blank cells.
, , and are combined
with OR logic: a row passes the filter if it matches any of the string values, any of the
date items, or the blank condition (when enabled).
Blank match returns true for null cells AND for string cells whose value is the empty string.
String values are matched case-insensitively during filter evaluation.
Null strings are rejected at construction time; pass an empty collection instead.
Initializes a new instance of the class with string values.
The string values to match.
Initializes a new instance of the class with string values and blank option.
The string values to match.
Whether to include blank cells.
Initializes a new instance of the class with date group items.
The date group items to match.
Initializes a new instance of the class.
The string values to match. Can be null.
The date group items to match. Can be null.
Whether to include blank cells.
Thrown when any element of is null,
or when any element of is null.
Gets the string values to match.
Gets the date group items to match.
Gets a value indicating whether to include blank cells.
Represents a custom filter using one or two comparison criteria with a logical operator.
When using a single criterion, only is set and
is null. In that case, is ignored during evaluation.
Initializes a new instance of the class with a single criterion.
The comparison criterion.
Initializes a new instance of the class with two criteria.
The first comparison criterion.
The logical operator combining the two criteria.
The second comparison criterion.
Gets the first comparison criterion.
Gets the second comparison criterion, or null if only one criterion is used.
Gets the logical operator combining the two criteria.
Represents a single comparison criterion for a custom filter.
The may be an empty string, which is a valid filter value in Excel.
An empty string matches cells that contain exactly the empty string.
Wildcards * (any sequence) and ? (single char) can be used in
when the comparison operator is
or .
To match a literal *, ?, or ~, escape it with a tilde:
~*, ~?, ~~.
Initializes a new instance of the class.
The comparison operator.
The value to compare against. May be empty but not null.
Thrown when is null.
Gets the comparison operator.
Gets the value to compare against.
Represents a Top 10 filter that shows the top or bottom N items or percentages.
represents a count when is
or ,
and a percentage when is
or .
Note that does not evaluate Top10 filters;
the rules are emitted to the output but no rows are hidden based on them.
Initializes a new instance of the class.
The type of top/bottom filter.
The count or percentage value. Must be a finite number greater than zero.
Thrown when is less than or equal to zero.
Thrown when is NaN or Infinity.
See the class-level remarks for streaming-mode limitations regarding Top10 filter evaluation.
Gets the type of top/bottom filter.
Gets the count or percentage value.
Represents a dynamic filter based on relative date periods or statistical measures.
and
cannot be evaluated row-by-row during because they require
knowledge of all values in the column. When these types are used, the filter rules are emitted to the output
but no rows are hidden based on them.
Date/time evaluation uses at the time
is active; timezone conversion is not performed.
Initializes a new instance of the class.
The type of dynamic filter.
Week filters (,
, )
use a Sunday-start week convention (consistent with ).
Quarter filters ( through
) are year-agnostic: Quarter1 matches
January–March in ANY year.
Gets the type of dynamic filter.
Represents a hierarchical date criterion for value-based filtering.
Initializes a new instance of the class with year granularity.
The year to match.
Initializes a new instance of the class with month granularity.
The year.
The month (1-12).
Initializes a new instance of the class with day granularity.
The year.
The month (1-12).
The day (1-31).
Initializes a new instance of the class with all components.
The year (must be >= 1).
The month (1-12), or 0 when not used at the given granularity.
The day (1-31), or 0 when not used at the given granularity.
The hour (0-23), or 0 when not used at the given granularity.
The minute (0-59), or 0 when not used at the given granularity.
The second (0-59), or 0 when not used at the given granularity.
The date/time grouping granularity.
Thrown when any component is outside its valid range for the specified granularity.
Gets the year.
Gets the month (1-12), or 0 if not used.
Gets the day (1-31), or 0 if not used.
Gets the hour (0-23), or 0 if not used.
Gets the minute (0-59), or 0 if not used.
Gets the second (0-59), or 0 if not used.
Gets the date/time grouping granularity.
Specifies a comparison operator for custom filter criteria.
Equal to.
Member named EqualsTo (vs. grammatical EqualTo) for API consistency
with prior versions. This is a public enum and the name is stable.
Not equal to.
Greater than.
Greater than or equal to.
Less than.
Less than or equal to.
Specifies how two custom filter criteria are combined.
Both criteria must be satisfied.
Either criterion can be satisfied.
Specifies the type of Top 10 filter.
Show the top N items by value.
Show the bottom N items by value.
Show the top N percent of items.
Show the bottom N percent of items.
Show the top N items by value. Alias for .
Specifies the type of dynamic filter for date/time or statistical filtering.
No dynamic filter.
Values above the average.
Values below the average.
Today's date.
Yesterday's date.
Tomorrow's date.
The current week.
The previous week.
The next week.
The current month.
The previous month.
The next month.
The current quarter.
The previous quarter.
The next quarter.
The current year.
The previous year.
The next year.
From the start of the year to today.
Quarter 1 (January - March).
Quarter 2 (April - June).
Quarter 3 (July - September).
Quarter 4 (October - December).
January.
February.
March.
April.
May.
June.
July.
August.
September.
October.
November.
December.
Specifies the granularity level of a date group item.
Values are ordered from coarsest (Year) to finest (Second). The
constructor uses this ordering to determine which date components require validation:
components at or coarser than the specified type are validated.
Group by year.
Group by month.
Group by day.
Group by hour.
Group by minute.
Group by second.
Lightweight metadata describing a worksheet (currently only its name) for enumeration scenarios.
Gets the worksheet name as it appears on the workbook tab.
Modes controlling whether a new workbook is created or existing content is appended when exporting.
Creates a new workbook, overwriting any existing stream content.
Appends to an existing workbook in the stream, or creates one if the stream is empty.
Exposes positional data, value, and formatting for a cell being streamed in from an existing worksheet.
Gets the zero-based row index of the cell within its worksheet.
The index of the row.
Gets the zero-based column index of the cell within its worksheet.
The index of the column.
Gets the effective cell formatting (borders, font, alignment, number format, etc.).
The format.
Gets the raw stored value string for the cell. If the cell contains a formula, this is the cached result value.
The value.
Gets the formula unparsed string value when the cell contains a formula.
The value.
Gets the OOXML cell value type describing how to interpret the stored value.
Exposes structural and layout properties for a column (or contiguous range with identical settings) during import.
Gets the first zero-based column index covered by this range sharing identical settings.
The index.
Gets the last zero-based column index (inclusive) of the homogeneous (with the same properties) column range.
The index.
Gets a value indicating whether a custom width (as opposed to default) is defined for the columns.
A value indicating if the width of the column is custom.
Gets the column width expressed in device-independent pixels.
The width in pixels.
Gets the character-based width (Excel standard width unit, roughly number of zeros fitting the cell).
The width in characters.
Gets the grouping outline depth of the columns (0 for no grouping).
The outline level.
Gets a value indicating whether the columns are hidden.
A value indicating if the column is hidden.
Exposes row position, layout, visibility, and streamed cell sequence while importing a worksheet.
Gets the zero-based index of the row within the worksheet.
The index of the row.
Gets the grouping outline depth (0 for none) applied to the row.
The outline level.
Gets a value indicating whether a custom height has been explicitly set.
A value indicating if the height is custom.
Gets the row height in device-independent pixels when custom height is defined.
The height in pixels.
Gets the row height in points when custom height is defined.
The height in points.
Gets a value indicating whether the row is hidden from view.
A value indicating if the row is hidden.
Enumerates the streamed cells contained in this row.
The cells.
Provides forward-only access to worksheets in an existing workbook for low-memory data extraction.
Gets the sequence of worksheet importers exposing sheet contents lazily.
The worksheet importers.
Provides streamed access to worksheet structure (rows, columns) and name during workbook import.
Gets the worksheet's name as stored in the workbook.
The name.
Gets a sequence of column descriptors exposing width, grouping, and visibility.
The columns.
Gets a streamed sequence of row importers for reading cell sets row by row.
The rows.
Gets the AutoFilter applied to the worksheet, or null if no AutoFilter is defined.
This property can only be accessed after all rows have been consumed.
The auto filter.
Represents an entry point to import a spreadsheet.
Creates new CSV importer with settings.
The document stream.
The document settings.
Creates the workbook importer.
The document format.
The stream.
Immutable ARGB color value used in cell formatting and theming.
Initializes a new instance of the class.
The red component value.
The green component value.
The blue component value.
Green color component (0–255).
The green component value.
Red color component (0–255).
The red component value.
Blue color component (0–255).
The blue component value.
Determines whether the specified is equal
to the current .
The to compare with the current
.
Returns true if the specified is equal to the
current ; otherwise, false.
Serves as a hash function for a particular type.
A hash code for the current .
Predefined tint and shade tiers that can be applied to a theme color to derive lighter or darker variations.
First predefined shade level for a theme color.
Second predefined shade level for a theme color.
Third predefined shade level for a theme color.
Fourth predefined shade level for a theme color.
Fifth predefined shade level for a theme color.
Print page sequencing options applied when paginating a worksheet for printing.
Fills pages vertically first, then moves right to the next column of pages.
Fills pages horizontally first, then continues with the next row of pages below.
Page orientation options for printed worksheet pages.
Tall orientation (short edge at top and bottom).
Wide orientation (long edge at top and bottom).
Common paper sizes (approximate width x height in inches) for worksheet printing.
Identifies a paper sheet size of 33.1 inches x 46.8 inches.
Identifies a paper sheet size of 23.4 inches x 33.1 inches.
Identifies a paper sheet size of 16.5 inches x 23.4 inches.
Identifies a paper sheet size of 11.7 inches x 16.5 inches.
Identifies a paper sheet size of 8.3 inches x 11.7 inches.
Identifies a paper sheet size of 5.8 inches x 8.3 inches.
Identifies a paper sheet size of 33.9 inches x 48 inches.
Identifies a paper sheet size of 24 inches x 33.9 inches.
Identifies a paper sheet size of 16.9 inches x 24 inches.
Identifies a paper sheet size of 12 inches x 16.9 inches.
Identifies a paper sheet size of 8.5 inches x 12 inches.
Identifies a paper sheet size of 4.8 inches x 8.5 inches.
Identifies a paper sheet size of 39.4 inches x 55.7 inches.
Identifies a paper sheet size of 27.8 inches x 39.4 inches.
Identifies a paper sheet size of 59.1 inches x 19.7 inches.
Identifies a paper sheet size of 13.9 inches x 19.7 inches.
Identifies a paper sheet size of 10.1 inches x 14.3 inches.
Identifies a paper sheet size of 7.2 inches x 10.1 inches.
Identifies a paper sheet size of 8 inches x 10 inches.
Identifies a paper sheet size of 8 inches x 13 inches.
Identifies a paper sheet size of 7.5 inches x 10 inches.
Identifies a paper sheet size of 10.5 inches x 8 inches.
Identifies a paper sheet size of 8.5 inches x 11 inches.
Identifies a paper sheet size of 8.5 inches x 14 inches.
Identifies a paper sheet size of 17 inches x 11 inches.
Identifies a paper sheet size of 11 inches x 17 inches.
Identifies a paper sheet size of 15.6 inches x 19.2 inches.
Identifies a paper sheet size of 20 inches x 15 inches.
Identifies a paper sheet size of 16.5 inches x 21 inches.
Identifies a paper sheet size of 17.5 inches x 22 inches.
Identifies a paper sheet size of 18 inches x 23 inches.
Identifies a paper sheet size of 20 inches x 25 inches.
Identifies a paper sheet size of 21.7 inches x 28 inches.
Identifies a paper sheet size of 23.5 inches x 35 inches.
Identifies a paper sheet size of 35 inches x 45 inches.
Identifies a paper sheet size of 5.5 inches x 8.5 inches.
Identifies a paper sheet size of 8.5 inches x 13 inches.
Identifies a paper sheet size of 5.5 inches x 8.5 inches.
Identifies a paper sheet size of 10 inches x 14 inches.
Color value that may be a direct RGB color or a theme slot with optional shade/tint or automatic semantics.
Initializes a new instance of the class.
The color.
Initializes a new instance of the class.
The color.
The is automatic.
Initializes a new instance of the class.
Type of the theme color.
The tint and shade.
Initializes a new instance of the class.
Type of the theme color.
Initializes a new instance of the class.
Type of the theme color.
Type of the predefined tint and shade proportion for the themable color.
Direct RGB color value when not theme-based; null if resolved from theme.
The local value of the color.
Indicates an automatic color whose final value may be chosen contextually by a consumer.
Value indicating if the color is automatic.
Theme color slot referenced when the color is theme-based.
The type of the theme color.
Predefined shade level applied to the theme color, if specified.
The type of the color shade.
Numeric tint/shade adjustment (-1..1) applied to the theme color to compute the final color.
The tint and shade value.
Indicates whether the color is derived from the workbook theme instead of a fixed RGB value.
The value indicating if the color comes from a theme.
Creates a new instance of the class.
The red component.
The green component.
The blue component.
Instance of the class.
Determines whether the specified themable colors are equal.
True if the themable colors are equal; otherwise, false.
Determines whether the specified themable colors are different.
True if the themable colors are different; otherwise, false.
Explicitly cast color to themable color.
The color.
Themable color.
Converts to .
The .
The .
Determines whether the specified is equal
to the current .
The to compare with the current
.
Returns true if the specified is equal to the
current ; otherwise, false.
Serves as a hash function for a particular type.
A hash code for the current .
Returns a string that represents the themable color.
A string that represents the themable color.
Font family reference that can point to a concrete font name or a theme font slot.
Initializes a new instance of the class.
The font family name.
Initializes a new instance of the class.
Type of the theme font.
Concrete font family name when not using a theme font; null if theme-based.
The local value of the font family.
Theme font role (Major/Minor) when theme-based.
The type of the theme font.
Indicates whether the font family is resolved from the workbook theme instead of a fixed name.
The value indicating if the font family comes from a theme.
Determines whether the specified document themable font families are equal.
True if the document themable font families are equal; otherwise, false.
Determines whether the specified document themable font families are different.
True if the document themable font families are different; otherwise, false.
Returns a string that represents the document themable font family.
A string that represents the document themable font family.
Determines whether the specified is equal
to the current .
The to compare with the current
.
Returns true if the specified is equal to the
current ; otherwise, false.
Serves as a hash function for a particular type.
A hash code for the current .
Named theme color slots used to supply consistent palette values across a workbook.
Primary light background color (Light1).
Primary dark text color (Dark1).
Secondary light background color (Light2).
Secondary dark text color (Dark2).
Accent color 1.
Accent color 2.
Accent color 3.
Accent color 4.
Accent color 5.
Accent color 6.
Hyperlink foreground color.
Visited hyperlink foreground color.
Theme font roles applied across styles for consistent typography.
Body (minor) font.
Heading (major) font.
Throws if the string contains XML 1.0 illegal characters
(code points 0x00-0x08, 0x0B, 0x0C, 0x0E-0x1F) which would corrupt the output document.
Converts the row index to name.
Index of the row.
The name.
Converts the row name to index.
Name of the row.
The index.
Converts the column index to name.
Index of the column.
The name.
Converts the cell index to name.
Index of the row.
Index of the column.
The name.
Converts the cell range to a name.
Index of from row.
Index of from column.
Index of to row.
Index of to column.
The name.
Converts the cell indexes to a name.
The start row index.
The start column index.
The end row index.
The end column index.
The name.
Streams cell content and formatting to an output spreadsheet document in a forward-only, low-memory fashion.
Write a string value to the current cell.
The string value.
Write a numeric (double) value to the current cell for number/date formatting.
The double value.
Write a boolean value (TRUE/FALSE) to the current cell.
The boolean value.
Write a DateTime value converted to the spreadsheet serial number representation.
The DateTime value.
Write a formula expression and mark the cell as formula typed.
Cells written via this overload are always visible during a
block because no cached value is available
for filter evaluation. Use to participate in filtering.
The formula value.
Write a formula expression with a pre-computed cached value. The cached value is written
to the output as the cell value element and is used for filter evaluation when the cell
participates in a block.
The is REQUIRED for the cell to participate in
evaluation. The single-arg
overload writes a formula whose cell is always
visible during filtering (no cached value to evaluate against).
The formula expression.
The pre-computed cached value.
Thrown when or is null.
Apply the provided cell format (style, number format, alignment, borders, etc.) to the current cell.
The cell format.
Streams column-level layout and visibility settings to the output worksheet.
Set the column width in device-independent pixels for precise layout control.
The width value in pixels.
Set the column width measured as the number of zero (0) characters that fit (Excel character-based width).
The count of the characters.
Define the outline level used for grouping operations (0 for none, increasing for nested groups).
The outline level value.
Hide or show the column without removing its data from the sheet.
True for hidden; otherwise false.
Streams row-level structure, height, visibility, and cell data to the output worksheet.
Create a forward-only cell exporter positioned at the next cell in the row.
The cell exporter.
Advance the internal column position by the specified number of cells without writing content.
The count of the cells to skip.
Set the grouping outline depth for the row (0 for none).
The row outline level value.
Define a custom row height expressed in device-independent pixels.
The row height value in pixels.
Define a custom row height expressed in typographic points.
The row height value in points.
Hide or show the row while retaining its data and formulas.
True for hidden; otherwise false.
Coordinates streaming creation of worksheets, styles, and sheet metadata into an output workbook package.
Gets the mutable collection of reusable cell styles shared across exported worksheets.
The cell style collection.
Create and return a new worksheet exporter with the specified sheet name.
The name of the worksheet.
The worksheet exporter.
Returns lightweight metadata for all sheets created so far (name, order) without reopening them.
Returns an IEnumerable<SheetInfo> containing information about all sheets present in the workbook.
Streams rows, columns, merged ranges, and view/page settings for a single worksheet.
This interface is not thread-safe. A single writer must own the worksheet exporter
for the duration of its lifetime. Concurrent writes from multiple threads are not supported.
Create a view exporter to configure viewport state (freeze panes, zoom, selection, visibility).
The worksheet view exporter.
Create a row exporter positioned at the next row for writing cells.
The row exporter.
Create a column exporter for defining column widths and grouping before writing rows.
The column exporter.
Create a page setup exporter to configure print layout settings for the sheet.
The page setup exporter.
Advance the internal row index by the specified number without emitting row elements.
The count of the rows to skip.
Advance the internal column position by a given number without writing cells.
The count of the columns to skip.
Merge a rectangular region of cells defined by its start and end row/column indices.
The start row index of the area.
The start column index of the area.
The end row index of the area.
The end column index of the area.
Set an auto-filter on the worksheet for the specified cell range. The filter dropdown buttons
will appear on the header row columns of the range. Can only be called once per worksheet and
must be called after all rows have been exported.
The start row index of the auto-filter range.
The start column index of the auto-filter range.
The end row index of the auto-filter range.
The end column index of the auto-filter range.
Thrown when an auto-filter has already been set on this worksheet or when
is currently active.
Set an auto-filter on the worksheet with a fully configured filter model including filter column
definitions. Can only be called once per worksheet and must be called after all rows have been exported.
The auto-filter model containing range and optional filter column definitions.
Thrown when an auto-filter has already been set on this worksheet or when
is currently active.
Thrown when is null.
Begin auto-filtering data rows. Rows written between this call and
are evaluated against the filter criteria and
automatically hidden when they do not match.
Call this method immediately after writing the header row. The header row itself is not
filtered. Mutually exclusive with .
Rows already written before this call cannot be filtered; the internal row index must
equal autoFilter.FromRowIndex + 1 at call time.
The "today" date used for dynamic date filters is captured once via
at the time this method is called. No timezone
conversion is performed. The captured date is held constant for the entire
filtering block to ensure consistency even if the block spans midnight.
Streaming-mode limitations:
-
and with
or
emit rules but do not hide rows (all rows remain visible).
-
Formula cells without a cached value (single-arg )
are always visible.
-
String-typed cells containing date-formatted text are NOT auto-parsed as dates.
Pass via for date filters.
The auto-filter model containing range and filter column definitions.
Thrown when an auto-filter has already been set, when has
already been called without a matching , when
the header row has not been written yet, or when data rows beyond the header
have already been written.
Thrown when is null.
using (var row = ws.CreateRowExporter()) { /* write header */ }
ws.BeginFiltering(filter);
for (int i = 0; i < dataCount; i++)
{
using (var row = ws.CreateRowExporter()) { /* write data */ }
}
ws.EndFiltering();
End the active filtering block started by .
The auto-filter range is finalized and the filter rules are emitted to the output.
Must be called after . Rows written after this
call bypass filtering and are never hidden. Explicit is
required for deterministic output, but disposal of the worksheet exporter will
auto-complete as a safety net.
Thrown when was not called before this method,
or when has already been called.
Enumerates OOXML cell value types for interpreting and exporting raw cell content consistently with the spreadsheet specification.
Boolean scalar (true / false) stored without localization.
ISO-like serialized date/time value mapped through a date number format.
Error code token (e.g. #DIV/0!) indicating a formula evaluation failure.
Inline rich text payload with formatting runs.
Numeric (floating‑point) value subject to number formatting.
Shared string table reference used to de-duplicate repeated text.
Plain text value.
Formula expression stored for calculation.
Base class encapsulating cell formatting facets (borders, fill, font, number format, alignment, text layout) with flags indicating which aspects are applied.
Initializes a new instance of the class.
All formatting-related properties and apply flags are unset by default; set individual
properties (e.g., borders, fill, font, alignment, number format) to opt-in specific styling.
Left border applied to the cell.
The left border.
Right border applied to the cell.
The right border.
Top border applied to the cell.
The top border.
Bottom border applied to the cell.
The bottom border.
Diagonal-up border (bottom‑left to top‑right) for crossed diagonal effects.
The diagonal up border.
Diagonal-down border (top‑left to bottom‑right) for crossed diagonal effects.
The diagonal down border.
Background fill (pattern or gradient) for the cell.
The fill.
Number format code controlling rendering of numeric, date, and time values.
The number format.
Font size in points.
The size of the font in points.
Font (foreground) color.
The fore color.
Indicates bold font weight.
The value indicating whether the text bold.
Indicates italic font style.
The value indicating whether the text italic.
Underline style applied to the text.
The underline type.
Font family (theme-based or explicit).
The font family.
Horizontal alignment of the cell content.
The horizontal alignment.
Vertical alignment of the cell content.
The vertical alignment.
Indentation level (number of indents) when left-aligned.
The indent.
Indicates whether text wraps to multiple lines within the cell.
The value indicating if the text in a cell should be line-wrapped within the cell.
Reusable named cell style aggregating formatting settings (borders, fill, font, number format, alignment, protection) for consistent reuse.
Indicates whether border properties of this style are applied when the style is used.
True if the border properties should be applied; otherwise, false.
Indicates whether the fill of this style is applied when the style is used.
True if the fill property should be applied; otherwise, false.
Indicates whether font properties of this style are applied when the style is used.
True if the font properties should be applied; otherwise, false.
Indicates whether the number format of this style is applied when the style is used.
True if the number format property should be applied; otherwise, false.
Indicates whether alignment settings of this style are applied when the style is used.
True if the alignment properties should be applied; otherwise, false.
Indicates whether protection settings of this style are applied when the style is used.
True if the protection property should be applied; otherwise, false.
Style display name used for lookup in the collection.
The name of the cell style.
Collection of named reusable cell styles enabling lookup, addition, and enumeration by style name.
Number of styles currently stored in the collection.
The number of elements contained in this collection.
Indexer returning the matching the provided name, or null if it does not exist.
The spread cell style.
Checks whether a style with the given name exists in the collection.
The name of the style.
True if it is present; otherwise, false.
Checks whether the specified style instance is present (by matching its name).
The style.
True if it is present; otherwise, false.
Retrieves the style with the specified name, or null if it is not found.
The name of the style.
The style.
Adds a newly created style with the specified unique name and returns it.
The name of the new cell style.
The style.
Returns a generic enumerator over the styles in the collection.
A that can
be used to iterate through the collection.
Returns a non‑generic enumerator over the styles in the collection.
An object that can be
used to iterate through the collection.
Gradient cell fill defined by a gradient type and two theme or RGB colors.
Initializes a new instance of the class.
Type of the gradient.
The color1 themable color.
The color2 themable color.
Starting gradient color.
The color1 themable color.
Ending gradient color.
The color2 themable color.
Gradient orientation or pattern.
The type of the gradient.
Determines whether the specified is equal
to the current .
The to compare with the current
.
Returns true if the specified is equal to the
current ; otherwise, false.
Serves as a hash function for a particular type.
A hash code for the current .
Gradient orientations and origin patterns available for gradient cell fills.
Left‑to‑right horizontal gradient.
Right‑to‑left horizontal gradient (reverse of Horizontal).
Repeating horizontal banded gradient.
Top‑to‑bottom vertical gradient.
Bottom‑to‑top vertical gradient (reverse of Vertical).
Repeating vertical banded gradient.
Diagonal gradient rising from bottom‑left to top‑right.
Diagonal gradient descending from top‑right to bottom‑left (reverse of DiagonalUp).
Repeating diagonal bands rising from bottom‑left to top‑right.
Diagonal gradient descending from top‑left to bottom‑right.
Diagonal gradient rising from bottom‑right to top‑left (reverse of DiagonalDown).
Repeating diagonal bands descending from top‑left to bottom‑right.
Radial gradient originating at the top‑left corner.
Radial gradient originating at the top‑right corner.
Radial gradient originating at the bottom‑left corner.
Radial gradient originating at the bottom‑right corner.
Radial gradient originating at the center of the cell.
Marker interface for fill pattern/gradient implementations applied to cell backgrounds during export/import.
Pattern-based cell fill defined by a pattern style plus optional pattern and background colors.
Initializes a new instance of the class.
Type of the pattern.
Initializes a new instance of the class.
Type of the pattern.
Color of the pattern.
Color of the background.
Pattern style applied to the fill.
The type of the pattern.
Foreground (pattern) color.
The color of the pattern.
Background color behind the pattern.
The color of the background.
Creates a solid fill from an RGB color.
The color of the pattern.
Solid pattern fill.
Creates a solid fill from a themable color.
The color of the pattern.
Solid pattern fill.
Determines whether the specified is equal
to the current .
The to compare with the current
.
Returns true if the specified is equal to the
current ; otherwise, false.
Serves as a hash function for a particular type.
A hash code for the current .
Vertical text alignment options controlling content placement within cell height.
Aligns content with the bottom edge.
Centers content vertically.
Aligns content with the top edge.
Justifies wrapped lines vertically (except the last line).
Evenly distributes characters vertically, adding space as needed.
Horizontal text alignment options controlling how content is positioned across the cell width.
Default alignment: text left, numbers/dates right, booleans centered (data type inferred automatically).
Aligns content with the left edge of the cell.
Centers content within the cell.
Aligns content with the right edge of the cell.
Justifies wrapped lines except the last across left and right edges.
Repeats cell content to fill the entire width.
Centers content across adjacent cells (center continuous effect).
Evenly distributes characters across the cell width, inserting spacing as needed.
Underline styles available for cell text.
No underline.
Single line underline.
Double line underline.
Single accounting underline drawn flush with the descender baseline (under letters like g, p).
Double accounting underline drawn flush with the descender baseline.
Encapsulates style and color for a single cell border edge used when rendering or exporting spreadsheet cells.
Initialize a border definition with the specified style and themable color.
The border style.
The border color.
Gets the border line style applied at this edge.
The border style.
Gets the themable color used to render the border.
The themable color.
Determines value equality with another border by comparing style and color.
The to compare with the current
.
Returns true if style and color match; otherwise false.
Generates a combined hash code based on style and color.
A hash code for the current .
Defines the available border line styles for cell edges in a spreadsheet.
No visible border line.
Thinnest available hairline.
Dotted line.
Dash-dot-dot pattern.
Dash-dot pattern.
Dashed line.
Thin continuous line.
Medium weight dash-dot-dot pattern.
Medium weight dash-dot pattern.
Medium weight dashed line.
Double line.
Medium weight continuous line.
Slanted dash-dot pattern.
Thick continuous line.
Per-cell formatting container (style reference plus local overrides such as borders, alignment, number format).
Initializes a new instance of the class with no styles applied.
All formatting properties are unset by default; assign borders, fill, font, alignment, or a
to define the cell appearance.
Gets or sets the referenced reusable style whose properties may be partially overridden by this format.
The cell style.
Pattern styles usable in pattern-based cell fills.
Solid (single color) fill.
75% gray pattern.
50% gray pattern.
25% gray pattern.
12% gray pattern.
6% gray pattern.
Horizontal stripe pattern.
Vertical stripe pattern.
Reverse diagonal stripe pattern (bottom‑left to top‑right).
Diagonal stripe pattern (top‑left to bottom‑right).
Diagonal crosshatch pattern (both diagonals).
Thick diagonal crosshatch pattern.
Thin horizontal stripe pattern.
Thin vertical stripe pattern.
Thin reverse diagonal stripe pattern.
Thin diagonal stripe pattern.
Thin horizontal plus vertical crosshatch pattern.
Thin diagonal crosshatch pattern.
Spreadsheet file formats supported for streaming import and export.
Open XML Workbook (XLSX) format.
Comma Separated Values (CSV) text format.
Factory for creating workbook exporters for supported spreadsheet formats (XLSX, CSV) in create or append modes.
Creates a workbook exporter for the specified format using create mode.
The document format.
The output stream.
The workbook exporter.
Creates a workbook exporter for the specified format and export mode.
The document format.
The stream.
The export mode.
The workbook exporter.
Utility for estimating rendered cell content size based on formatting so you can choose column widths that fit values without truncation.
Calculates the rendered size of cell content using its formatting so you can derive an appropriate column width for the value.
The cell value. If formula is passed the method will throw an ArgumentException.
The format of the cell.
The width of the cell in pixels. This value is only respected if the value of the WrapText property
of the spreadCellFormat is true. The default column width is 65 pixels.
The size of the cell content.
Calculates the rendered size of cell content using explicit formatting parameters, enabling custom sizing logic outside a worksheet.
The cell value. If formula is passed the method will throw an ArgumentException.
The number format of the cell.
The font family.
The size of the font in points.
A value indicating whether the text is bold.
A value indicating whether the text is italic.
The horizontal alignment.
A value indicating whether the text is wrapped.
The cell indent.
The width of the cell in pixels. This value is only respected if the value of isWrapped is true.
The default column width is 65 pixels.
The size of the cell content.