Class RadSpreadsheetElement

Represents the RadSpreadsheetElement control.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
RadSpreadsheetElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.RadSpreadsheet.dll

Syntax

public class RadSpreadsheetElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IImageElement, ITextPrimitive, ITextProvider, ICommandDescriptorsProvider, IScrollBarsProvider, IWeakEventListener

Constructors

RadSpreadsheetElement()

Initializes a new instance of the RadSpreadsheet class.

Declaration
public RadSpreadsheetElement()

Fields

ActiveSheetEditorProperty

Declaration
public static readonly RadProperty ActiveSheetEditorProperty
Field Value
RadProperty

CommandDescriptorsProperty

Declaration
public static readonly RadProperty CommandDescriptorsProperty
Field Value
RadProperty

FillHandleSelectionStrokeProperty

Declaration
public static readonly RadProperty FillHandleSelectionStrokeProperty
Field Value
RadProperty

FormulaBarHeightProperty

Declaration
public static readonly RadProperty FormulaBarHeightProperty
Field Value
RadProperty

SelectionFillProperty

Declaration
public static readonly RadProperty SelectionFillProperty
Field Value
RadProperty

SelectionStrokeProperty

Declaration
public static readonly RadProperty SelectionStrokeProperty
Field Value
RadProperty

SelectionStrokeThicknessProperty

Declaration
public static readonly RadProperty SelectionStrokeThicknessProperty
Field Value
RadProperty

StatusBarHeightProperty

Declaration
public static readonly RadProperty StatusBarHeightProperty
Field Value
RadProperty

WorkbookProperty

Declaration
public static readonly RadProperty WorkbookProperty
Field Value
RadProperty

WorksheetEditorContextMenuProperty

Declaration
public static readonly RadProperty WorksheetEditorContextMenuProperty
Field Value
RadProperty

Properties

ActiveSheet

Gets or sets the active sheet.

Declaration
public Sheet ActiveSheet { get; set; }
Property Value
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
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

This property is not relevant for WinForms.

Declaration
public bool CreateVisualCellsAutomationPeers { get; set; }
Property Value
System.Boolean

FillHandleSelectionStroke

Gets or sets the fill handle selection stroke.

Declaration
public Brush FillHandleSelectionStroke { get; set; }
Property Value
System.Drawing.Brush

The fill handle selection stroke.

FontsProvider

Gets the fonts provider.

Declaration
public FontsProvider FontsProvider { get; }
Property Value
FontsProvider

The fonts provider.

FormulaBar

Gets the formula bar element of this spreadsheet

Declaration
public RadSpreadsheetFormulaBar FormulaBar { get; }
Property Value
RadSpreadsheetFormulaBar

FormulaBarHeight

Gets or sets the height of the formula bar of this spreadsheet

Declaration
public int FormulaBarHeight { get; set; }
Property Value
System.Int32

HorizontalScrollBar

Gets the horizontal scroll bar.

Declaration
public RadScrollBarElement HorizontalScrollBar { get; }
Property Value
RadScrollBarElement

The horizontal scroll bar.
Implements

InputHandler

Declaration
public SpreadsheetInputBehavior InputHandler { get; set; }
Property Value
SpreadsheetInputBehavior

PrintManager

Declaration
public PrintManager PrintManager { get; }
Property Value
PrintManager

SelectionFill

Gets or sets the selection fill.

Declaration
public Brush SelectionFill { get; set; }
Property Value
System.Drawing.Brush

The selection fill.

SelectionStroke

Gets or sets the selection stroke.

Declaration
public Brush SelectionStroke { get; set; }
Property Value
System.Drawing.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.

SheetSelector

Gets the sheet selector element of this spreadsheet

Declaration
public RadSpreadsheetSheetSelector SheetSelector { get; }
Property Value
RadSpreadsheetSheetSelector

SheetSelectorContextMenu

Declaration
public RadContextMenu SheetSelectorContextMenu { get; set; }
Property Value
RadContextMenu

ShouldChangeIconsOnThemeChange

Declaration
public virtual bool ShouldChangeIconsOnThemeChange { get; set; }
Property Value
System.Boolean

StatusBar

Declaration
public RadSpreadsheetStatusBar StatusBar { get; }
Property Value
RadSpreadsheetStatusBar

StatusBarHeight

Gets or sets the height of the formula bar of this spreadsheet

Declaration
public int StatusBarHeight { get; set; }
Property Value
System.Int32

Theme

Gets or sets the theme.

Declaration
public DocumentTheme Theme { get; set; }
Property Value
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 RadScrollBarElement VerticalScrollBar { get; }
Property Value
RadScrollBarElement

The vertical scroll bar.
Implements

VisibleSize

Gets or sets the visible size.

Declaration
public SizeI VisibleSize { get; set; }
Property Value
SizeI

The visible size.

Workbook

Gets or sets the workbook.

Declaration
public Workbook Workbook { get; set; }
Property Value
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

ArrangeOverride(SizeF)

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

Returns
System.Drawing.SizeF

Overrides

BeginUndoGroup()

Begins the undo group.

Declaration
public void BeginUndoGroup()

CancelUndoGroup()

