ClassRadSheetEditorBase
Provides the base class from which the classes that represent RadSheetEditors are derived.
Definition
Namespace:Telerik.Windows.Controls.Spreadsheet
Assembly:Telerik.Windows.Controls.Spreadsheet.dll
Syntax:
public abstract class RadSheetEditorBase : ControlBase, IRadSheetEditor, ICommandDescriptorsProvider, ISheetEditor, IUILayerOwnerInheritance: objectControlBaseRadSheetEditorBase
Derived Classes:
Implements:
Inherited Members
Constructors
RadSheetEditorBase()
Initializes a new instance of the RadSheetEditorBase class.
Declaration
protected RadSheetEditorBase()Fields
AllowScalingProperty
Allow scaling dependency property.
Declaration
public static readonly DependencyProperty AllowScalingPropertyField Value
DependencyProperty
ScaleFactorProperty
Scale factor dependency property.
Declaration
public static readonly DependencyProperty ScaleFactorPropertyField Value
DependencyProperty
Properties
AllowScaling
Gets or sets a value indicating whether scaling is allowed.
Declaration
public bool AllowScaling { get; set; }Property Value
The value indicating whether scaling is allowed.
Implements
CommandDescriptors
Gets or sets the command descriptors.
Declaration
public CommandDescriptors CommandDescriptors { get; protected set; }Property Value
The command descriptors.
Implements
KeyBindings
Gets the key bindings.
Declaration
public KeyBindings KeyBindings { get; }Property Value
The key bindings.
Owner
Gets or sets the owner.
Declaration
public RadSpreadsheet Owner { get; set; }Property Value
The owner.
Implements
ScaleFactor
Gets or sets the scale factor.
Declaration
public Size ScaleFactor { get; set; }Property Value
Size
The scale factor.
Implements
ScrollBarsProvider
Gets or sets the scroll bars provider.
Declaration
public IScrollBarsProvider ScrollBarsProvider { get; set; }Property Value
The scroll bars provider.
Implements
SheetViewport
Gets the sheet viewport.
Declaration
public abstract SheetViewport SheetViewport { get; }Property Value
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
Sheet
The sheet.
IsSheetValid(Sheet)
Determines whether the sheet is valid.
Declaration
protected abstract bool IsSheetValid(Sheet sheet)Parameters
sheet
Sheet
The sheet.
Returns
True if is valid.
OnCommandDescriptorsChanged()
Raises the event.
Declaration
protected virtual void OnCommandDescriptorsChanged()OnKeyDown(KeyEventArgs)
Invoked when an unhandled 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
e
KeyEventArgs
The KeyEventArgs that contains the event data.
OnOwnerChanged()
Called when the owner is changed.
Declaration
protected virtual void OnOwnerChanged()OnOwnerChanging()
Raises the event.
Declaration
protected virtual void OnOwnerChanging()OnOwnerTemplateApplying()
Raises the event.
Declaration
protected virtual void OnOwnerTemplateApplying()OnPreviewSheetChanged()
Raises the event.
Declaration
protected virtual void OnPreviewSheetChanged()OnPreviewSheetChanging()
Raises the event.
Declaration
protected virtual void OnPreviewSheetChanging()OnScaleFactorChanged()
Raises the 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 event.
Declaration
protected virtual void OnSheetChanged()OnSheetChanging()
Raises the event.
Declaration
protected virtual void OnSheetChanging()OnUICommandError(UICommandErrorEventArgs)
Raises the event.
Declaration
protected virtual void OnUICommandError(UICommandErrorEventArgs args)Parameters
args
The UICommandErrorEventArgs instance containing the event data.
OnUICommandExecuted(UICommandExecutedEventArgs)
Raises the event.
Declaration
protected virtual void OnUICommandExecuted(UICommandExecutedEventArgs args)Parameters
args
The UICommandExecutedEventArgs instance containing the event data.
OnUICommandExecuting(UICommandExecutingEventArgs)
Raises the event.
Declaration
protected virtual void OnUICommandExecuting(UICommandExecutingEventArgs args)Parameters
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
viewState
ISheetViewState
View state of the sheet.
RestoreSheetViewState(ISheetViewState)
Restores the view state of the sheet.
Declaration
protected abstract void RestoreSheetViewState(ISheetViewState viewState)Parameters
viewState
ISheetViewState
View state of the sheet.
SetHorizontalOffset(double)
Sets the horizontal offset.
Declaration
public abstract void SetHorizontalOffset(double offset)Parameters
offset
The offset.
Implements
SetSheetValue(Sheet)
Sets the sheet value.
Declaration
protected void SetSheetValue(Sheet sheet)Parameters
sheet
Sheet
The sheet.
SetVerticalOffset(double)
Sets the vertical offset.
Declaration
public abstract void SetVerticalOffset(double offset)Parameters
offset
The offset.
Implements
Events
CommandDescriptorsChanged
Occurs when the command descriptors are changed.
Declaration
public event EventHandler CommandDescriptorsChangedEvent Value
Implements
PreviewSheetChanged
Occurs just before the sheet changing ends.
Declaration
public event EventHandler PreviewSheetChangedEvent Value
PreviewSheetChanging
Occurs just before the sheet changing begins.
Declaration
public event EventHandler PreviewSheetChangingEvent Value
ScaleFactorChanged
Occurs when the scale factor is changed.
Declaration
public event EventHandler ScaleFactorChangedEvent Value
Implements
SheetChanged
Occurs when the sheet is changed.
SheetChanging
Occurs when the sheet is changing.
UICommandError
Occurs on UI command error.
Declaration
public event EventHandler<UICommandErrorEventArgs> UICommandErrorEvent Value
Implements
UICommandExecuted
Occurs when the UI command is executed.
Declaration
public event EventHandler<UICommandExecutedEventArgs> UICommandExecutedEvent Value
Implements
UICommandExecuting
Occurs when the UI command is executing.
Declaration
public event EventHandler<UICommandExecutingEventArgs> UICommandExecutingEvent Value
Implements