Demos Star Radzen Blazor Components on GitHub

Worksheet Class

Represents a sheet in a spreadsheet.

Inheritance

Object

Documents.Spreadsheet.Worksheet

Namespace: Radzen.Documents.Spreadsheet

Assembly: Radzen.Blazor.dll

Syntax

public class Worksheet

Constructors

WorksheetLink to this section

Initializes a new instance of the Worksheet class with the specified number of rows and columns.

Declaration
public Worksheet(int rows, int columns)
Parameters
Type Name Description
int rows
int columns

Properties

AutoFilterLink to this section

Gets the auto filter for this sheet. Always non-null. Set its Range property to enable or disable.

Declaration
public Documents.Spreadsheet.AutoFilter AutoFilter { get; }
Property Value
Type Description
Documents.Spreadsheet.AutoFilterGets the auto filter for this sheet. Always non-null. Set its Range property to enable or disable.

CellsLink to this section

Gets the collection of cells in the sheet.

Declaration
public Documents.Spreadsheet.CellStore Cells { get; set; }
Property Value
Type Description
Documents.Spreadsheet.CellStoreGets the collection of cells in the sheet.

ChartsLink to this section

Gets the list of charts associated with the sheet.

Declaration
public IReadOnlyList<Documents.Spreadsheet.SheetChart> Charts { get; }
Property Value
Type Description
IReadOnlyList<Documents.Spreadsheet.SheetChart>Gets the list of charts associated with the sheet.

ColumnCountLink to this section

Gets the number of columns in the sheet.

Declaration
public int ColumnCount { get; }
Property Value
Type Description
intGets the number of columns in the sheet.

ColumnsLink to this section

Gets the column axis for the sheet, which defines the properties of the columns.

Declaration
public Documents.Spreadsheet.Axis Columns { get; }
Property Value
Type Description
Documents.Spreadsheet.AxisGets the column axis for the sheet, which defines the properties of the columns.

ConditionalFormatsLink to this section

Gets the conditional formatting store for the sheet.

Declaration
public Documents.Spreadsheet.ConditionalFormatStore ConditionalFormats { get; }
Property Value
Type Description
Documents.Spreadsheet.ConditionalFormatStoreGets the conditional formatting store for the sheet.

FiltersLink to this section

Gets the list of filters applied to the sheet.

Declaration
public IReadOnlyList<Documents.Spreadsheet.SheetFilter> Filters { get; }
Property Value
Type Description
IReadOnlyList<Documents.Spreadsheet.SheetFilter>Gets the list of filters applied to the sheet.

FunctionRegistryLink to this section

Gets the registry of formula functions available in the sheet.

Declaration
public Documents.Spreadsheet.FunctionStore FunctionRegistry { get; }
Property Value
Type Description
Documents.Spreadsheet.FunctionStoreGets the registry of formula functions available in the sheet.

ImagesLink to this section

Gets the list of images associated with the sheet.

Declaration
public IReadOnlyList<Documents.Spreadsheet.SheetImage> Images { get; }
Property Value
Type Description
IReadOnlyList<Documents.Spreadsheet.SheetImage>Gets the list of images associated with the sheet.

MergedCellsLink to this section

Gets the store for merged cells in the sheet, which manages cell merging and unmerging.

Declaration
public Documents.Spreadsheet.MergedCellStore MergedCells { get; }
Property Value
Type Description
Documents.Spreadsheet.MergedCellStoreGets the store for merged cells in the sheet, which manages cell merging and unmerging.

NameLink to this section

Gets the name of the sheet.

Declaration
public string Name { get; set; }
Property Value
Type Description
stringGets the name of the sheet.

ProtectionLink to this section

Gets or sets the sheet protection settings.

Declaration
public Documents.Spreadsheet.SheetProtection Protection { get; set; }
Property Value
Type Description
Documents.Spreadsheet.SheetProtectionGets or sets the sheet protection settings.

RowCountLink to this section

Gets the number of rows in the sheet.

Declaration
public int RowCount { get; }
Property Value
Type Description
intGets the number of rows in the sheet.

RowsLink to this section

Gets the row axis for the sheet, which defines the properties of the rows.

