HeaderBase Class
Base class for row and column header components. Manages selection state tracking, event subscription lifecycle, and CSS class generation. Subclasses provide the axis-specific index, address creation, and CSS class name.
Inheritance
Object
ComponentBase
Spreadsheet.HeaderBase
Implements
IComponent
IHandleEvent
IHandleAfterRender
Inherited Members
Spreadsheet.CellBase.AppendStyle
Spreadsheet.CellBase.FrozenState
ComponentBase.BuildRenderTree
ComponentBase.OnInitializedAsync
ComponentBase.OnParametersSet
ComponentBase.OnParametersSetAsync
ComponentBase.StateHasChanged
ComponentBase.ShouldRender
ComponentBase.OnAfterRender
ComponentBase.OnAfterRenderAsync
ComponentBase.InvokeAsync
ComponentBase.DispatchExceptionAsync
ComponentBase.RendererInfo
ComponentBase.Assets
ComponentBase.AssignedRenderMode
Namespace: Radzen.Blazor.Spreadsheet
Assembly: Radzen.Blazor.dll
Syntax
public abstract class HeaderBase : Spreadsheet.CellBase, IComponent, IHandleEvent, IHandleAfterRenderConstructors
HeaderBaselink
Initializes a new instance of the HeaderBase class.
Declaration
protected HeaderBase()Properties
Activelink
Gets whether the header is in the active selection range.
Declaration
protected bool Active { get; }Property Value
| Type | Description |
|---|---|
| bool | Gets whether the header is in the active selection range. |
Indexlink
Gets the axis index (row or column) for this header.
Declaration
protected int Index { get; }Property Value
| Type | Description |
|---|---|
| int | Gets the axis index (row or column) for this header. |
IndexParameterNamelink
Gets the parameter name to watch for changes (e.g. "Row" or "Column").
Declaration
protected string IndexParameterName { get; }Property Value
| Type | Description |
|---|---|
| string | Gets the parameter name to watch for changes (e.g. "Row" or "Column"). |
Selectedlink
Gets whether the header's entire row/column is selected.
Declaration
protected bool Selected { get; }Property Value
| Type | Description |
|---|---|
| bool | Gets whether the header's entire row/column is selected. |
Worksheetlink
Gets or sets the worksheet that contains this header.
Declaration
public Documents.Spreadsheet.Worksheet Worksheet { get; set; }Property Value
| Type | Description |
|---|---|
| Documents.Spreadsheet.Worksheet | Gets or sets the worksheet that contains this header. |
Methods
CheckIsActivelink
Returns whether the selection is active for this header's axis position. Called only after validating that selection is non-null.
Declaration
protected abstract bool CheckIsActive(Documents.Spreadsheet.Selection selection)Parameters
| Type | Name | Description |
|---|---|---|
| Documents.Spreadsheet.Selection | selection |
Returns
| Type | Description |
|---|---|
| bool |
CheckIsSelectedlink
Returns whether the selection covers this header's entire row/column. Called only after validating that selection is non-null.
Declaration
protected abstract bool CheckIsSelected(Documents.Spreadsheet.Selection selection)Parameters
| Type | Name | Description |
|---|---|---|
| Documents.Spreadsheet.Selection | selection |
Returns
| Type | Description |
|---|---|
| bool |
SetParametersAsynclink
Declaration
public override Task SetParametersAsync(ParameterView parameters)Parameters
| Type | Name | Description |
|---|---|---|
| ParameterView | parameters |
Returns
| Type | Description |
|---|---|
| Task |