Class

RadSpreadsheetElement

Initializes a new instance of the RadSpreadsheetElement class with default settings and components. Sets up the input handler, sheet selector, status bar, themes, and worksheet editor components.

Declaration

public RadSpreadsheetElement()

Identifies the ActiveSheetEditor dependency property.

Declaration

public static readonly RadProperty ActiveSheetEditorProperty

Field Value

Identifies the CommandDescriptors dependency property.

Declaration

public static readonly RadProperty CommandDescriptorsProperty

Field Value

Identifies the FillHandleSelectionStroke dependency property.

Declaration

public static readonly RadProperty FillHandleSelectionStrokeProperty

Field Value

Identifies the FormulaBarHeight dependency property.

Declaration

public static readonly RadProperty FormulaBarHeightProperty

Field Value

Identifies the SelectionFill dependency property.

Declaration

public static readonly RadProperty SelectionFillProperty

Field Value

Identifies the SelectionStroke dependency property.

Declaration

public static readonly RadProperty SelectionStrokeProperty

Field Value

Identifies the SelectionStrokeThickness dependency property.

Declaration

public static readonly RadProperty SelectionStrokeThicknessProperty

Field Value

Identifies the StatusBarHeight dependency property.

Declaration

public static readonly RadProperty StatusBarHeightProperty

Field Value

Identifies the Workbook dependency property.

Declaration

public static readonly RadProperty WorkbookProperty

Field Value

Identifies the WorksheetEditorContextMenu dependency property.

Declaration

public static readonly RadProperty WorksheetEditorContextMenuProperty

Field Value

Gets or sets the currently active sheet within the workbook.

Declaration

public Sheet ActiveSheet { get; set; }

Property Value

Gets the currently active sheet editor that provides editing functionality for the current sheet.

Declaration

public IRadSheetEditor ActiveSheetEditor { get; }

Property Value

Gets or sets the currently active worksheet, providing typed access to worksheet-specific functionality.

Declaration

public Worksheet ActiveWorksheet { get; set; }

Property Value

Gets or sets the active worksheet editor that provides editing capabilities for the current worksheet.

Declaration

public RadWorksheetEditor ActiveWorksheetEditor { get; set; }

Property Value

Gets or sets the color palette used for cell formatting and theming operations.

Declaration

public SpreadsheetColorPalette ColorPalette { get; set; }

Property Value

Gets the collection of command descriptors available for spreadsheet operations.

Declaration

public CommandDescriptors CommandDescriptors { get; }

Property Value

Implements ICommandDescriptorsProvider.CommandDescriptors

Gets or sets the brush used to draw the fill handle selection indicator.

Declaration

public Brush FillHandleSelectionStroke { get; set; }

Property Value

Gets the fonts provider that manages font information and font families for the spreadsheet.

Declaration

public FontsProvider FontsProvider { get; }

Property Value

Gets the formula bar element that allows editing of cell formulas and values.

Declaration

public RadSpreadsheetFormulaBar FormulaBar { get; }

Property Value

Gets or sets the height of the formula bar in pixels.

Declaration

public int FormulaBarHeight { get; set; }

Property Value

Gets the horizontal scroll bar element for navigating the worksheet horizontally.

Declaration

public RadScrollBarElement HorizontalScrollBar { get; }

Property Value

Implements IScrollBarsProvider.HorizontalScrollBar

Gets or sets the input behavior handler that manages keyboard and mouse interactions for the spreadsheet.

Declaration

public SpreadsheetInputBehavior InputHandler { get; set; }

Property Value

Gets the print manager that provides printing functionality for the spreadsheet content.

Declaration

public PrintManager PrintManager { get; }

Property Value

Gets or sets the brush used to fill the background of selected cells and ranges.

Declaration

public Brush SelectionFill { get; set; }

Property Value

Gets or sets the brush used to draw the outline of selected cells and ranges.

Declaration

public Brush SelectionStroke { get; set; }

Property Value

Gets or sets the thickness of the stroke used to outline selected cells and ranges.

Declaration

public double SelectionStrokeThickness { get; set; }

Property Value

Gets the sheet selector element that displays worksheet tabs and allows sheet navigation.

Declaration

public RadSpreadsheetSheetSelector SheetSelector { get; }

Property Value

Gets or sets the context menu displayed when right-clicking on worksheet tabs in the sheet selector.

Declaration