Cancels the undo group.

Declaration
public void CancelUndoGroup()

CreateChildElements()

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

Declaration
protected override void CreateChildElements()
Overrides

CreateDefaultWorkbookContextMenu()

Declaration
public virtual RadContextMenu CreateDefaultWorkbookContextMenu()
Returns
RadContextMenu

DpiScaleChanged(SizeF)

Declaration
public override void DpiScaleChanged(SizeF scaleFactor)
Parameters
System.Drawing.SizeF scaleFactor

Overrides

EndUndoGroup()

Ends the undo group.

Declaration
public void EndUndoGroup()

EnsureDefaultContextMenu()

Declaration
protected virtual void EnsureDefaultContextMenu()

InvalidateLayout()

Invalidates the layout.

Declaration
public void InvalidateLayout()

MeasureOverride(SizeF)

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

Returns
System.Drawing.SizeF

Overrides

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()

OnContextMenuShowing(Object, SpreadsheetContextMenuOpeningEventArgs)

Declaration
protected virtual void OnContextMenuShowing(object sender, SpreadsheetContextMenuOpeningEventArgs e)
Parameters
System.Object sender

SpreadsheetContextMenuOpeningEventArgs e

OnMessageShowing(MessageShowingEventArgs)

Raises the MessageShowing event.

Declaration
protected virtual void OnMessageShowing(MessageShowingEventArgs args)
Parameters
MessageShowingEventArgs args

The MessageShowingEventArgs instance containing the event data.

OnMouseDown(MouseEventArgs)

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

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
CommandErrorEventArgs args

The CommandErrorEventArgs instance containing the event data.

OnWorkbookCommandExecuted(CommandExecutedEventArgs)

Raises the WorkbookCommandExecuted event.

Declaration
protected virtual void OnWorkbookCommandExecuted(CommandExecutedEventArgs args)
Parameters
CommandExecutedEventArgs args

The CommandExecutedEventArgs instance containing the event data.

OnWorkbookCommandExecuting(CommandExecutingEventArgs)

Raises the WorkbookCommandExecuting event.

Declaration
protected virtual void OnWorkbookCommandExecuting(CommandExecutingEventArgs args)
Parameters
CommandExecutingEventArgs args

The CommandExecutingEventArgs instance containing the event data.

Print(PrintWhatSettings, String, Boolean)

Prints using the specified print what settings.

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

The print what settings.
System.String printDescription

The print description.
System.Boolean showDialog

Show the default dialog before printing

PrintPreview()

Shows the print preview dialog.

Declaration
public void PrintPreview()

ProcessMouseWheel(MouseEventArgs, Boolean)

Processes the MouseWheel event.

Declaration
public virtual bool ProcessMouseWheel(MouseEventArgs e, bool control)
Parameters
System.Windows.Forms.MouseEventArgs e

The event arguments
System.Boolean control

[true] if Control was pressed, [false] otherwise
Returns
System.Boolean

[true] if the event should not be processed further, [false] otherwise

ReceiveWeakEvent(Type, Object, EventArgs)

Receives events from the centralized event manager.

Declaration
public bool ReceiveWeakEvent(Type managerType, object sender, EventArgs e)
Parameters
System.Type managerType

The type of the System.Windows.WeakEventManager calling this method.
System.Object sender

Object that originated the event.
System.EventArgs e

Event data.
Returns
System.Boolean

true if the listener handled the event. It is considered an error by the System.Windows.WeakEventManager 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
public bool Redo()
Returns
System.Boolean

True if succeed.

SetDarkIcons()

Declaration
protected virtual void SetDarkIcons()

SetHorizontalOffset(Double)

Sets the horizontal offset.

Declaration
public void SetHorizontalOffset(double offset)
Parameters
System.Double offset

The offset.

SetStandardIcons()

Declaration
protected virtual void SetStandardIcons()

SetVerticalOffset(Double)

Sets the vertical offset.

Declaration
public void SetVerticalOffset(double offset)
Parameters
System.Double offset

The offset.

ShowContextMenu(MouseEventArgs)

Declaration
protected virtual void ShowContextMenu(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Undo()

Undoes this instance.

Declaration
public bool Undo()
Returns
System.Boolean

True if succeed.

UpdateIconSet()

Declaration
public virtual void UpdateIconSet()

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

ContextMenuShowing

Declaration
public event SpreadsheetContextMenuOpeningEventHandler ContextMenuShowing
Event Type
SpreadsheetContextMenuOpeningEventHandler

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<CommandErrorEventArgs>

WorkbookCommandExecuted

Occurs when workbook command is executed.

Declaration
public event EventHandler<CommandExecutedEventArgs> WorkbookCommandExecuted
Event Type
System.EventHandler<CommandExecutedEventArgs>

WorkbookCommandExecuting

Occurs when workbook command is executing.

Declaration
public event EventHandler<CommandExecutingEventArgs> WorkbookCommandExecuting
Event Type
System.EventHandler<CommandExecutingEventArgs>

WorkbookContentChanged

Occurs when the workbook content is changed.

Declaration
public event EventHandler WorkbookContentChanged
Event Type
System.EventHandler

Extension Methods