TelerikSpreadsheet
A component that enables you to create and edit spreadsheet-like workbooks with sheets, cells, and formulas. Supports toolsets for formatting and commands, file open/download workflows, context menus, dialogs, and localization.
Definition
Namespace:Telerik.Blazor.Components
Assembly:Telerik.Blazor.dll
Syntax:
public class TelerikSpreadsheet : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposableInheritance: objectComponentBaseBaseComponentTelerikSpreadsheet
Implements:
Inherited Members
Constructors
public TelerikSpreadsheet()Methods
protected override void BuildRenderTree(RenderTreeBuilder __builder)Overrides:
public override void Dispose()Overrides:
Updates the component and processes the latest file data.
public void Rebind()Refreshes the component.
public void Refresh()Properties
Sets the height of the column headers in pixels. Example: ColumnHeaderHeight = 24.
[Parameter]
public double ColumnHeaderHeight { get; set; }Sets the number of columns in each sheet. Example: ColumnsCount = 100. Increasing this value may impact performance for very large sheets.
[Parameter]
public int ColumnsCount { get; set; }Sets the default width of columns in pixels. Example: ColumnWidth = 80. Changing this affects all columns unless overridden per column.
[Parameter]
public double ColumnWidth { get; set; }Provides the file data to load into the Spreadsheet. Set this to a valid Excel file byte array to open a file programmatically. Example: Data = myFileBytes.
[Parameter]
public byte[] Data { get; set; }Shows a loading indicator during long-running operations, such as file import or export. Set to false to disable the loader. Example: EnableLoaderContainer = false.
[Parameter]
public bool EnableLoaderContainer { get; set; }Sets the height of the Spreadsheet component. Accepts CSS values such as "600px" or "100%". Example: Height = "400px".
[Parameter]
public string Height { get; set; }Fires when a file is downloaded from the Spreadsheet. Use to handle custom logic after file export. Example: OnDownload = EventCallback.Factory.Create(this, OnSpreadsheetDownload).
[Parameter]
public EventCallback<SpreadsheetDownloadEventArgs> OnDownload { get; set; }Fires when a file is opened in the Spreadsheet. Use to handle custom logic after file load. Example: OnOpen = EventCallback.Factory.Create(this, OnSpreadsheetOpen).
[Parameter]
public EventCallback<SpreadsheetOpenEventArgs> OnOpen { get; set; }Sets the width of the row headers in pixels. Example: RowHeaderWidth = 40.
[Parameter]
public double RowHeaderWidth { get; set; }Sets the default height of rows in pixels. Example: RowHeight = 24. Required for some features such as virtual scrolling.
[Parameter]
public double RowHeight { get; set; }Sets the number of rows in each sheet. Example: RowsCount = 500. Large values may affect performance.
[Parameter]
public int RowsCount { get; set; }Provides configuration for WebMCP tools, such as a Name to distinguish this Spreadsheet from others on the same page.
[Parameter]
public RenderFragment SpreadsheetSettings { get; set; }Configures the visible toolbars and tools in the Spreadsheet. Use All for all tools or customize with a SpreadsheetToolSet. Example: Tools = SpreadsheetToolSets.All.
[Parameter]
public SpreadsheetToolSet Tools { get; set; }