public RadContextMenu SheetSelectorContextMenu { get; set; }

Property Value

Gets the status bar element that displays information about the current selection and spreadsheet state.

Declaration

public RadSpreadsheetStatusBar StatusBar { get; }

Property Value

Gets or sets the height of the status bar in pixels.

Declaration

public int StatusBarHeight { get; set; }

Property Value

Gets or sets the document theme that defines colors, fonts, and effects for the spreadsheet.

Declaration

public DocumentTheme Theme { get; set; }

Property Value

Gets the themes manager that handles document theme operations and theme switching.

Declaration

public RadSpreadsheetThemesManager ThemesManager { get; }

Property Value

Gets the vertical scroll bar element for navigating the worksheet vertically.

Declaration

public RadScrollBarElement VerticalScrollBar { get; }

Property Value

Implements IScrollBarsProvider.VerticalScrollBar

Gets or sets the dimensions of the visible worksheet area in rows and columns.

Declaration

public SizeI VisibleSize { get; set; }

Property Value

Gets or sets the workbook that contains all worksheets and spreadsheet data.

Declaration

public Workbook Workbook { get; set; }

Property Value

Gets or sets the context menu displayed when right-clicking within the worksheet editor area.

Declaration

public RadContextMenu WorksheetEditorContextMenu { get; set; }

Property Value

Gets or sets the builder responsible for creating and managing worksheet UI layers.

Declaration

public WorksheetUILayersBuilder WorksheetUILayersBuilder { get; set; }

Property Value

Arranges the spreadsheet element and positions all child components within the final layout area.

Declaration

protected override SizeF ArrangeOverride(SizeF finalSize)

Parameters

Returns

Overrides LightVisualElement.ArrangeOverride(SizeF)

Begins an undo group that allows multiple operations to be undone as a single action. Use in conjunction with EndUndoGroup() to group related operations.

Declaration

public void BeginUndoGroup()

Cancels the currently active undo group, discarding all operations that would have been grouped since the last call to BeginUndoGroup().

Declaration

public void CancelUndoGroup()

Creates the child elements that make up the spreadsheet's visual structure. Initializes the formula bar, content presenter, scroll bars, sheet selector, and other UI components.

Declaration

protected override void CreateChildElements()

Overrides RadElement.CreateChildElements()

Declaration

public virtual RadContextMenu CreateDefaultWorkbookContextMenu()

Returns

Updates the element and its children to account for DPI scaling changes. Ensures that the spreadsheet and its components render correctly at different DPI settings.

Declaration

public override void DpiScaleChanged(SizeF scaleFactor)

Parameters

Overrides RadElement.DpiScaleChanged(SizeF)

Ends the currently active undo group, finalizing the grouping of operations since the last call to BeginUndoGroup().

Declaration

public void EndUndoGroup()

Declaration

protected virtual void EnsureDefaultContextMenu()

Invalidates the layout.

Declaration

public void InvalidateLayout()

Measures the desired size of the spreadsheet element and its child components.

Declaration

protected override SizeF MeasureOverride(SizeF availableSize)

Parameters

Returns

Overrides LightVisualElement.MeasureOverride(SizeF)

Raises the ActiveSheetChanged event.

Declaration

protected virtual void OnActiveSheetChanged()

Raises the ActiveSheetEditorChanged event.

Declaration

protected virtual void OnActiveSheetEditorChanged()

Raises the BeforeOpenFile event.

Declaration

protected virtual void OnBeforeOpenFile(OpenFileDialogEventArgs args)

Parameters

Raises the BeforeSaveFile event.

Declaration

protected virtual void OnBeforeSaveFile(SaveFileDialogEventArgs args)

Parameters

Raises the ContextMenuShowing event.

Declaration

protected virtual void OnContextMenuShowing(object sender, SpreadsheetContextMenuOpeningEventArgs e)

Parameters

Raises the MessageShowing event.

Declaration

protected virtual void OnMessageShowing(MessageShowingEventArgs args)

Parameters

Raises the MouseDown event and handles right-click actions to show the context menu.

Declaration

protected override void OnMouseDown(MouseEventArgs e)

Parameters

Overrides RadItem.OnMouseDown(MouseEventArgs)

Called when the template is applying.

Declaration

protected virtual void OnTemplateApplying()

Raises the WorkbookChanged event.

Declaration

protected virtual void OnWorkbookChanged()

