SheetEditor Class
Represents a content editable element in a spreadsheet.
Inheritance
Object
ComponentBase
Spreadsheet.SheetEditor
Implements
IComponent
IHandleEvent
IHandleAfterRender
Inherited Members
ComponentBase.OnInitialized
ComponentBase.OnInitializedAsync
ComponentBase.OnParametersSet
ComponentBase.StateHasChanged
ComponentBase.ShouldRender
ComponentBase.OnAfterRender
ComponentBase.InvokeAsync
ComponentBase.DispatchExceptionAsync
ComponentBase.SetParametersAsync
ComponentBase.RendererInfo
ComponentBase.Assets
ComponentBase.AssignedRenderMode
Namespace: Radzen.Blazor.Spreadsheet
Assembly: Radzen.Blazor.dll
Syntax
public class SheetEditor : ComponentBase, IComponent, IHandleEvent, IHandleAfterRenderConstructors
SheetEditorlink
Represents a content editable element in a spreadsheet.
Declaration
public SheetEditor()Properties
Attributeslink
Gets or sets additional HTML attributes for the content editable element.
Declaration
public IReadOnlyDictionary<string, object> Attributes { get; set; }Property Value
| Type | Description |
|---|---|
| IReadOnlyDictionary<string, object> | Gets or sets additional HTML attributes for the content editable element. |
AutoFocuslink
Gets or sets a value indicating whether the content editable element should automatically receive focus when rendered.
Declaration
public bool AutoFocus { get; set; }Property Value
| Type | Description |
|---|---|
| bool | Gets or sets a value indicating whether the content editable element should automatically receive focus when rendered. |
Blurlink
Event callback that is invoked when the content editable element loses focus.
Declaration
public EventCallback Blur { get; set; }Property Value
| Type | Description |
|---|---|
| EventCallback | Event callback that is invoked when the content editable element loses focus. |
Focuslink
Event callback that is invoked when the content editable element gains focus.
Declaration
public EventCallback Focus { get; set; }Property Value
| Type | Description |
|---|---|
| EventCallback | Event callback that is invoked when the content editable element gains focus. |
ReadOnlylink
When true, the input is rendered as non-editable. Used by the formula bar when the host spreadsheet is read-only or has editing disabled.
Declaration
public bool ReadOnly { get; set; }Property Value
| Type | Description |
|---|---|
| bool | When true, the input is rendered as non-editable. Used by the formula bar when the host spreadsheet is read-only or has editing disabled. |
Valuelink
Gets or sets the value of the content editable element.
Declaration
public string Value { get; set; }Property Value
| Type | Description |
|---|---|
| string | Gets or sets the value of the content editable element. |
ValueChangedlink
Event callback that is invoked when the value of the content editable element changes.
Declaration
public EventCallback<string> ValueChanged { get; set; }Property Value
| Type | Description |
|---|---|
| EventCallback<string> | Event callback that is invoked when the value of the content editable element changes. |
Worksheetlink
Gets or sets the sheet associated with the content editable element.
Declaration
public Documents.Spreadsheet.Worksheet Worksheet { get; set; }Property Value
| Type | Description |
|---|---|
| Documents.Spreadsheet.Worksheet | Gets or sets the sheet associated with the content editable element. |
Methods
BuildRenderTreelink
Declaration
protected override void BuildRenderTree(Rendering.RenderTreeBuilder __builder)Parameters
| Type | Name | Description |
|---|---|---|
| Rendering.RenderTreeBuilder | __builder |
OnAfterRenderAsynclink
Declaration
protected override Task OnAfterRenderAsync(bool firstRender)Parameters
| Type | Name | Description |
|---|---|---|
| bool | firstRender |
Returns
| Type | Description |
|---|---|
| Task |
OnBlurAsynclink
Invoked by JS interop when the content editable element loses focus.
Declaration
public Task OnBlurAsync()Returns
| Type | Description |
|---|---|
| Task |
OnFocusAsynclink
Invoked by JS interop when the content editable element gains focus.
Declaration
public Task OnFocusAsync()Returns
| Type | Description |
|---|---|
| Task |
OnInputAsynclink
Invoked by JS interop when the content editable element's value changes.
Declaration
public Task OnInputAsync(string value)Parameters
| Type | Name | Description |
|---|---|---|
| string | value |
Returns
| Type | Description |
|---|---|
| Task |
OnKeyDownAsynclink
Invoked by JS interop when a key is pressed down in the content editable element.
Declaration
public Task OnKeyDownAsync(KeyboardEventArgs args)Parameters
| Type | Name | Description |
|---|---|---|
| KeyboardEventArgs | args |
Returns
| Type | Description |
|---|---|
| Task |
OnParametersSetAsynclink
Declaration
protected override Task OnParametersSetAsync()Returns
| Type | Description |
|---|---|
| Task |
OnSelectionChangeAsynclink
Invoked by JS interop when the selection in the content editable element changes.
Declaration
public Task OnSelectionChangeAsync(int caretPosition)Parameters
| Type | Name | Description |
|---|---|---|
| int | caretPosition |
Returns
| Type | Description |
|---|---|
| Task |
SetValueAsynclink
Sets the value of the content editable element asynchronously.
Declaration
public Task SetValueAsync(string value, int? moveCaretTo)Parameters
| Type | Name | Description |
|---|---|---|
| string | value | |
| int? | moveCaretTo |
Returns
| Type | Description |
|---|---|
| Task |