Class RadSpreadsheet
Represents the RadSpreadsheet control.
Inherited Members
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Spreadsheet.dll
Syntax
[TelerikToolboxCategory("Documents")]
public class RadSpreadsheet : ControlBase, IScrollBarsProvider, ICommandDescriptorsProvider
Constructors
RadSpreadsheet()
Fields
ActiveSheetEditorProperty
Active sheet editor dependency property.
Declaration
public static readonly DependencyProperty ActiveSheetEditorProperty
Field Value
System.Windows.DependencyProperty
|
ColorPaletteProperty
Color palette dependency property.
Declaration
public static readonly DependencyProperty ColorPaletteProperty
Field Value
System.Windows.DependencyProperty
|
CommandDescriptorsProperty
Command descriptors dependency property.
Declaration
public static readonly DependencyProperty CommandDescriptorsProperty
Field Value
System.Windows.DependencyProperty
|
FillHandleSelectionStrokeProperty
Fill handle selection stroke dependency property.
Declaration
public static readonly DependencyProperty FillHandleSelectionStrokeProperty
Field Value
System.Windows.DependencyProperty
|
SelectionFillProperty
Selection fill dependency property.
Declaration
public static readonly DependencyProperty SelectionFillProperty
Field Value
System.Windows.DependencyProperty
|
SelectionStrokeProperty
Selection stroke dependency property.
Declaration
public static readonly DependencyProperty SelectionStrokeProperty
Field Value
System.Windows.DependencyProperty
|
SelectionStrokeThicknessProperty
Selection stroke thickness dependency property.
Declaration
public static readonly DependencyProperty SelectionStrokeThicknessProperty
Field Value
System.Windows.DependencyProperty
|
WorkbookProperty
Workbook dependency property.
Declaration
public static readonly DependencyProperty WorkbookProperty
Field Value
System.Windows.DependencyProperty
|
WorksheetEditorContextMenuProperty
Worksheet editor context menu dependency property.
Declaration
public static readonly DependencyProperty WorksheetEditorContextMenuProperty
Field Value
System.Windows.DependencyProperty
|
Properties
ActiveSheet
Gets or sets the active sheet.
Declaration
public Sheet ActiveSheet { get; set; }
Property Value
Telerik.Windows.Documents.Spreadsheet.Model.Sheet
The active sheet. |
ActiveSheetEditor
Gets the active sheet editor.
Declaration
public IRadSheetEditor ActiveSheetEditor { get; }
Property Value
IRadSheetEditor
The active sheet editor. |
ActiveWorksheet
Gets or sets the active worksheet.
Declaration
public Worksheet ActiveWorksheet { get; set; }
Property Value
Telerik.Windows.Documents.Spreadsheet.Model.Worksheet
The active worksheet. |
ActiveWorksheetEditor
Gets or sets the active worksheet editor.
Declaration
public RadWorksheetEditor ActiveWorksheetEditor { get; set; }
Property Value
RadWorksheetEditor
The active worksheet editor. |
ColorPalette
Gets or sets the color palette.
Declaration
public SpreadsheetColorPalette ColorPalette { get; set; }
Property Value
SpreadsheetColorPalette
The color palette. |
CommandDescriptors
Gets the command descriptors.
Declaration
public CommandDescriptors CommandDescriptors { get; }
Property Value
CommandDescriptors
The command descriptors. |
Implements
CreateVisualCellsAutomationPeers
Gets or sets a value indicating whether automation peers for the visible cells should be created by the owned RadSpreadsheetAutomationPeer.
Declaration
public bool CreateVisualCellsAutomationPeers { get; set; }
Property Value
System.Boolean
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
public Brush FillHandleSelectionStroke { get; set; }
Property Value
System.Windows.Media.Brush
The fill handle selection stroke. |
FontsProvider
Gets the fonts provider.
Declaration
public FontsProvider FontsProvider { get; }
Property Value
FontsProvider
The fonts provider. |
HorizontalScrollBar
Gets the horizontal scroll bar.
Declaration
public ScrollBar HorizontalScrollBar { get; }
Property Value
System.Windows.Controls.Primitives.ScrollBar
The horizontal scroll bar. |
Implements
SelectionFill
Gets or sets the selection fill.
Declaration
public Brush SelectionFill { get; set; }
Property Value
System.Windows.Media.Brush
The selection fill. |
SelectionStroke
Gets or sets the selection stroke.
Declaration
public Brush SelectionStroke { get; set; }
Property Value
System.Windows.Media.Brush
The selection stroke. |
SelectionStrokeThickness
Gets or sets the selection stroke thickness.
Declaration
public double SelectionStrokeThickness { get; set; }
Property Value
System.Double
The selection stroke thickness. |
SheetSelectorContextMenu
Gets or sets the RadSpreadsheetSheetSelector context menu.
Declaration
public RadContextMenu SheetSelectorContextMenu { get; set; }
Property Value
RadContextMenu
The RadSpreadsheetSheetSelector context menu. |
Theme
Gets or sets the theme.
Declaration
public DocumentTheme Theme { get; set; }
Property Value
Telerik.Windows.Documents.Spreadsheet.Theming.DocumentTheme
The theme. |
ThemesManager
Gets the themes manager.
Declaration
public RadSpreadsheetThemesManager ThemesManager { get; }
Property Value
RadSpreadsheetThemesManager
The themes manager. |
VerticalScrollBar
Gets the vertical scroll bar.
Declaration
public ScrollBar VerticalScrollBar { get; }
Property Value
System.Windows.Controls.Primitives.ScrollBar
The vertical scroll bar. |
Implements
VisibleSize
Gets or sets the visible size.
Declaration
public SizeI VisibleSize { get; set; }
Property Value
Telerik.Windows.Documents.Spreadsheet.Model.SizeI
The visible size. |
Workbook
Gets or sets the workbook.
Declaration
public Workbook Workbook { get; set; }
Property Value
Telerik.Windows.Documents.Spreadsheet.Model.Workbook
The workbook. |
WorksheetEditorContextMenu
Gets or sets the worksheet editor context menu.
Declaration
public RadContextMenu WorksheetEditorContextMenu { get; set; }
Property Value
RadContextMenu
The worksheet editor context menu. |
WorksheetUILayersBuilder
Gets or sets the worksheet UI layers builder.
Declaration
public WorksheetUILayersBuilder WorksheetUILayersBuilder { get; set; }
Property Value
WorksheetUILayersBuilder
The worksheet UI layers builder. |
Methods
BeginUndoGroup()
Begins the undo group.
Declaration
public void BeginUndoGroup()
CancelUndoGroup()
Cancels the undo group.
Declaration
public void CancelUndoGroup()
EndUndoGroup()
Ends the undo group.
Declaration
public void EndUndoGroup()
InvalidateLayout()
Invalidates the layout.
Declaration
public void InvalidateLayout()
OnActiveSheetChanged()
Called when the active sheet is changed.
Declaration
protected virtual void OnActiveSheetChanged()
OnActiveSheetEditorChanged()
Called when the active sheet editor is changed.
Declaration
protected virtual void OnActiveSheetEditorChanged()
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes call System.Windows.FrameworkElement.ApplyTemplate.
Declaration
public override void OnApplyTemplate()
OnCreateAutomationPeer()
Returns class-specific System.Windows.Automation.Peers.AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.
Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer
The type-specific System.Windows.Automation.Peers.AutomationPeer implementation. |
OnGotFocus(RoutedEventArgs)
Raises the System.Windows.UIElement.GotFocus routed event by using the event data provided.
Declaration
protected override void OnGotFocus(RoutedEventArgs e)
Parameters
System.Windows.RoutedEventArgs
e
A System.Windows.RoutedEventArgs that contains event data. This event data must contain the identifier for the System.Windows.UIElement.GotFocus event. |
OnMessageShowing(MessageShowingEventArgs)
Raises the MessageShowing event.
Declaration
protected virtual void OnMessageShowing(MessageShowingEventArgs args)
Parameters
MessageShowingEventArgs
args
The MessageShowingEventArgs instance containing the event data. |
OnTemplateApplying()
Called when the template is applying.
Declaration
protected virtual void OnTemplateApplying()
OnWorkbookChanged()
Called when the workbook is changed.
Declaration
protected virtual void OnWorkbookChanged()
OnWorkbookChanging()
Called when the workbook is changing.
Declaration
protected virtual void OnWorkbookChanging()
OnWorkbookCommandError(CommandErrorEventArgs)
Raises the WorkbookCommandError event.
Declaration
protected virtual void OnWorkbookCommandError(CommandErrorEventArgs args)
Parameters
Telerik.Windows.Documents.Spreadsheet.Commands.CommandErrorEventArgs
args
The Telerik.Windows.Documents.Spreadsheet.Commands.CommandErrorEventArgs instance containing the event data. |
OnWorkbookCommandExecuted(CommandExecutedEventArgs)
Raises the WorkbookCommandExecuted event.
Declaration
protected virtual void OnWorkbookCommandExecuted(CommandExecutedEventArgs args)
Parameters
Telerik.Windows.Documents.Spreadsheet.Commands.CommandExecutedEventArgs
args
The Telerik.Windows.Documents.Spreadsheet.Commands.CommandExecutedEventArgs instance containing the event data. |
OnWorkbookCommandExecuting(CommandExecutingEventArgs)
Raises the WorkbookCommandExecuting event.
Declaration
protected virtual void OnWorkbookCommandExecuting(CommandExecutingEventArgs args)
Parameters
Telerik.Windows.Documents.Spreadsheet.Commands.CommandExecutingEventArgs
args
The Telerik.Windows.Documents.Spreadsheet.Commands.CommandExecutingEventArgs instance containing the event data. |
Print(PrintWhatSettings, String)
Prints using the specified print what settings.
Declaration
public void Print(PrintWhatSettings printWhatSettings, string printDescription = null)
Parameters
PrintWhatSettings
printWhatSettings
The print what settings. |
System.String
printDescription
The print description. |
Redo()
Redoes this instance.
Declaration
public bool Redo()
Returns
System.Boolean
|
SetHorizontalOffset(Double)
Sets the horizontal offset.
Declaration
public void SetHorizontalOffset(double offset)
Parameters
System.Double
offset
The offset. |
SetVerticalOffset(Double)
Sets the vertical offset.
Declaration
public void SetVerticalOffset(double offset)
Parameters
System.Double
offset
The offset. |
Undo()
Undoes this instance.
Declaration
public bool Undo()
Returns
System.Boolean
|
Events
ActiveSheetChanged
Occurs when the active sheet is changed.
Declaration
public event EventHandler ActiveSheetChanged
Event Type
System.EventHandler
|
ActiveSheetEditorChanged
Occurs when the active sheet editor is changed.
Declaration
public event EventHandler ActiveSheetEditorChanged
Event Type
System.EventHandler
|
MessageShowing
Occurs when the user is presented with a warning message.
Declaration
public event EventHandler<MessageShowingEventArgs> MessageShowing
Event Type
System.EventHandler<MessageShowingEventArgs>
|
WorkbookChanged
Occurs when the workbook is changed.
Declaration
public event EventHandler WorkbookChanged
Event Type
System.EventHandler
|
WorkbookChanging
Occurs when the workbook is changing.
Declaration
public event EventHandler WorkbookChanging
Event Type
System.EventHandler
|
WorkbookCommandError
Occurs when workbook command error occurs.
Declaration
public event EventHandler<CommandErrorEventArgs> WorkbookCommandError
Event Type
System.EventHandler<Telerik.Windows.Documents.Spreadsheet.Commands.CommandErrorEventArgs>
|
WorkbookCommandExecuted
Occurs when workbook command is executed.
Declaration
public event EventHandler<CommandExecutedEventArgs> WorkbookCommandExecuted
Event Type
System.EventHandler<Telerik.Windows.Documents.Spreadsheet.Commands.CommandExecutedEventArgs>
|
WorkbookCommandExecuting
Occurs when workbook command is executing.
Declaration
public event EventHandler<CommandExecutingEventArgs> WorkbookCommandExecuting
Event Type
System.EventHandler<Telerik.Windows.Documents.Spreadsheet.Commands.CommandExecutingEventArgs>
|
WorkbookContentChanged
Occurs when the workbook content is changed.
Declaration
public event EventHandler WorkbookContentChanged
Event Type
System.EventHandler
|