RadzenSpreadsheet Class

RadzenSpreadsheetlink

A spreadsheet component that allows users to view and edit workbooks. It supports features like cell selection, editing, and keyboard shortcuts. The component can display a workbook with multiple sheets and allows users to navigate through cells using keyboard shortcuts. It also supports mouse interactions for selecting and editing cells, rows, and columns.

Declaration

public RadzenSpreadsheet()

AllowAutofilllink

Allows drag-to-fill (autofill) gestures.

Declaration

public bool AllowAutofill { get; set; }

Property Value

AllowCellFormattinglink

Allows font, color, alignment, and border formatting commands.

Declaration

public bool AllowCellFormatting { get; set; }

Property Value

AllowChartslink

Allows inserting, editing, moving, resizing, and deleting charts.

Declaration

public bool AllowCharts { get; set; }

Property Value

AllowClipboardlink

Allows cut, copy, and paste through the system clipboard. Independent of ReadOnly, so view-only users can still copy unless this is set to false. Cut and paste also require AllowEditing.

Declaration

public bool AllowClipboard { get; set; }

Property Value

AllowConditionalFormattinglink

Allows adding and clearing conditional formatting rules.

Declaration

public bool AllowConditionalFormatting { get; set; }

Property Value

AllowDataValidationlink

Allows adding and clearing data-validation rules.

Declaration

public bool AllowDataValidation { get; set; }

Property Value

AllowEditinglink

Allows direct cell editing (type-to-edit, double-click, paste-into-cell, delete-key, autoaccept).

Declaration

public bool AllowEditing { get; set; }

Property Value

AllowFilteringlink

Allows filter and auto-filter commands and the filter UI affordances.

Declaration

public bool AllowFiltering { get; set; }

Property Value

AllowHyperlinkslink

Allows inserting, editing, and following hyperlinks.

Declaration

public bool AllowHyperlinks { get; set; }

Property Value

AllowImageslink

Allows inserting, moving, resizing, and deleting images.

Declaration

public bool AllowImages { get; set; }

Property Value

AllowMergelink

Allows cell merge and unmerge commands.

Declaration

public bool AllowMerge { get; set; }

Property Value

AllowResizinglink

Allows row and column resize gestures.

Declaration

public bool AllowResizing { get; set; }

Property Value

AllowSortinglink

Allows single- and multi-key sort commands.

Declaration

public bool AllowSorting { get; set; }

Property Value

AllowTableslink

Allows creating, editing, and removing structured tables.

Declaration

public bool AllowTables { get; set; }

Property Value

AllowUndoRedolink

Allows undo and redo of previously executed commands.

Declaration

public bool AllowUndoRedo { get; set; }

Property Value

CanRedolink

Declaration

public bool CanRedo { get; }

Property Value

CanUndolink

Declaration

public bool CanUndo { get; }

Property Value

CellTypeslink

Gets or sets the custom cell type definitions. Maps cell type names to their renderer and editor component types.

Declaration

public Dictionary<string, Spreadsheet.SpreadsheetCellType> CellTypes { get; set; }

Property Value

ChildContentlink

Replaces the built-in toolsets. When set, the supplied content sits inside the toolbar's Tabs slot — each child should be a RadzenTabsItem. Add RadzenSpreadsheetTableDesignToolset to keep the contextual "Table Design" toolset.

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

CommandExecutinglink

Fires before a command is pushed onto the undo stack. Call PreventDefault from the handler to veto the command. Fires after ReadOnly, the matching Allow* flag, and the sheet's Protection have already approved the command.

Declaration

public EventCallback<Spreadsheet.SpreadsheetCommandEventArgs> CommandExecuting { get; set; }

Property Value

CsvExportOptionslink

Options applied when the user exports the workbook as CSV. When null, defaults are used (comma separator, UTF-8 with BOM, CRLF line endings, RFC 4180 minimal quoting, active sheet only).

Declaration

public Documents.Spreadsheet.CsvExportOptions CsvExportOptions { get; set; }

Property Value

CsvImportOptionslink

Options applied when the user opens a CSV file. When null, defaults are used (comma separator, UTF-8, value and formula auto-detection on).

Declaration

public Documents.Spreadsheet.CsvImportOptions CsvImportOptions { get; set; }

Property Value

ExportFileNamelink

The name of the file to export the workbook to when using the export functionality. When the user picks "Save as CSV" the extension is replaced with .csv.

Declaration

public string ExportFileName { get; set; }

Property Value

ReadOnlylink

When true, the spreadsheet rejects every command that mutates the workbook. The user can still select cells, scroll, and copy. Defaults to false.

