Class RadWorksheetEditorPresenterBase

Provides the base class from which the classes that represent worksheet editor presenter are derived.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIElement
ControlBase
WorksheetPresenterBase
RadWorksheetEditorPresenterBase
NormalWorksheetEditorPresenter
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.WinForms.Controls.Spreadsheet.Worksheets
Assembly: Telerik.WinControls.RadSpreadsheet.dll

Syntax

public abstract class RadWorksheetEditorPresenterBase : WorksheetPresenterBase, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IRadWorksheetEditorPresenter, IWorksheetPresenterBase

Constructors

RadWorksheetEditorPresenterBase()

Initializes a new instance of the RadWorksheetEditorPresenterBase class.

Declaration
protected RadWorksheetEditorPresenterBase()

Properties

IsFrozen

Gets the value indicating whether the panes are frozen.

Declaration
protected bool IsFrozen { get; }
Property Value
System.Boolean

The value indicating whether the panes are frozen.

Owner

Gets or sets the owner.

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

The owner.
Implements

PointerHandlersController

Gets the pointer handlers controller.

Declaration
public PointerHandlersController PointerHandlersController { get; }
Property Value
PointerHandlersController

The pointer handlers controller.
Implements

ScrollableSize

Gets the scrollable size of the presenter.

Declaration
public Size ScrollableSize { get; }
Property Value
Size

The scrollable size of the presenter.

ScrollBarsProvider

Gets or sets the scroll bars provider.

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

The scroll bars provider.
Implements

ShouldShowSelectionMarkers

Gets the value indicating if should show selection markers.

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

The value indicating if should show selection markers.
Implements

Methods

BringIntoView(CellIndex)

Brings the into view.

