ISpreadsheet Interface

Exposes some of the methods of the RadzenSpreadsheet component.

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public interface ISpreadsheet

Properties

CanRedolink

Gets whether there is a command to redo.

Declaration
public bool CanRedo { get; }
Property Value
Type Description
boolGets whether there is a command to redo.

CanUndolink

Gets whether there is a command to undo.

Declaration
public bool CanUndo { get; }
Property Value
Type Description
boolGets whether there is a command to undo.

ReadOnlylink

Gets whether the spreadsheet is in read-only mode. When true, every mutation is rejected regardless of per-feature Allow* flags.

Declaration
public bool ReadOnly { get; }
Property Value
Type Description
boolGets whether the spreadsheet is in read-only mode. When true, every mutation is rejected regardless of per-feature Allow* flags.

UICulturelink

Gets the UI culture used for localized strings. Defaults to CurrentUICulture.

Declaration
public Globalization.CultureInfo UICulture { get; }
Property Value
Type Description
Globalization.CultureInfoGets the UI culture used for localized strings. Defaults to CurrentUICulture.

Methods

AcceptAsynclink

Accepts the current edit in the spreadsheet.

Declaration
public abstract Task<bool> AcceptAsync()
Returns
Type Description
Task<bool>

ExecuteAsynclink

Executes a command through the active view's undo/redo stack. Returns true when the command ran, false when it was rejected by read-only mode, an Allow* flag, sheet protection, or a CommandExecuting handler that called PreventDefault().

Declaration
public abstract Task<bool> ExecuteAsync(Spreadsheet.ICommand command)
Parameters
Type Name Description
Spreadsheet.ICommand command
Returns
Type Description
Task<bool>

IsFeatureAllowedlink

Returns true when the given feature is enabled on the host RadzenSpreadsheet. Tools should use this to decide whether they should appear disabled.

Declaration
public abstract bool IsFeatureAllowed(Spreadsheet.SpreadsheetFeature feature)
Parameters
Type Name Description
Spreadsheet.SpreadsheetFeature feature The feature to check.
Returns
Type Description
bool

LoadWorkbookAsynclink

Replaces the displayed workbook, resets the active sheet and cached view, and raises WorkbookChanged. Used by the Open tool so it works in any toolbar.

Declaration
public abstract Task LoadWorkbookAsync(Documents.Spreadsheet.Workbook workbook)
Parameters
Type Name Description
Documents.Spreadsheet.Workbook workbook The workbook to display.
Returns
Type Description
Task

Localizelink

Returns a localized string for the specified key.

Declaration
public abstract string Localize(string key)
Parameters
Type Name Description
string key The resource key.
Returns
Type Description
stringThe localized string.

Redolink

Redoes the last undone command.

Declaration
public abstract void Redo()

Undolink

Undoes the last command.

Declaration
public abstract void Undo()
In This Article
An error has occurred. This app may no longer respond until reloaded. Reload 🗙