Class

TelerikSpreadsheet

Declaration

public TelerikSpreadsheet()

Sets the height of the column headers in pixels. Example: ColumnHeaderHeight = 24.

Declaration

[Parameter]
public double ColumnHeaderHeight { get; set; }

Property Value

Sets the default width of columns in pixels. Example: ColumnWidth = 80. Changing this affects all columns unless overridden per column.

Declaration

[Parameter]
public double ColumnWidth { get; set; }

Property Value

Sets the number of columns in each sheet. Example: ColumnsCount = 100. Increasing this value may impact performance for very large sheets.

Declaration

[Parameter]
public int ColumnsCount { get; set; }

Property Value

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.

Declaration

[Parameter]
public byte[] Data { get; set; }

Property Value

Shows a loading indicator during long-running operations, such as file import or export. Set to false to disable the loader. Example: EnableLoaderContainer = false.

Declaration

[Parameter]
public bool EnableLoaderContainer { get; set; }

Property Value

Enables the registration of WebMCP tools for this Spreadsheet instance. When set to true, Spreadsheet operations are exposed as tools discoverable by AI models through the browser. Default value is false.

Declaration

[Parameter]
public bool EnableWebMcpTools { get; set; }

Property Value

Sets the height of the Spreadsheet component. Accepts CSS values such as "600px" or "100%". Example: Height = "400px".

Declaration

[Parameter]
public string Height { get; set; }

Property Value

Fires when a file is downloaded from the Spreadsheet. Use to handle custom logic after file export. Example: OnDownload = EventCallback.Factory.Create(this, OnSpreadsheetDownload).

Declaration

[Parameter]
public EventCallback<SpreadsheetDownloadEventArgs> OnDownload { get; set; }

Property Value

Fires when a file is opened in the Spreadsheet. Use to handle custom logic after file load. Example: OnOpen = EventCallback.Factory.Create(this, OnSpreadsheetOpen).

Declaration

[Parameter]
public EventCallback<SpreadsheetOpenEventArgs> OnOpen { get; set; }

Property Value

Sets the width of the row headers in pixels. Example: RowHeaderWidth = 40.

Declaration

[Parameter]
public double RowHeaderWidth { get; set; }

Property Value

Sets the default height of rows in pixels. Example: RowHeight = 24. Required for some features such as virtual scrolling.

Declaration

[Parameter]
public double RowHeight { get; set; }

Property Value

Sets the number of rows in each sheet. Example: RowsCount = 500. Large values may affect performance.

Declaration

[Parameter]
public int RowsCount { get; set; }

Property Value

Provides configuration for WebMCP tools, such as a Name to distinguish this Spreadsheet from others on the same page.

Declaration

[Parameter]
public RenderFragment SpreadsheetSettings { get; set; }

Property Value

Configures the visible toolbars and tools in the Spreadsheet. Use All for all tools or customize with a SpreadsheetToolSet. Example: Tools = SpreadsheetToolSets.All.

Declaration

[Parameter]
public SpreadsheetToolSet Tools { get; set; }

Property Value

Sets the width of the Spreadsheet component. Accepts CSS values like "800px" or "100%". Example: Width = "100%".

Declaration

[Parameter]
public string Width { get; set; }

Property Value

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

Declaration

public override void Dispose()

Overrides BaseComponent.Dispose()

Exports the Spreadsheet to raw data.

Declaration

public Task<byte[]> ExportToExcelAsync()

Returns

Declaration

protected Task InitJsComponentAsync()

Returns

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Returns

Overrides BaseComponent.OnAfterRenderAsync(bool)

Declaration

protected override Task OnParametersSetAsync()

Returns

Overrides ComponentBase.OnParametersSetAsync()

Updates the component and processes the latest file data.

Declaration

public void Rebind()

Refreshes the component.

Declaration

public void Refresh()