Class
TelerikSpreadsheet

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

cs-api-definition

public class TelerikSpreadsheet : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentTelerikSpreadsheet

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members BaseComponent.ShouldRender()BaseComponent.OnInitializedAsync()BaseComponent.InitLocalizer()BaseComponent.ThrowIfParameterIsNull(object, string)BaseComponent.HaveOptionsChanged(IDictionary<string, object>, IDictionary<string, object>)BaseComponent.GetClassString(params string[])BaseComponent.InvokeAsync<T>(string, params object[])BaseComponent.InvokeAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidAsync(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidComponentMethodAsync(string, params object[])BaseComponent.InvokeComponentVoidMethodAsync(string, object)BaseComponent.InvokeDisposeAsync()BaseComponent.StateHasChanged()BaseComponent.RootComponentBaseComponent.ClassComponentBase.OnInitialized()ComponentBase.OnParametersSet()ComponentBase.OnAfterRender(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.SetParametersAsync(ParameterView)

Constructors

TelerikSpreadsheet()

Declaration

cs-api-definition

public TelerikSpreadsheet()

Properties

ColumnHeaderHeight

Defines the column header height.

Declaration

cs-api-definition

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

Property Value

double

ColumnWidth

Defines the column width.

Declaration

cs-api-definition

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

Property Value

double

ColumnsCount

Defines the columns count for a sheet.

Declaration

cs-api-definition

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

Property Value

int

Data

Specifies the file data of the component.

Declaration

cs-api-definition

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

Property Value

byte[]

EnableLoaderContainer

Defines whether the loading container should be shown when there are long-running operations.

Declaration

cs-api-definition

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

Property Value

bool

Height

Defines the height of the component.

Declaration

cs-api-definition

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

Property Value

string

OnDownload

Triggered when a file is downloaded.

Declaration

cs-api-definition

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

Property Value

EventCallback<SpreadsheetDownloadEventArgs>

OnOpen

Triggered when a file is opened.

Declaration

cs-api-definition

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

Property Value

EventCallback<SpreadsheetOpenEventArgs>

RowHeaderWidth

Defines the row header width.

Declaration

cs-api-definition

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

Property Value

double

RowHeight

Defines the row width.

Declaration

cs-api-definition

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

Property Value

double

RowsCount

Defines the rows count for a sheet.

Declaration

cs-api-definition

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

Property Value

int

Tools

Defines the default Tools collection.

Declaration

cs-api-definition

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

Property Value

SpreadsheetToolSet

Width

Defines the width of the component.

Declaration

cs-api-definition

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

Property Value

string

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

cs-api-definition

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose()

Declaration

cs-api-definition

public override void Dispose()

Overrides BaseComponent.Dispose()

ExportToExcelAsync()

Exports the Spreadsheet to raw data.

Declaration

cs-api-definition

public Task<byte[]> ExportToExcelAsync()

Returns

Task<byte[]>

InitJsComponentAsync()

Declaration

cs-api-definition

protected Task InitJsComponentAsync()

Returns

Task

OnAfterRenderAsync(bool)

Declaration

cs-api-definition

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender

bool

Returns

Task

Overrides BaseComponent.OnAfterRenderAsync(bool)

OnParametersSetAsync()

Declaration

cs-api-definition

protected override Task OnParametersSetAsync()

Returns

Task

Overrides ComponentBase.OnParametersSetAsync()

Rebind()

Updates the component and processes the latest file data.

Declaration

cs-api-definition

public void Rebind()

Refresh()

Refreshes the component.

Declaration

cs-api-definition

public void Refresh()

ClassTelerikSpreadsheet

Class
TelerikSpreadsheet