Class
RadSpreadsheet

Represents the RadSpreadsheet control.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.Spreadsheet.dll

Syntax:

cs-api-definition
[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.

Declaration

cs-api-definition
public RadSpreadsheet()

Fields

ActiveSheetEditorProperty

Active sheet editor dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ActiveSheetEditorProperty

Field Value

DependencyProperty

ColorPaletteProperty

Color palette dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ColorPaletteProperty

Field Value

DependencyProperty

CommandDescriptorsProperty

Command descriptors dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty CommandDescriptorsProperty

Field Value

DependencyProperty

FillHandleSelectionStrokeProperty

Fill handle selection stroke dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty FillHandleSelectionStrokeProperty

Field Value

DependencyProperty

SelectionFillProperty

Selection fill dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty SelectionFillProperty

Field Value

DependencyProperty

SelectionStrokeProperty

Selection stroke dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty SelectionStrokeProperty

Field Value

DependencyProperty

SelectionStrokeThicknessProperty

Selection stroke thickness dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty SelectionStrokeThicknessProperty

Field Value

DependencyProperty

WorkbookProperty

Workbook dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty WorkbookProperty

Field Value

DependencyProperty

WorksheetEditorContextMenuProperty

Worksheet editor context menu dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty WorksheetEditorContextMenuProperty

Field Value

DependencyProperty

Properties

ActiveSheet

Gets or sets the active sheet.

Declaration

cs-api-definition
public Sheet ActiveSheet { get; set; }

Property Value

Sheet

The active sheet.

ActiveSheetEditor

Gets the active sheet editor.

Declaration

cs-api-definition
public IRadSheetEditor ActiveSheetEditor { get; }

Property Value

IRadSheetEditor

The active sheet editor.

ActiveWorksheet

Gets or sets the active worksheet.

Declaration

cs-api-definition
public Worksheet ActiveWorksheet { get; set; }

Property Value

Worksheet

The active worksheet.

ActiveWorksheetEditor

Gets or sets the active worksheet editor.

Declaration

cs-api-definition
public RadWorksheetEditor ActiveWorksheetEditor { get; set; }

Property Value

RadWorksheetEditor

The active worksheet editor.

ColorPalette

Gets or sets the color palette.

Declaration

cs-api-definition
public SpreadsheetColorPalette ColorPalette { get; set; }

Property Value

SpreadsheetColorPalette

The color palette.

CommandDescriptors

Gets the command descriptors.

Declaration

cs-api-definition
public CommandDescriptors CommandDescriptors { get; }

Property Value

CommandDescriptors

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.

Declaration

cs-api-definition
[Browsable(false)]
public bool CreateVisualCellsAutomationPeers { get; set; }

Property Value

bool

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

Gets or sets the fill handle selection stroke.

Declaration

cs-api-definition
public Brush FillHandleSelectionStroke { get; set; }

Property Value

Brush

The fill handle selection stroke.

FontsProvider

Gets the fonts provider.

Declaration

cs-api-definition
public FontsProvider FontsProvider { get; }

Property Value

FontsProvider

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.

Declaration

cs-api-definition
public WorkbookFormatProvidersCollection FormatProviders { get; }

Property Value

WorkbookFormatProvidersCollection

The format providers.

HorizontalScrollBar

Gets the horizontal scroll bar.

Declaration

cs-api-definition
public ScrollBar HorizontalScrollBar { get; }

Property Value

ScrollBar

The horizontal scroll bar.

Implements IScrollBarsProvider.HorizontalScrollBar

SelectionFill

Gets or sets the selection fill.

Declaration

cs-api-definition
public Brush SelectionFill { get; set; }

Property Value

Brush

The selection fill.

SelectionStroke

Gets or sets the selection stroke.

Declaration

cs-api-definition
public Brush SelectionStroke { get; set; }

Property Value

Brush

The selection stroke.

SelectionStrokeThickness

Gets or sets the selection stroke thickness.

Declaration

cs-api-definition
public double SelectionStrokeThickness { get; set; }

Property Value

double

The selection stroke thickness.

SheetSelectorContextMenu

Gets or sets the RadSpreadsheetSheetSelector context menu.

Declaration

cs-api-definition
public RadContextMenu SheetSelectorContextMenu { get; set; }

Property Value

RadContextMenu

The RadSpreadsheetSheetSelector context menu.

Theme

Gets or sets the theme.

Declaration

cs-api-definition
public DocumentTheme Theme { get; set; }

Property Value

DocumentTheme

The theme.

ThemesManager

Gets the themes manager.

Declaration

cs-api-definition
public RadSpreadsheetThemesManager ThemesManager { get; }

Property Value

RadSpreadsheetThemesManager

The themes manager.

VerticalScrollBar

Gets the vertical scroll bar.

Declaration

cs-api-definition
public ScrollBar VerticalScrollBar { get; }

Property Value

ScrollBar

The vertical scroll bar.

Implements IScrollBarsProvider.VerticalScrollBar

VisibleSize

Gets or sets the visible size.

Declaration

cs-api-definition
public SizeI VisibleSize { get; set; }

Property Value

SizeI

The visible size.

Workbook

Gets or sets the workbook.

Declaration

cs-api-definition
public Workbook Workbook { get; set; }

Property Value

Workbook

The workbook.

WorksheetEditorContextMenu

Gets or sets the worksheet editor context menu.

Declaration

cs-api-definition
public RadContextMenu WorksheetEditorContextMenu { get; set; }

Property Value

RadContextMenu

The worksheet editor context menu.

WorksheetUILayersBuilder

Gets or sets the worksheet UI layers builder.

Declaration

cs-api-definition
public WorksheetUILayersBuilder WorksheetUILayersBuilder { get; set; }

Property Value

WorksheetUILayersBuilder

The worksheet UI layers builder.

Methods

BeginUndoGroup()

Begins the undo group.

Declaration

cs-api-definition
public void BeginUndoGroup()

CancelUndoGroup()

Cancels the undo group.

Declaration

cs-api-definition
public void CancelUndoGroup()

EndUndoGroup()

Ends the undo group.

Declaration

cs-api-definition
public void EndUndoGroup()

InvalidateLayout()

Invalidates the layout.

Declaration

cs-api-definition
public void InvalidateLayout()

OnActiveSheetChanged()

Called when the active sheet is changed.

Declaration

cs-api-definition
protected virtual void OnActiveSheetChanged()

OnActiveSheetEditorChanged()

Called when the active sheet editor is changed.

Declaration

cs-api-definition
protected virtual void OnActiveSheetEditorChanged()

OnApplyTemplate()

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

Declaration

cs-api-definition
public override void OnApplyTemplate()

OnCreateAutomationPeer()

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

Declaration

cs-api-definition
protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer

The type-specific AutomationPeer implementation.

OnGotFocus(RoutedEventArgs)

Raises the  routed event by using the event data provided.

Declaration

cs-api-definition
protected override void OnGotFocus(RoutedEventArgs e)

Parameters

e

RoutedEventArgs

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.

Declaration

cs-api-definition
protected override void OnInitialized(EventArgs e)

Parameters

e

EventArgs

The RoutedEventArgs that contains the event data.

OnMessageShowing(MessageShowingEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnMessageShowing(MessageShowingEventArgs args)

Parameters

args

MessageShowingEventArgs

The MessageShowingEventArgs instance containing the event data.

OnTemplateApplying()

Called when the template is applying.

Declaration

cs-api-definition
protected virtual void OnTemplateApplying()

OnWorkbookChanged()

Called when the workbook is changed.

Declaration

cs-api-definition
protected virtual void OnWorkbookChanged()

OnWorkbookChanging()

Called when the workbook is changing.

Declaration

cs-api-definition
protected virtual void OnWorkbookChanging()

OnWorkbookCommandError(CommandErrorEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnWorkbookCommandError(CommandErrorEventArgs args)

Parameters

args

CommandErrorEventArgs

The CommandErrorEventArgs instance containing the event data.

OnWorkbookCommandExecuted(CommandExecutedEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnWorkbookCommandExecuted(CommandExecutedEventArgs args)

Parameters

args

CommandExecutedEventArgs

The CommandExecutedEventArgs instance containing the event data.

OnWorkbookCommandExecuting(CommandExecutingEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnWorkbookCommandExecuting(CommandExecutingEventArgs args)

Parameters

args

CommandExecutingEventArgs

The CommandExecutingEventArgs instance containing the event data.

Print(PrintWhatSettings, PrintDialog, string)

Prints using the specified print what settings.

Declaration

cs-api-definition
public void Print(PrintWhatSettings printWhatSettings, PrintDialog printDialog, string printDescription = null)

Parameters

printWhatSettings

PrintWhatSettings

The print what settings.

printDialog

PrintDialog

The print dialog.

printDescription

string

The print description.

Print(PrintWhatSettings, string)

Prints using the specified print what settings.

Declaration

cs-api-definition
public void Print(PrintWhatSettings printWhatSettings, string printDescription = null)

Parameters

printWhatSettings

PrintWhatSettings

The print what settings.

printDescription

string

The print description.

ReceiveWeakEvent(Type, object, EventArgs)

Receives events from the centralized event manager.

Declaration

cs-api-definition
public bool ReceiveWeakEvent(Type managerType, object sender, EventArgs e)

Parameters

managerType

Type

The type of the calling this method.

sender

object

Object that originated the event.

e

EventArgs

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.

Declaration

cs-api-definition
public bool Redo()

Returns

bool

True if succeed.

SetHorizontalOffset(double)

Sets the horizontal offset.

Declaration

cs-api-definition
public void SetHorizontalOffset(double offset)

Parameters

offset

double

The offset.

SetVerticalOffset(double)

Sets the vertical offset.

Declaration

cs-api-definition
public void SetVerticalOffset(double offset)

Parameters

offset

double

The offset.

Undo()

Undoes this instance.

Declaration

cs-api-definition
public bool Undo()

Returns

bool

True if succeed.

Events

ActiveSheetChanged

Occurs when the active sheet is changed.

Declaration

cs-api-definition
public event EventHandler ActiveSheetChanged

Event Value

EventHandler

ActiveSheetEditorChanged

Occurs when the active sheet editor is changed.

Declaration

cs-api-definition
public event EventHandler ActiveSheetEditorChanged

Event Value

EventHandler

MessageShowing

Occurs when the user is presented with a warning message.

Declaration

cs-api-definition
public event EventHandler<MessageShowingEventArgs> MessageShowing

Event Value

EventHandler<MessageShowingEventArgs>

WorkbookChanged

Occurs when the workbook is changed.

Declaration

cs-api-definition
public event EventHandler WorkbookChanged

Event Value

EventHandler

WorkbookChanging

Occurs when the workbook is changing.

Declaration

cs-api-definition
public event EventHandler WorkbookChanging

Event Value

EventHandler

WorkbookCommandError

Occurs when workbook command error occurs.

Declaration

cs-api-definition
public event EventHandler<CommandErrorEventArgs> WorkbookCommandError

Event Value

EventHandler<CommandErrorEventArgs>

WorkbookCommandExecuted

Occurs when workbook command is executed.

Declaration

cs-api-definition
public event EventHandler<CommandExecutedEventArgs> WorkbookCommandExecuted

Event Value

EventHandler<CommandExecutedEventArgs>

WorkbookCommandExecuting

Occurs when workbook command is executing.

Declaration

cs-api-definition
public event EventHandler<CommandExecutingEventArgs> WorkbookCommandExecuting

Event Value

EventHandler<CommandExecutingEventArgs>

WorkbookContentChanged

Occurs when the workbook content is changed.

Declaration

cs-api-definition
public event EventHandler WorkbookContentChanged

Event Value

EventHandler

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