Declaration

public bool ReadOnly { get; set; }

Property Value

SelectedToolsetIndexlink

The index of the active toolset in the toolbar. Defaults to 1 so the Home toolset is shown first. Supports two-way binding via @bind-SelectedToolsetIndex.

Declaration

public int SelectedToolsetIndex { get; set; }

Property Value

SelectedToolsetIndexChangedlink

Fired when the active toolset changes. Used by @bind-SelectedToolsetIndex.

Declaration

public EventCallback<int> SelectedToolsetIndexChanged { get; set; }

Property Value

ShowFormulaBarlink

When true (the default) the formula bar is rendered between the toolbar and the grid.

Declaration

public bool ShowFormulaBar { get; set; }

Property Value

ShowSheetTabslink

When true (the default) the sheet tab strip is rendered below the grid.

Declaration

public bool ShowSheetTabs { get; set; }

Property Value

ShowToolbarlink

When true (the default) the toolbar is rendered above the grid. Set to false for kiosk or view-only embeds.

Declaration

public bool ShowToolbar { get; set; }

Property Value

Workbooklink

The workbook to display in the spreadsheet.

Declaration

public Documents.Spreadsheet.Workbook Workbook { get; set; }

Property Value

WorkbookChangedlink

Event callback that is invoked when the workbook changes.

Declaration

public EventCallback<Documents.Spreadsheet.Workbook> WorkbookChanged { get; set; }

Property Value

AcceptAsynclink

Accepts the current edit in the spreadsheet.

Declaration

public Task<bool> AcceptAsync()

Returns

BuildRenderTreelink

Declaration

protected override void BuildRenderTree(Rendering.RenderTreeBuilder __builder)

Parameters

ExecuteAsynclink

Declaration

public Task<bool> ExecuteAsync(Spreadsheet.ICommand command)

Parameters

Returns

GetComponentCssClasslink

Declaration

protected override string GetComponentCssClass()

Returns

IsFeatureAllowedlink

Returns true when the given feature is enabled. ReadOnly forces every feature off except Clipboard, which stays governed solely by AllowClipboard so view-only users can still copy data unless the host explicitly opts out.

Declaration

public bool IsFeatureAllowed(Spreadsheet.SpreadsheetFeature feature)

Parameters

Returns

LoadWorkbookAsynclink

Declaration

public Task LoadWorkbookAsync(Documents.Spreadsheet.Workbook workbook)

Parameters

Returns

OnAfterRenderAsynclink

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Returns

OnAutofillPointerDownAsynclink

Invoked by JS interop when the autofill handle is pressed.

Declaration

public void OnAutofillPointerDownAsync(PointerEventArgs args)

Parameters

OnAutofillPointerMoveAsynclink

Invoked by JS interop when the pointer moves during an autofill drag.

Declaration

public void OnAutofillPointerMoveAsync(PointerEventArgs args)

Parameters

OnAutofillPointerUpAsynclink

Invoked by JS interop when the pointer is released after an autofill drag.

Declaration

public Task OnAutofillPointerUpAsync(PointerEventArgs args)

Parameters

Returns

OnCellContextMenuAsynclink

Invoked by JS interop when a cell is right-clicked.

Declaration

public Task OnCellContextMenuAsync(Spreadsheet.CellEventArgs args)

Parameters

Returns

OnCellDoubleClickAsynclink

Invoked by JS interop when a cell is double-clicked with the pointer.

Declaration

public Task OnCellDoubleClickAsync(Spreadsheet.CellEventArgs args)

Parameters

Returns

OnCellPointerDownAsynclink

Invoked by JS interop when a cell is clicked with the pointer.

Declaration

public Task<bool> OnCellPointerDownAsync(Spreadsheet.CellEventArgs args)

Parameters

Returns

OnCellPointerMoveAsynclink

Invoked by JS interop when the pointer moves over a cell.

Declaration

public Task OnCellPointerMoveAsync(PointerEventArgs args)

Parameters

Returns

OnColumnContextMenuAsynclink

Invoked by JS interop when a column header is right-clicked.

Declaration

public Task OnColumnContextMenuAsync(Spreadsheet.CellEventArgs args)

Parameters

Returns

OnColumnPointerDownAsynclink

Invoked by JS interop when a column header is clicked with the pointer.

Declaration

public Task<bool> OnColumnPointerDownAsync(Spreadsheet.CellEventArgs args)

Parameters

Returns

OnColumnPointerMoveAsynclink

Invoked by JS interop when the pointer moves over a column header.

Declaration

public Task OnColumnPointerMoveAsync(PointerEventArgs args)

Parameters

Returns

