New to Telerik UI for WPFStart a free 30-day trial

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:

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

Inheritance: objectControlBaseRadSheetEditorBase

Derived Classes: RadSheetEditorBase<T>

Implements: ICommandDescriptorsProviderIRadSheetEditorISheetEditorIUILayerOwner

Inherited Members ControlBase.GetTemplateChild<T>(string)ControlBase.GetRequiredTemplateChild<T>(string, bool)

Constructors

Initializes a new instance of the RadSheetEditorBase class.

C#
protected RadSheetEditorBase()

Fields

AllowScalingProperty

DependencyProperty

Allow scaling dependency property.

C#
public static readonly DependencyProperty AllowScalingProperty

ScaleFactorProperty

DependencyProperty

Scale factor dependency property.

C#
public static readonly DependencyProperty ScaleFactorProperty

Properties

Gets or sets a value indicating whether scaling is allowed.

C#
public bool AllowScaling { get; set; }
Property Value:

The value indicating whether scaling is allowed.

Implements: IRadSheetEditor.AllowScaling

Gets or sets the command descriptors.

C#
public CommandDescriptors CommandDescriptors { get; protected set; }
Property Value:

The command descriptors.

Implements: ICommandDescriptorsProvider.CommandDescriptors

Gets the key bindings.

C#
public KeyBindings KeyBindings { get; }
Property Value:

The key bindings.

Gets or sets the owner.

C#
public RadSpreadsheet Owner { get; set; }
Property Value:

The owner.

Implements: IRadSheetEditor.Owner

Gets or sets the scale factor.

C#
public Size ScaleFactor { get; set; }
Property Value:

The scale factor.

Implements: IRadSheetEditor.ScaleFactor

Gets or sets the scroll bars provider.

C#
public IScrollBarsProvider ScrollBarsProvider { get; set; }
Property Value:

The scroll bars provider.

Implements: IRadSheetEditor.ScrollBarsProvider

SheetViewport

SheetViewport

Gets the sheet viewport.

C#
public abstract SheetViewport SheetViewport { get; }
Property Value:

The sheet viewport.

Implements: IRadSheetEditor.SheetViewport

Methods

Called when the sheet is changed.

C#
protected void DoOnSheetChanged()

Called when the sheet is changing.

C#
protected void DoOnSheetChanging()

Gets the sheet value.

C#
protected Sheet GetSheetValue()
Returns:

Sheet

The sheet.

Determines whether the sheet is valid.

C#
protected abstract bool IsSheetValid(Sheet sheet)
Parameters:sheetSheet

The sheet.

Returns:

bool

True if is valid.

Raises the event.

C#
protected virtual void OnCommandDescriptorsChanged()

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.

C#
protected override void OnKeyDown(KeyEventArgs e)
Parameters:eKeyEventArgs

The KeyEventArgs that contains the event data.

Called when the owner is changed.

C#
protected virtual void OnOwnerChanged()

Raises the event.

C#
protected virtual void OnOwnerChanging()

Raises the event.

C#
protected virtual void OnOwnerTemplateApplying()

Raises the event.

C#
protected virtual void OnPreviewSheetChanged()

Raises the event.

C#
protected virtual void OnPreviewSheetChanging()

Raises the event.

C#
protected virtual void OnScaleFactorChanged()

Called when the scroll bar provider is changed.

C#
protected virtual void OnScrollBarProviderChanged()

Called when the scroll bar provider is changing.

C#
protected virtual void OnScrollBarProviderChanging()

Raises the event.

C#
protected virtual void OnSheetChanged()

Raises the event.

C#
protected virtual void OnSheetChanging()

Raises the event.

C#
protected virtual void OnUICommandError(UICommandErrorEventArgs args)
Parameters:argsUICommandErrorEventArgs

The UICommandErrorEventArgs instance containing the event data.

Raises the event.

C#
protected virtual void OnUICommandExecuted(UICommandExecutedEventArgs args)
Parameters:argsUICommandExecutedEventArgs

The UICommandExecutedEventArgs instance containing the event data.

Raises the event.

C#
protected virtual void OnUICommandExecuting(UICommandExecutingEventArgs args)
Parameters:argsUICommandExecutingEventArgs

The UICommandExecutingEventArgs instance containing the event data.

Preserves the view state of the sheet.

C#
protected abstract void PreserveSheetViewState(ISheetViewState viewState)
Parameters:viewStateISheetViewState

View state of the sheet.

Restores the view state of the sheet.

C#
protected abstract void RestoreSheetViewState(ISheetViewState viewState)
Parameters:viewStateISheetViewState

View state of the sheet.

Sets the horizontal offset.

C#
public abstract void SetHorizontalOffset(double offset)
Parameters:offsetdouble

The offset.

Implements: IRadSheetEditor.SetHorizontalOffset(double)

Sets the sheet value.

C#
protected void SetSheetValue(Sheet sheet)
Parameters:sheetSheet

The sheet.

Sets the vertical offset.

C#
public abstract void SetVerticalOffset(double offset)
Parameters:offsetdouble

The offset.

Implements: IRadSheetEditor.SetVerticalOffset(double)

Events

Occurs when the command descriptors are changed.

C#
public event EventHandler CommandDescriptorsChanged

Implements: IRadSheetEditor.CommandDescriptorsChanged

Occurs just before the sheet changing ends.

C#
public event EventHandler PreviewSheetChanged

Occurs just before the sheet changing begins.

C#
public event EventHandler PreviewSheetChanging

Occurs when the scale factor is changed.

C#
public event EventHandler ScaleFactorChanged

Implements: IRadSheetEditor.ScaleFactorChanged

Occurs when the sheet is changed.

C#
public event EventHandler SheetChanged

Occurs when the sheet is changing.

C#
public event EventHandler SheetChanging

Occurs on UI command error.

C#
public event EventHandler<UICommandErrorEventArgs> UICommandError

Implements: IRadSheetEditor.UICommandError

Occurs when the UI command is executed.

C#
public event EventHandler<UICommandExecutedEventArgs> UICommandExecuted

Implements: IRadSheetEditor.UICommandExecuted

Occurs when the UI command is executing.

C#
public event EventHandler<UICommandExecutingEventArgs> UICommandExecuting

Implements: IRadSheetEditor.UICommandExecuting