Back to all docs
API Reference / Telerik.Windows.Controls / RadSpreadsheet
New to Telerik UI for WPF? Start a free 30-day trial

RadSpreadsheet

Class

Represents the RadSpreadsheet control.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.Spreadsheet.dll

Syntax:
C#
[TelerikToolboxCategory("Documents")]
public class RadSpreadsheet : ControlBase, IScrollBarsProvider, ICommandDescriptorsProvider, IWeakEventListener

Inheritance: objectControlBaseRadSpreadsheet

Implements: ICommandDescriptorsProviderIScrollBarsProviderIWeakEventListener

Inherited Members ControlBase.GetTemplateChild<T>(string)ControlBase.GetRequiredTemplateChild<T>(string, bool)

Constructors

RadSpreadsheet()

Initializes a new instance of the RadSpreadsheet class.

C#
public RadSpreadsheet()

Fields

ActiveSheetEditorProperty

DependencyProperty

Active sheet editor dependency property.

C#
public static readonly DependencyProperty ActiveSheetEditorProperty

ColorPaletteProperty

DependencyProperty

Color palette dependency property.

C#
public static readonly DependencyProperty ColorPaletteProperty

CommandDescriptorsProperty

DependencyProperty

Command descriptors dependency property.

C#
public static readonly DependencyProperty CommandDescriptorsProperty

FillHandleSelectionStrokeProperty

DependencyProperty

Fill handle selection stroke dependency property.

C#
public static readonly DependencyProperty FillHandleSelectionStrokeProperty

SelectionFillProperty

DependencyProperty

Selection fill dependency property.

C#
public static readonly DependencyProperty SelectionFillProperty

SelectionStrokeProperty

DependencyProperty

Selection stroke dependency property.

C#
public static readonly DependencyProperty SelectionStrokeProperty

SelectionStrokeThicknessProperty

DependencyProperty

Selection stroke thickness dependency property.

C#
public static readonly DependencyProperty SelectionStrokeThicknessProperty

WorkbookProperty

DependencyProperty

Workbook dependency property.

C#
public static readonly DependencyProperty WorkbookProperty

WorksheetEditorContextMenuProperty

DependencyProperty

Worksheet editor context menu dependency property.

C#
public static readonly DependencyProperty WorksheetEditorContextMenuProperty

Properties

ActiveSheet

Sheet

Gets or sets the active sheet.

C#
public Sheet ActiveSheet { get; set; }
Property Value:

The active sheet.

ActiveSheetEditor

Gets the active sheet editor.

C#
public IRadSheetEditor ActiveSheetEditor { get; }
Property Value:

The active sheet editor.

ActiveWorksheet

Worksheet

Gets or sets the active worksheet.

C#
public Worksheet ActiveWorksheet { get; set; }
Property Value:

The active worksheet.

ActiveWorksheetEditor

Gets or sets the active worksheet editor.

C#
public RadWorksheetEditor ActiveWorksheetEditor { get; set; }
Property Value:

The active worksheet editor.

ColorPalette

Gets or sets the color palette.

C#
public SpreadsheetColorPalette ColorPalette { get; set; }
Property Value:

The color palette.

CommandDescriptors

Gets the command descriptors.

C#
public CommandDescriptors CommandDescriptors { get; }
Property Value:

The command descriptors.

Implements: ICommandDescriptorsProvider.CommandDescriptors

CreateVisualCellsAutomationPeers

Gets or sets a value indicating whether automation peers for the visible cells should be created by the owned RadSpreadsheetAutomationPeer.

C#
[Browsable(false)]
public bool CreateVisualCellsAutomationPeers { get; set; }
Property Value:

The value indicating whether automation peers for the visible cells should be created by the owned RadSpreadsheetAutomationPeer.

Remarks:

Setting this property to false will stop owned RadSpreadsheetAutomationPeer from creating child automation peers for each of the visible cells. This may increase performance and decrease memory consumption on some touch-enabled computers, where the automation tree is created on application startup.

FillHandleSelectionStroke

Brush

Gets or sets the fill handle selection stroke.

C#
public Brush FillHandleSelectionStroke { get; set; }
Property Value:

The fill handle selection stroke.

FontsProvider

Gets the fonts provider.

C#
public FontsProvider FontsProvider { get; }
Property Value:

The fonts provider.

FormatProviders

Gets a collection of the available format providers.

If format providers are not explicitly added, format providers registered in are used.

C#
public WorkbookFormatProvidersCollection FormatProviders { get; }
Property Value:

The format providers.

HorizontalScrollBar

ScrollBar

Gets the horizontal scroll bar.

C#
public ScrollBar HorizontalScrollBar { get; }
Property Value:

The horizontal scroll bar.

Implements: IScrollBarsProvider.HorizontalScrollBar

SelectionFill

Brush

Gets or sets the selection fill.

