SpreadsheetAccessibility Class

Isolated, perf-safe screen-reader announcer for RadzenSpreadsheet. It binds to the worksheet Selection and, on selection change, re-renders ONLY itself (three visually hidden aria-live regions) - the virtualized cell grid is never touched, so navigation stays on the existing perf-neutral hot path.

Inheritance

Object

ComponentBase

Spreadsheet.SpreadsheetAccessibility

Implements

IComponent

IHandleEvent

IHandleAfterRender

Inherited Members

ComponentBase.OnInitialized

ComponentBase.OnInitializedAsync

ComponentBase.OnParametersSetAsync

ComponentBase.StateHasChanged

ComponentBase.ShouldRender

ComponentBase.OnAfterRender

ComponentBase.OnAfterRenderAsync

ComponentBase.InvokeAsync

ComponentBase.DispatchExceptionAsync

ComponentBase.SetParametersAsync

ComponentBase.RendererInfo

ComponentBase.Assets

ComponentBase.AssignedRenderMode

Namespace: Radzen.Blazor.Spreadsheet

Assembly: Radzen.Blazor.dll

Syntax

public class SpreadsheetAccessibility : ComponentBase, IComponent, IHandleEvent, IHandleAfterRender

Constructors

SpreadsheetAccessibilityLink to this section

Initializes a new instance of the SpreadsheetAccessibility class.

Declaration
public SpreadsheetAccessibility()

Properties

SpreadsheetLink to this section

The host spreadsheet, used to localize announcement templates.

Declaration
public ISpreadsheet Spreadsheet { get; set; }
Property Value
Type Description
ISpreadsheetThe host spreadsheet, used to localize announcement templates.

WorksheetLink to this section

The worksheet whose selection is announced.

Declaration
public Documents.Spreadsheet.Worksheet Worksheet { get; set; }
Property Value
Type Description
Documents.Spreadsheet.WorksheetThe worksheet whose selection is announced.

Methods

AnnounceActionLink to this section

Announces a transient action result (sort, filter, insert, undo) in a polite region, keeping the active cell named so context is not lost.

Declaration
public void AnnounceAction(string message)
Parameters
Type Name Description
string message

AnnounceAlertLink to this section

Announces an assertive alert (for example a validation rejection).

Declaration
public void AnnounceAlert(string message)
Parameters
Type Name Description
string message

BuildAnnouncementLink to this section

Composes the spoken description of a cell - address, content (or "blank"), header, position, merged span and state - from the model. Pure and deterministic for unit testing.

Declaration
public static string BuildAnnouncement(Documents.Spreadsheet.Worksheet worksheet, Documents.Spreadsheet.CellRef cell, Func<string, string> localize)
Parameters
Type Name Description
Documents.Spreadsheet.Worksheet worksheet The worksheet that owns the cell.
Documents.Spreadsheet.CellRef cell The active cell reference.
Func<string, string> localize Resolves a RadzenStrings key to localized text.
Returns
Type Description
string

BuildRenderTreeLink to this section

Declaration
protected override void BuildRenderTree(Rendering.RenderTreeBuilder __builder)
Parameters
Type Name Description
Rendering.RenderTreeBuilder __builder

OnParametersSetLink to this section

Declaration
protected override void OnParametersSet()
An error has occurred. This app may no longer respond until reloaded. Reload 🗙