Documentation

Class RadSheetEditorBase

Provides the base class from which the classes that represent RadSheetEditors are derived.

Inheritance
System.Object
ControlBase
RadSheetEditorBase
RadSheetEditorBase<T>
Inherited Members
Namespace: Telerik.Windows.Controls.Spreadsheet
Assembly: Telerik.Windows.Controls.Spreadsheet.dll

Syntax

public abstract class RadSheetEditorBase : ControlBase, IRadSheetEditor, ICommandDescriptorsProvider, ISheetEditor, IUILayerOwner

Constructors

RadSheetEditorBase()

Initializes a new instance of the RadSheetEditorBase class.

Declaration
protected RadSheetEditorBase()

Fields

AllowScalingProperty

Allow scaling dependency property.

Declaration
public static readonly DependencyProperty AllowScalingProperty
Field Value
System.Windows.DependencyProperty

ScaleFactorProperty

Scale factor dependency property.

Declaration
public static readonly DependencyProperty ScaleFactorProperty
Field Value
System.Windows.DependencyProperty

Properties

AllowScaling

Gets or sets a value indicating whether scaling is allowed.

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

The value indicating whether scaling is allowed.
Implements

CommandDescriptors

Gets or sets the command descriptors.

Declaration
public CommandDescriptors CommandDescriptors { get; protected set; }
Property Value
CommandDescriptors

The command descriptors.
Implements

KeyBindings

Gets the key bindings.

Declaration
public KeyBindings KeyBindings { get; }
Property Value
KeyBindings

The key bindings.

Owner

Gets or sets the owner.

Declaration
public RadSpreadsheet Owner { get; set; }
Property Value
RadSpreadsheet

The owner.
Implements

ScaleFactor

Gets or sets the scale factor.

Declaration
public Size ScaleFactor { get; set; }
Property Value
System.Windows.Size

The scale factor.
Implements

ScrollBarsProvider

Gets or sets the scroll bars provider.

Declaration
public IScrollBarsProvider ScrollBarsProvider { get; set; }
Property Value
IScrollBarsProvider

The scroll bars provider.
Implements

SheetViewport

Gets the sheet viewport.

Declaration
public abstract SheetViewport SheetViewport { get; }
Property Value
Telerik.Windows.Documents.Spreadsheet.Layout.SheetViewport

The sheet viewport.
Implements

Methods

DoOnSheetChanged()

Called when the sheet is changed.

Declaration
protected void DoOnSheetChanged()

DoOnSheetChanging()

Called when the sheet is changing.

Declaration
protected void DoOnSheetChanging()

GetSheetValue()

Gets the sheet value.

Declaration
protected Sheet GetSheetValue()
Returns
Telerik.Windows.Documents.Spreadsheet.Model.Sheet

The sheet.

IsSheetValid(Sheet)

Determines whether the sheet is valid.

Declaration
protected abstract bool IsSheetValid(Sheet sheet)
Parameters
Telerik.Windows.Documents.Spreadsheet.Model.Sheet sheet

The sheet.
Returns
System.Boolean

True if is valid.

OnCommandDescriptorsChanged()

Raises the CommandDescriptorsChanged event.

Declaration
protected virtual void OnCommandDescriptorsChanged()

OnKeyDown(KeyEventArgs)

Invoked when an unhandled System.Windows.Input.Keyboard.KeyDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
System.Windows.Input.KeyEventArgs e

The System.Windows.Input.KeyEventArgs that contains the event data.

OnOwnerChanged()

Called when the owner is changed.

Declaration
protected virtual void OnOwnerChanged()

OnOwnerChanging()

Raises the OwnerChanging event.

Declaration
protected virtual void OnOwnerChanging()

OnOwnerTemplateApplying()

Raises the OwnerTemplateApplying event.

Declaration
protected virtual void OnOwnerTemplateApplying()

OnPreviewSheetChanged()

Raises the PreviewSheetChanged event.

Declaration
protected virtual void OnPreviewSheetChanged()

OnPreviewSheetChanging()

Raises the PreviewSheetChanging event.

Declaration
protected virtual void OnPreviewSheetChanging()

OnScaleFactorChanged()

Raises the ScaleFactorChanged event.

Declaration
protected virtual void OnScaleFactorChanged()