C#
public Brush SelectionFill { get; set; }
Property Value:

The selection fill.

SelectionStroke

Brush

Gets or sets the selection stroke.

C#
public Brush SelectionStroke { get; set; }
Property Value:

The selection stroke.

SelectionStrokeThickness

Gets or sets the selection stroke thickness.

C#
public double SelectionStrokeThickness { get; set; }
Property Value:

The selection stroke thickness.

SheetSelectorContextMenu

Gets or sets the RadSpreadsheetSheetSelector context menu.

C#
public RadContextMenu SheetSelectorContextMenu { get; set; }
Property Value:

The RadSpreadsheetSheetSelector context menu.

Theme

DocumentTheme

Gets or sets the theme.

C#
public DocumentTheme Theme { get; set; }
Property Value:

The theme.

ThemesManager

Gets the themes manager.

C#
public RadSpreadsheetThemesManager ThemesManager { get; }
Property Value:

The themes manager.

VerticalScrollBar

ScrollBar

Gets the vertical scroll bar.

C#
public ScrollBar VerticalScrollBar { get; }
Property Value:

The vertical scroll bar.

Implements: IScrollBarsProvider.VerticalScrollBar

VisibleSize

SizeI

Gets or sets the visible size.

C#
public SizeI VisibleSize { get; set; }
Property Value:

The visible size.

Workbook

Workbook

Gets or sets the workbook.

C#
public Workbook Workbook { get; set; }
Property Value:

The workbook.

WorksheetEditorContextMenu

Gets or sets the worksheet editor context menu.

C#
public RadContextMenu WorksheetEditorContextMenu { get; set; }
Property Value:

The worksheet editor context menu.

WorksheetUILayersBuilder

Gets or sets the worksheet UI layers builder.

C#
public WorksheetUILayersBuilder WorksheetUILayersBuilder { get; set; }
Property Value:

The worksheet UI layers builder.

Methods

BeginUndoGroup()

Begins the undo group.

C#
public void BeginUndoGroup()

CancelUndoGroup()

Cancels the undo group.

C#
public void CancelUndoGroup()

EndUndoGroup()

Ends the undo group.

C#
public void EndUndoGroup()

InvalidateLayout()

Invalidates the layout.

C#
public void InvalidateLayout()

OnActiveSheetChanged()

Called when the active sheet is changed.

C#
protected virtual void OnActiveSheetChanged()

OnActiveSheetEditorChanged()

Called when the active sheet editor is changed.

C#
protected virtual void OnActiveSheetEditorChanged()

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes call .

C#
public override void OnApplyTemplate()

OnCreateAutomationPeer()

AutomationPeer

Returns class-specific AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.

C#
protected override AutomationPeer OnCreateAutomationPeer()
Returns:

AutomationPeer

The type-specific AutomationPeer implementation.

OnGotFocus(RoutedEventArgs)

Raises the  routed event by using the event data provided.

C#
protected override void OnGotFocus(RoutedEventArgs e)
Parameters:eRoutedEventArgs

A RoutedEventArgs that contains event data. This event data must contain the identifier for the event.

OnInitialized(EventArgs)

Raises the event. This method is invoked whenever is set to true internally.

C#
protected override void OnInitialized(EventArgs e)
Parameters:eEventArgs

The RoutedEventArgs that contains the event data.

OnMessageShowing(MessageShowingEventArgs)

Raises the event.

C#
protected virtual void OnMessageShowing(MessageShowingEventArgs args)
Parameters:argsMessageShowingEventArgs

The MessageShowingEventArgs instance containing the event data.

OnTemplateApplying()

Called when the template is applying.

C#
protected virtual void OnTemplateApplying()

OnWorkbookChanged()

Called when the workbook is changed.

C#
protected virtual void OnWorkbookChanged()

OnWorkbookChanging()

Called when the workbook is changing.

C#
protected virtual void OnWorkbookChanging()

OnWorkbookCommandError(CommandErrorEventArgs)

Raises the event.

C#
protected virtual void OnWorkbookCommandError(CommandErrorEventArgs args)
Parameters:argsCommandErrorEventArgs

The CommandErrorEventArgs instance containing the event data.

OnWorkbookCommandExecuted(CommandExecutedEventArgs)

Raises the event.

C#
protected virtual void OnWorkbookCommandExecuted(CommandExecutedEventArgs args)
Parameters:argsCommandExecutedEventArgs

The CommandExecutedEventArgs instance containing the event data.

OnWorkbookCommandExecuting(CommandExecutingEventArgs)

Raises the event.

C#
protected virtual void OnWorkbookCommandExecuting(CommandExecutingEventArgs args)
Parameters:argsCommandExecutingEventArgs

The CommandExecutingEventArgs instance containing the event data.

Print(PrintWhatSettings, PrintDialog, string)

Prints using the specified print what settings.