Declaration
public Documents.Spreadsheet.Axis Rows { get; }
Property Value
Type Description
Documents.Spreadsheet.AxisGets the row axis for the sheet, which defines the properties of the rows.

SelectedChartLink to this section

Gets or sets the currently selected chart.

Declaration
public Documents.Spreadsheet.SheetChart SelectedChart { get; set; }
Property Value
Type Description
Documents.Spreadsheet.SheetChartGets or sets the currently selected chart.

SelectedImageLink to this section

Gets or sets the currently selected image.

Declaration
public Documents.Spreadsheet.SheetImage SelectedImage { get; set; }
Property Value
Type Description
Documents.Spreadsheet.SheetImageGets or sets the currently selected image.

SelectionLink to this section

Gets the selection object that manages the selected cells in the sheet.

Declaration
public Documents.Spreadsheet.Selection Selection { get; }
Property Value
Type Description
Documents.Spreadsheet.SelectionGets the selection object that manages the selected cells in the sheet.

TablesLink to this section

Gets the list of tables associated with the sheet.

Declaration
public IReadOnlyList<Documents.Spreadsheet.Table> Tables { get; }
Property Value
Type Description
IReadOnlyList<Documents.Spreadsheet.Table>Gets the list of tables associated with the sheet.

ValidationLink to this section

Gets the validation store for the sheet, which manages data validation rules and errors.

Declaration
public Documents.Spreadsheet.ValidationStore Validation { get; }
Property Value
Type Description
Documents.Spreadsheet.ValidationStoreGets the validation store for the sheet, which manages data validation rules and errors.

WorkbookLink to this section

Gets the workbook that contains this sheet.

Declaration
public Documents.Spreadsheet.Workbook Workbook { get; }
Property Value
Type Description
Documents.Spreadsheet.WorkbookGets the workbook that contains this sheet.

Methods

AddChartLink to this section

Adds a chart to the sheet.

Declaration
public void AddChart(Documents.Spreadsheet.SheetChart chart)
Parameters
Type Name Description
Documents.Spreadsheet.SheetChart chart

AddFilterLink to this section

Adds a filter to the sheet.

Declaration
public void AddFilter(Documents.Spreadsheet.SheetFilter filter)
Parameters
Type Name Description
Documents.Spreadsheet.SheetFilter filter

AddTableLink to this section

Adds a table to the sheet.

Declaration
public Documents.Spreadsheet.Table AddTable(string name, Documents.Spreadsheet.RangeRef range, bool hasHeaders, bool totalsRowShown)
Parameters
Type Name Description
string name Unique table name (used in structured references like =SUM(Sales[Amount])).
Documents.Spreadsheet.RangeRef range The cell range covered by the table.
bool hasHeaders When true, the first row of range is treated as the header row.
bool totalsRowShown When true, the last row of range is treated as the totals row. Used by the XLSX reader; new tables typically toggle this via ShowTotals.
Returns
Type Description
Documents.Spreadsheet.TableThe created Table.

BatchLink to this section

Runs action inside a single update batch: formula evaluation is suspended for the duration and runs once afterwards, even if action throws. Nests safely with other batches and direct Begin/EndUpdate calls.

Declaration
public void Batch(Action action)
Parameters
Type Name Description
Action action

BatchLink to this section

Runs action inside a single update batch: formula evaluation is suspended for the duration and runs once afterwards, even if action throws. Nests safely with other batches and direct Begin/EndUpdate calls.

Declaration
public Documents.Spreadsheet.T Batch(Func<Documents.Spreadsheet.T> func)
Parameters
Type Name Description
Func<Documents.Spreadsheet.T> func
Returns
Type Description
Documents.Spreadsheet.T

BeginUpdateLink to this section

Begins an update operation on the sheet, suspending formula evaluation until the matching EndUpdate. Calls nest: evaluation resumes only when the outermost EndUpdate runs.

Declaration
public void BeginUpdate()

ClearFiltersLink to this section

Clears all filters and shows all rows.

Declaration
public void ClearFilters()

DeleteColumnLink to this section

Deletes the specified column and shifts cells left. Updates formulas and decreases column count.

Declaration
public void DeleteColumn(int columnIndex)
Parameters
Type Name Description
int columnIndex

DeleteRowLink to this section