OnScrollBarProviderChanged()

Called when the scroll bar provider is changed.

Declaration
protected virtual void OnScrollBarProviderChanged()

OnScrollBarProviderChanging()

Called when the scroll bar provider is changing.

Declaration
protected virtual void OnScrollBarProviderChanging()

OnSheetChanged()

Raises the SheetChanged event.

Declaration
protected virtual void OnSheetChanged()

OnSheetChanging()

Raises the SheetChanging event.

Declaration
protected virtual void OnSheetChanging()

OnUICommandError(UICommandErrorEventArgs)

Raises the UICommandError event.

Declaration
protected virtual void OnUICommandError(UICommandErrorEventArgs args)
Parameters
UICommandErrorEventArgs args

The UICommandErrorEventArgs instance containing the event data.

OnUICommandExecuted(UICommandExecutedEventArgs)

Raises the UICommandExecuted event.

Declaration
protected virtual void OnUICommandExecuted(UICommandExecutedEventArgs args)
Parameters
UICommandExecutedEventArgs args

The UICommandExecutedEventArgs instance containing the event data.

OnUICommandExecuting(UICommandExecutingEventArgs)

Raises the UICommandExecuting event.

Declaration
protected virtual void OnUICommandExecuting(UICommandExecutingEventArgs args)
Parameters
UICommandExecutingEventArgs args

The UICommandExecutingEventArgs instance containing the event data.

PreserveSheetViewState(ISheetViewState)

Preserves the view state of the sheet.

Declaration
protected abstract void PreserveSheetViewState(ISheetViewState viewState)
Parameters
Telerik.Windows.Documents.Spreadsheet.Model.ISheetViewState viewState

View state of the sheet.

RestoreSheetViewState(ISheetViewState)

Restores the view state of the sheet.

Declaration
protected abstract void RestoreSheetViewState(ISheetViewState viewState)
Parameters
Telerik.Windows.Documents.Spreadsheet.Model.ISheetViewState viewState

View state of the sheet.

SetHorizontalOffset(Double)

Sets the horizontal offset.

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

The offset.
Implements

SetSheetValue(Sheet)

Sets the sheet value.

Declaration
protected void SetSheetValue(Sheet sheet)
Parameters
Telerik.Windows.Documents.Spreadsheet.Model.Sheet sheet

The sheet.

SetVerticalOffset(Double)

Sets the vertical offset.

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

The offset.
Implements

Events

CommandDescriptorsChanged

Occurs when the command descriptors are changed.

Declaration
public event EventHandler CommandDescriptorsChanged
Event Type
System.EventHandler

Implements

PreviewSheetChanged

Occurs just before the sheet changing ends.

Declaration
public event EventHandler PreviewSheetChanged
Event Type
System.EventHandler

PreviewSheetChanging

Occurs just before the sheet changing begins.

Declaration
public event EventHandler PreviewSheetChanging
Event Type
System.EventHandler

ScaleFactorChanged

Occurs when the scale factor is changed.

Declaration
public event EventHandler ScaleFactorChanged
Event Type
System.EventHandler

Implements

SheetChanged

Occurs when the sheet is changed.

Declaration
public event EventHandler SheetChanged
Event Type
System.EventHandler

SheetChanging

Occurs when the sheet is changing.

Declaration
public event EventHandler SheetChanging
Event Type
System.EventHandler

UICommandError

Occurs on UI command error.

Declaration
public event EventHandler<UICommandErrorEventArgs> UICommandError
Event Type
System.EventHandler<UICommandErrorEventArgs>

Implements

UICommandExecuted

Occurs when the UI command is executed.

Declaration
public event EventHandler<UICommandExecutedEventArgs> UICommandExecuted
Event Type
System.EventHandler<UICommandExecutedEventArgs>

Implements

UICommandExecuting

Occurs when the UI command is executing.

Declaration
public event EventHandler<UICommandExecutingEventArgs> UICommandExecuting
Event Type
System.EventHandler<UICommandExecutingEventArgs>

Implements

Explicit Interface Implementations

IRadSheetEditor.Focus()

Focuses this instance.

Declaration
void IRadSheetEditor.Focus()
Implements

IRadSheetEditor.UpdateLayout()

Declaration
void IRadSheetEditor.UpdateLayout()
Implements

Extension Methods