C#
public void Print(PrintWhatSettings printWhatSettings, PrintDialog printDialog, string printDescription = null)
Parameters:printWhatSettingsPrintWhatSettings

The print what settings.

printDialogPrintDialog

The print dialog.

printDescriptionstring

The print description.

Print(PrintWhatSettings, string)

Prints using the specified print what settings.

C#
public void Print(PrintWhatSettings printWhatSettings, string printDescription = null)
Parameters:printWhatSettingsPrintWhatSettings

The print what settings.

printDescriptionstring

The print description.

ReceiveWeakEvent(Type, object, EventArgs)

Receives events from the centralized event manager.

C#
public bool ReceiveWeakEvent(Type managerType, object sender, EventArgs e)
Parameters:managerTypeType

The type of the calling this method.

senderobject

Object that originated the event.

eEventArgs

Event data.

Returns:

bool

true if the listener handled the event. It is considered an error by the handling in WPF to register a listener for an event that the listener does not handle. Regardless, the method should return false if it receives an event that it does not recognize or handle.

Redo()

Redoes this instance.

C#
public bool Redo()
Returns:

bool

True if succeed.

SetHorizontalOffset(double)

Sets the horizontal offset.

C#
public void SetHorizontalOffset(double offset)
Parameters:offsetdouble

The offset.

SetVerticalOffset(double)

Sets the vertical offset.

C#
public void SetVerticalOffset(double offset)
Parameters:offsetdouble

The offset.

Undo()

Undoes this instance.

C#
public bool Undo()
Returns:

bool

True if succeed.

Events

ActiveSheetChanged

Occurs when the active sheet is changed.

C#
public event EventHandler ActiveSheetChanged

ActiveSheetEditorChanged

Occurs when the active sheet editor is changed.

C#
public event EventHandler ActiveSheetEditorChanged

MessageShowing

Occurs when the user is presented with a warning message.

C#
public event EventHandler<MessageShowingEventArgs> MessageShowing

WorkbookChanged

Occurs when the workbook is changed.

C#
public event EventHandler WorkbookChanged

WorkbookChanging

Occurs when the workbook is changing.

C#
public event EventHandler WorkbookChanging

WorkbookCommandError

EventHandler<CommandErrorEventArgs>

Occurs when workbook command error occurs.

C#
public event EventHandler<CommandErrorEventArgs> WorkbookCommandError

WorkbookCommandExecuted

EventHandler<CommandExecutedEventArgs>

Occurs when workbook command is executed.

C#
public event EventHandler<CommandExecutedEventArgs> WorkbookCommandExecuted

WorkbookCommandExecuting

EventHandler<CommandExecutingEventArgs>

Occurs when workbook command is executing.

C#
public event EventHandler<CommandExecutingEventArgs> WorkbookCommandExecuting

WorkbookContentChanged

Occurs when the workbook content is changed.

C#
public event EventHandler WorkbookContentChanged
In this article
DefinitionConstructorsRadSpreadsheet()FieldsActiveSheetEditorPropertyColorPalettePropertyCommandDescriptorsPropertyFillHandleSelectionStrokePropertySelectionFillPropertySelectionStrokePropertySelectionStrokeThicknessPropertyWorkbookPropertyWorksheetEditorContextMenuPropertyPropertiesActiveSheetActiveSheetEditorActiveWorksheetActiveWorksheetEditorColorPaletteCommandDescriptorsCreateVisualCellsAutomationPeersFillHandleSelectionStrokeFontsProviderFormatProvidersHorizontalScrollBarSelectionFillSelectionStrokeSelectionStrokeThicknessSheetSelectorContextMenuThemeThemesManagerVerticalScrollBarVisibleSizeWorkbookWorksheetEditorContextMenuWorksheetUILayersBuilderMethodsBeginUndoGroup()CancelUndoGroup()EndUndoGroup()InvalidateLayout()OnActiveSheetChanged()OnActiveSheetEditorChanged()OnApplyTemplate()OnCreateAutomationPeer()OnGotFocus(RoutedEventArgs)OnInitialized(EventArgs)OnMessageShowing(MessageShowingEventArgs)OnTemplateApplying()OnWorkbookChanged()OnWorkbookChanging()OnWorkbookCommandError(CommandErrorEventArgs)OnWorkbookCommandExecuted(CommandExecutedEventArgs)OnWorkbookCommandExecuting(CommandExecutingEventArgs)Print(PrintWhatSettings, PrintDialog, string)Print(PrintWhatSettings, string)ReceiveWeakEvent(Type, object, EventArgs)Redo()SetHorizontalOffset(double)SetVerticalOffset(double)Undo()EventsActiveSheetChangedActiveSheetEditorChangedMessageShowingWorkbookChangedWorkbookChangingWorkbookCommandErrorWorkbookCommandExecutedWorkbookCommandExecutingWorkbookContentChanged
Not finding the help you need?
Contact Support