OnColumnResizePointerDownAsynclink

Invoked by JS interop when the column resize handle is pressed.

Declaration

public Task<bool> OnColumnResizePointerDownAsync(Spreadsheet.CellEventArgs args)

Parameters

Returns

OnColumnResizePointerMoveAsynclink

Invoked by JS interop when the pointer moves while resizing a column.

Declaration

public Task OnColumnResizePointerMoveAsync(PointerEventArgs args)

Parameters

Returns

OnColumnResizePointerUpAsynclink

Invoked by JS interop when the pointer is released after resizing a column.

Declaration

public Task OnColumnResizePointerUpAsync(PointerEventArgs args)

Parameters

Returns

OnCopyAsynclink

Invoked by JS interop to copy the current selection to the clipboard.

Declaration

public Task OnCopyAsync()

Returns

OnDrawingMovePointerDownAsynclink

Invoked by JS interop when a drawing body is pressed to start a move.

Declaration

public Task OnDrawingMovePointerDownAsync(PointerEventArgs args)

Parameters

Returns

OnDrawingMovePointerMoveAsynclink

Invoked by JS interop when the pointer moves while dragging a drawing.

Declaration

public Task OnDrawingMovePointerMoveAsync(PointerEventArgs args)

Parameters

Returns

OnDrawingMovePointerUpAsynclink

Invoked by JS interop when the pointer is released after moving a drawing.

Declaration

public Task OnDrawingMovePointerUpAsync(PointerEventArgs args)

Parameters

Returns

OnDrawingResizePointerDownAsynclink

Invoked by JS interop when a drawing resize handle is pressed.

Declaration

public Task<bool> OnDrawingResizePointerDownAsync(Spreadsheet.ImageResizeEventArgs args)

Parameters

Returns

OnDrawingResizePointerMoveAsynclink

Invoked by JS interop when the pointer moves while resizing a drawing.

Declaration

public Task OnDrawingResizePointerMoveAsync(PointerEventArgs args)

Parameters

Returns

OnDrawingResizePointerUpAsynclink

Invoked by JS interop when the pointer is released after resizing a drawing.

Declaration

public Task OnDrawingResizePointerUpAsync(PointerEventArgs args)

Parameters

Returns

OnInitializedlink

Declaration

protected override void OnInitialized()

OnKeyDownAsynclink

Invoked by JS interop when a key is pressed down.

Declaration

public Task OnKeyDownAsync(KeyboardEventArgs args)

Parameters

Returns

OnPasteAsynclink

Invoked by JS interop to paste text from the clipboard into the current selection.

Declaration

public Task OnPasteAsync(string text)

Parameters

Returns

OnRowContextMenuAsynclink

Invoked by JS interop when a row header is right-clicked.

Declaration

public Task OnRowContextMenuAsync(Spreadsheet.CellEventArgs args)

Parameters

Returns

OnRowPointerDownAsynclink

Invoked by JS interop when a row header is clicked with the pointer.

Declaration

public Task<bool> OnRowPointerDownAsync(Spreadsheet.CellEventArgs args)

Parameters

Returns

OnRowPointerMoveAsynclink

Invoked by JS interop when the pointer moves over a row header.

Declaration

public Task OnRowPointerMoveAsync(PointerEventArgs args)

Parameters

Returns

OnRowResizePointerDownAsynclink

Invoked by JS interop when the row resize handle is pressed.

Declaration

public Task<bool> OnRowResizePointerDownAsync(Spreadsheet.CellEventArgs args)

Parameters

Returns

OnRowResizePointerMoveAsynclink

Invoked by JS interop when the pointer moves while resizing a row.

Declaration

public Task OnRowResizePointerMoveAsync(PointerEventArgs args)

Parameters

Returns

OnRowResizePointerUpAsynclink

Invoked by JS interop when the pointer is released after resizing a row.

Declaration

public Task OnRowResizePointerUpAsync(PointerEventArgs args)

Parameters

Returns

OnSelectionPointerUpAsynclink

Invoked by JS interop when the user releases the pointer after a cell, row, or column selection gesture. Fires RangeFinalized so subscribers (such as the range picker) can commit the user's pick.

Declaration

public Task OnSelectionPointerUpAsync()

Returns

Redolink

Declaration

public void Redo()

ScrollToAsynclink

Scrolls the spreadsheet to the specified cell address.

Declaration

public Task ScrollToAsync(Documents.Spreadsheet.CellRef address)

Parameters

Returns

SetParametersAsynclink

Declaration

public override Task SetParametersAsync(ParameterView parameters)

Parameters

Returns

Undolink

Declaration

public void Undo()