Deletes the specified row and shifts cells up. Updates formulas and decreases row count.

Declaration
public void DeleteRow(int rowIndex)
Parameters
Type Name Description
int rowIndex

EndUpdateLink to this section

Ends an update operation. When this balances the outermost BeginUpdate, all formulas are re-evaluated once and pending changes are flushed. An unmatched call (no open update) is a no-op.

Declaration
public void EndUpdate()

GetFilterLink to this section

Retrieves a filter for the specified range.

Declaration
public Documents.Spreadsheet.SheetFilter GetFilter(Documents.Spreadsheet.RangeRef range)
Parameters
Type Name Description
Documents.Spreadsheet.RangeRef range
Returns

GetTableContainingLink to this section

Gets the table containing the cell at the given row/column, or null if none.

Declaration
public Documents.Spreadsheet.Table GetTableContaining(int row, int column)
Parameters
Type Name Description
int row
int column
Returns

InsertColumnLink to this section

Inserts one or more columns at the specified index and shifts existing cells right. Updates formulas and increases column count.

Declaration
public void InsertColumn(int columnIndex, int count)
Parameters
Type Name Description
int columnIndex
int count

InsertRowLink to this section

Inserts one or more rows at the specified index and shifts existing cells down. Updates formulas and increases row count.

Declaration
public void InsertRow(int rowIndex, int count)
Parameters
Type Name Description
int rowIndex
int count

IsCellEditableLink to this section

Returns true if the cell at the given address is editable (either protection is off or the cell is unlocked).

Declaration
public bool IsCellEditable(Documents.Spreadsheet.CellRef address)
Parameters
Type Name Description
Documents.Spreadsheet.CellRef address
Returns
Type Description
bool

IsRangeEditableLink to this section

Checks if all cells in the specified range are editable.

Declaration
public bool IsRangeEditable(Documents.Spreadsheet.RangeRef range)
Parameters
Type Name Description
Documents.Spreadsheet.RangeRef range The range of cells to validate.
Returns
Type Description
booltrue if the entire range can be modified; otherwise, false.

RemoveChartLink to this section

Removes a chart from the sheet.

Declaration
public bool RemoveChart(Documents.Spreadsheet.SheetChart chart)
Parameters
Type Name Description
Documents.Spreadsheet.SheetChart chart
Returns
Type Description
bool

RemoveFilterLink to this section

Removes a specific filter from the sheet.

Declaration
public bool RemoveFilter(Documents.Spreadsheet.SheetFilter filter)
Parameters
Type Name Description
Documents.Spreadsheet.SheetFilter filter The filter to remove.
Returns
Type Description
boolTrue if the filter was found and removed; otherwise, false.

RemoveFilterAtLink to this section

Removes a filter from the sheet at the specified index.

Declaration
public void RemoveFilterAt(int index)
Parameters
Type Name Description
int index The index of the filter to remove.

RemoveTableLink to this section

Removes a table abstraction. Cell content is left in place.

Declaration
public bool RemoveTable(Documents.Spreadsheet.Table table)
Parameters
Type Name Description
Documents.Spreadsheet.Table table
Returns
Type Description
bool

SortLink to this section

Sorts the specified range using the given sort levels. Column indices in keys are relative to the range's left edge. Stable: rows with equal keys keep their input order.

Declaration
public void Sort(Documents.Spreadsheet.RangeRef range, Documents.Spreadsheet.SortKey[] keys)
Parameters
Type Name Description
Documents.Spreadsheet.RangeRef range
Documents.Spreadsheet.SortKey[] keys

SortLink to this section

Sorts the specified range using the given sort levels. Column indices in keys are relative to the range's left edge. Stable: rows with equal keys keep their input order.

Declaration
public void Sort(Documents.Spreadsheet.RangeRef range, SortOrder order, int keyIndex)
Parameters
Type Name Description
Documents.Spreadsheet.RangeRef range
SortOrder order
int keyIndex

Events

ChromeChangedLink to this section

Raised when sheet chrome (table styling, custom cell types, validation, auto filter) changes and dependent cell views must refresh.

Declaration
public event Action ChromeChanged
An error has occurred. This app may no longer respond until reloaded. Reload 🗙