Declaration
public abstract void BringIntoView(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Index of the cell.
Implements

DoOnSheetChanged()

Called when sheet is changed.

Declaration
protected virtual void DoOnSheetChanged()

DoOnSheetChanging()

Called when the sheet is changing.

Declaration
protected virtual void DoOnSheetChanging()

GetCellIndexFromViewPoint(Point)

Gets the cell index from view point.

Declaration
public abstract CellIndex GetCellIndexFromViewPoint(Point point)
Parameters
Point point

The view point.
Returns
CellIndex

The cell index.
Implements

GetDocumentPointFromViewPoint(Point)

Gets the document point from view point.

Declaration
public abstract Point GetDocumentPointFromViewPoint(Point point)
Parameters
Point point

The view point.
Returns
Point

The document point.
Implements

GetNearestCellIndexFromViewPoint(Point)

Gets the nearest cell index from view point.

Declaration
public abstract CellIndex GetNearestCellIndexFromViewPoint(Point point)
Parameters
Point point

The view point.
Returns
CellIndex

The nearest cell index.
Implements

GetViewPointFromDocumentPoint(Point)

Gets the view point from document point.

Declaration
public abstract Point GetViewPointFromDocumentPoint(Point point)
Parameters
Point point

The document point.
Returns
Point

The view point.
Implements

HideDropMarker()

Hides the drop marker.

Declaration
public abstract void HideDropMarker()
Implements

HideSelectionMarkers()

Hides the selection markers.

Declaration
public void HideSelectionMarkers()
Implements

InitializeUILayers()

Initializes the UI layers.

Declaration
protected abstract void InitializeUILayers()

InvalidateAndUpdateLayout()

Invalidates the and update layout.

Declaration
protected void InvalidateAndUpdateLayout()

MoveDropMarker(CellIndex)

Moves the drop marker.

Declaration
public abstract void MoveDropMarker(CellIndex position)
Parameters
CellIndex position

The position.
Implements

OnGotFocus(EventArgs)

Raises the GotFocus routed event by using the event data provided.

Declaration
protected override void OnGotFocus(EventArgs e)
Parameters
System.EventArgs e

A System.EventArgs that contains event data.
Overrides

OnKeyUp(KeyEventArgs)

Invoked when an unhandled KeyUp 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 OnKeyUp(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

The System.Windows.Forms.KeyEventArgs that contains the event data.
Overrides

OnLostMouseCapture(MouseEventArgs)

Invoked when an unhandled LostMouseCapture 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 OnLostMouseCapture(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs that contains event data.
Overrides

OnMouseLeftButtonDown(MouseButtonEventArgs)

Invoked when an unhandled MouseLeftButtonDown routed event is raised on this element. Implement this method to add class handling for this event.

Declaration
protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)
Parameters
MouseButtonEventArgs e

The MouseButtonEventArgs that contains the event data. The event data reports that the left mouse button was pressed.
Overrides

OnMouseLeftButtonUp(MouseButtonEventArgs)

Invoked when an unhandled MouseLeftButtonUp routed 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 OnMouseLeftButtonUp(MouseButtonEventArgs e)
Parameters
MouseButtonEventArgs e

The MouseButtonEventArgs that contains the event data. The event data reports that the left mouse button was released.
Overrides

OnMouseMove(MouseEventArgs)

Invoked when an unhandled MouseMove 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 OnMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs that contains the event data.
Overrides

OnMouseRightButtonDown(MouseButtonEventArgs)

Called when mouse right button down event occurs.

Declaration
protected override void OnMouseRightButtonDown(MouseButtonEventArgs e)
Parameters
MouseButtonEventArgs e

The MouseButtonEventArgs instance containing the event data.
Overrides

OnMouseRightButtonUp(MouseButtonEventArgs)

Invoked when an unhandled MouseRightButtonUp routed 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 OnMouseRightButtonUp(MouseButtonEventArgs e)
Parameters
MouseButtonEventArgs e

The MouseButtonEventArgs that contains the event data. The event data reports that the right mouse button was released.
Overrides

OnMouseWheel(MouseEventArgs)

Invoked when an unhandled MouseWheel 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 OnMouseWheel(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs that contains the event data.
Overrides

OnOwnerChanged()

Called when the owner is changed.

Declaration
protected virtual void OnOwnerChanged()

OnOwnerChanging()

Called when the owner is changing.

Declaration
protected virtual void OnOwnerChanging()

OnSheetViewportChanged()

Called when the SheetViewport is changed.

Declaration
protected override void OnSheetViewportChanged()
Overrides

OnUIUpdated(WorksheetUIUpdatedEventArgs)

Raises the UIUpdated event.

Declaration
protected virtual void OnUIUpdated(WorksheetUIUpdatedEventArgs args)
Parameters
WorksheetUIUpdatedEventArgs args

The WorksheetUIUpdatedEventArgs instance containing the event data.

SetHorizontalOffset(Double)

Sets the horizontal offset.

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

The offset.
Implements

SetupUILayers()

Setups the UI layers.

Declaration
protected abstract void SetupUILayers()

SetVerticalOffset(Double)

Sets the vertical offset.

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

The offset.
Implements

ShowDropMarker(CellIndex)

Shows the drop marker.

Declaration
public abstract void ShowDropMarker(CellIndex position)
Parameters
CellIndex position

The position.
Implements

ShowSelectionMarkers()

Shows the selection markers.

Declaration
public void ShowSelectionMarkers()
Implements

UpdateHorizontalScrollBar(SheetViewport, Double)

Updates the horizontal scroll bar.

Declaration
protected void UpdateHorizontalScrollBar(SheetViewport sheetViewport, double smallChange)
Parameters
SheetViewport sheetViewport

The sheetViewport.
System.Double smallChange

The small change.

UpdateScrollBarsMaximum(CellLayoutBox)

Updates the scroll bars maximum.

Declaration
protected void UpdateScrollBarsMaximum(CellLayoutBox topLeftCellLayoutBox = null)
Parameters
CellLayoutBox topLeftCellLayoutBox

UpdateScrollBarsMinMax(CellLayoutBox)

Updates the scroll bars min and max value.

Declaration
protected void UpdateScrollBarsMinMax(CellLayoutBox topLeftCellLayoutBox = null)
Parameters
CellLayoutBox topLeftCellLayoutBox

UpdateToViewWithTopLeftCellIndex(CellIndex)

Updates the view port so the top left cell index is the desired one.

Declaration
public abstract void UpdateToViewWithTopLeftCellIndex(CellIndex topLeftCellIndex)
Parameters
CellIndex topLeftCellIndex

The desired index of the top left visible cell.
Implements

UpdateVerticalScrollBar(SheetViewport, Double)

Updates the vertical scroll bar.

Declaration
protected void UpdateVerticalScrollBar(SheetViewport sheetViewport, double smallChange)
Parameters
SheetViewport sheetViewport

The sheetViewport.
System.Double smallChange

The small change.

Events

FreezePanesChanged

Occurs when the freeze panes has changed.

Declaration
public event EventHandler FreezePanesChanged
Event Type
System.EventHandler

UIUpdated

Occurs when the UI is updated.

Declaration
public event EventHandler<WorksheetUIUpdatedEventArgs> UIUpdated
Event Type
System.EventHandler<WorksheetUIUpdatedEventArgs>

Implements

Explicit Interface Implementations

IRadWorksheetEditorPresenter.Focus()

Focuses this instance.

Declaration
void IRadWorksheetEditorPresenter.Focus()
Implements

Extension Methods