Raises the WorkbookChanging event.

Declaration

protected virtual void OnWorkbookChanging()

Raises the WorkbookCommandError event.

Declaration

protected virtual void OnWorkbookCommandError(CommandErrorEventArgs args)

Parameters

Raises the WorkbookCommandExecuted event.

Declaration

protected virtual void OnWorkbookCommandExecuted(CommandExecutedEventArgs args)

Parameters

Raises the WorkbookCommandExecuting event.

Declaration

protected virtual void OnWorkbookCommandExecuting(CommandExecutingEventArgs args)

Parameters

Prints the spreadsheet content using the specified print settings. Allows printing the active worksheet, a specific range of cells, or the entire workbook.

Declaration

public void Print(PrintWhatSettings printWhatSettings, string printDescription = null, bool showDialog = true)

Parameters

Shows the print preview dialog that allows the user to view how the spreadsheet will look when printed and make adjustments to print settings before printing.

Declaration

public void PrintPreview()

Processes the MouseWheel event for zooming and scrolling the spreadsheet. When Control key is pressed, zooms in or out; otherwise scrolls the worksheet vertically.

Declaration

public virtual bool ProcessMouseWheel(MouseEventArgs e, bool control)

Parameters

Returns

Receives events from the centralized event manager.

Declaration

public bool ReceiveWeakEvent(Type managerType, object sender, EventArgs e)

Parameters

Returns

Implements IWeakEventListener.ReceiveWeakEvent(Type, object, EventArgs)

Redoes the most recently undone operation or group of operations in the spreadsheet.

Declaration

public bool Redo()

Returns

Declaration

protected virtual void SetDarkIcons()

Sets the horizontal scroll position of the active sheet editor. Controls the horizontal scrolling position of the worksheet viewport.

Declaration

public void SetHorizontalOffset(double offset)

Parameters

Declaration

protected virtual void SetStandardIcons()

Sets the vertical scroll position of the active sheet editor. Controls the vertical scrolling position of the worksheet viewport.

Declaration

public void SetVerticalOffset(double offset)

Parameters

Declaration

protected virtual void ShowContextMenu(MouseEventArgs e)

Parameters

Undoes the most recent operation or group of operations in the spreadsheet.

Declaration

public bool Undo()

Returns

Updates the icon set used throughout the spreadsheet interface to match the current theme. Ensures proper icon contrast when switching between light and dark themes.

Declaration

public virtual void UpdateIconSet()

Occurs when the active sheet changes to a different worksheet within the workbook.

Declaration

public event EventHandler ActiveSheetChanged

Event Value

Occurs when the active sheet editor changes to a different editor implementation.

Declaration

public event EventHandler ActiveSheetEditorChanged

Event Value

Occurs before a file is opened, before the open file dialog is shown.

Declaration

public event EventHandler<OpenFileDialogEventArgs> BeforeOpenFile

Event Value

Remarks

Occurs before the file is saved, before the save file dialog is shown.

Declaration

public event EventHandler<SaveFileDialogEventArgs> BeforeSaveFile

Event Value

Remarks

Occurs when the spreadsheet context menu is about to be shown. Allows customization of the context menu items before they are displayed.

Declaration

public event SpreadsheetContextMenuOpeningEventHandler ContextMenuShowing

Event Value

Occurs when a message or warning needs to be displayed to the user.

Declaration

public event EventHandler<MessageShowingEventArgs> MessageShowing

Event Value

Occurs after the workbook has been changed to a different workbook instance.

Declaration

public event EventHandler WorkbookChanged

Event Value

Occurs before the workbook is changed, allowing for preparation or validation before the change.

Declaration

public event EventHandler WorkbookChanging

Event Value

Occurs when an error occurs during the execution of a workbook command.

Declaration

public event EventHandler<CommandErrorEventArgs> WorkbookCommandError

Event Value

Occurs after a workbook command has been successfully executed.

Declaration

public event EventHandler<CommandExecutedEventArgs> WorkbookCommandExecuted

Event Value

Occurs before a workbook command is executed, allowing for cancellation or modification of the command.

Declaration

public event EventHandler<CommandExecutingEventArgs> WorkbookCommandExecuting

Event Value

Occurs when any content within the workbook has been modified, such as cell values, formatting, or structure changes.

Declaration

public event EventHandler WorkbookContentChanged

Event Value