Class
RadWorksheetEditorPresenterBase

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

Definition

Namespace:Telerik.Windows.Controls.Spreadsheet.Worksheets

Assembly:Telerik.Windows.Controls.Spreadsheet.dll

Syntax:

cs-api-definition
public abstract class RadWorksheetEditorPresenterBase : WorksheetPresenterBase, IRadWorksheetEditorPresenter, IWorksheetPresenterBase

Inheritance: objectControlBaseWorksheetPresenterBaseRadWorksheetEditorPresenterBase

Derived Classes: NormalWorksheetEditorPresenter

Implements: IRadWorksheetEditorPresenterIWorksheetPresenterBase

Inherited Members WorksheetPresenterBase.InvalidateLayout()WorksheetPresenterBase.UILayersWorksheetPresenterBase.HorizontalOffsetWorksheetPresenterBase.VerticalOffsetWorksheetPresenterBase.SheetViewportWorksheetPresenterBase.SheetViewportChangedControlBase.GetTemplateChild<T>(string)ControlBase.GetRequiredTemplateChild<T>(string, bool)

Constructors

RadWorksheetEditorPresenterBase()

Initializes a new instance of the RadWorksheetEditorPresenterBase class.

Declaration

cs-api-definition
protected RadWorksheetEditorPresenterBase()

Properties

IsFrozen

Gets the value indicating whether the panes are frozen.

Declaration

cs-api-definition
protected bool IsFrozen { get; }

Property Value

bool

The value indicating whether the panes are frozen.

Owner

Gets or sets the owner.

Declaration

cs-api-definition
public RadWorksheetEditor Owner { get; set; }

Property Value

RadWorksheetEditor

The owner.

Implements IRadWorksheetEditorPresenter.Owner

PointerHandlersController

Gets the pointer handlers controller.

Declaration

cs-api-definition
public PointerHandlersController PointerHandlersController { get; }

Property Value

PointerHandlersController

The pointer handlers controller.

Implements IRadWorksheetEditorPresenter.PointerHandlersController

ScrollBarsProvider

Gets or sets the scroll bars provider.

Declaration

cs-api-definition
public IScrollBarsProvider ScrollBarsProvider { get; set; }

Property Value

IScrollBarsProvider

The scroll bars provider.

Implements IRadWorksheetEditorPresenter.ScrollBarsProvider

ScrollableSize

Gets the scrollable size of the presenter.

Declaration

cs-api-definition
public Size ScrollableSize { get; }

Property Value

Size

The scrollable size of the presenter.

ShouldShowSelectionMarkers

Gets the value indicating if should show selection markers.

Declaration

cs-api-definition
public bool ShouldShowSelectionMarkers { get; set; }

Property Value

bool

The value indicating if should show selection markers.

Implements IRadWorksheetEditorPresenter.ShouldShowSelectionMarkers

Methods

BringIntoView(CellIndex)

Brings the into view.

Declaration

cs-api-definition
public abstract void BringIntoView(CellIndex cellIndex)

Parameters

cellIndex

CellIndex

Index of the cell.

Implements IRadWorksheetEditorPresenter.BringIntoView(CellIndex)

DoOnSheetChanged()

Called when sheet is changed.

Declaration

cs-api-definition
protected virtual void DoOnSheetChanged()

DoOnSheetChanging()

Called when the sheet is changing.

Declaration

cs-api-definition
protected virtual void DoOnSheetChanging()

GetCellIndexFromViewPoint(Point)

Gets the cell index from view point.

Declaration

cs-api-definition
public abstract CellIndex GetCellIndexFromViewPoint(Point point)

Parameters

point

Point

The view point.

Returns

CellIndex

The cell index.

Implements IRadWorksheetEditorPresenter.GetCellIndexFromViewPoint(Point)

GetDocumentPointFromViewPoint(Point)

Gets the document point from view point.

Declaration

cs-api-definition
public abstract Point GetDocumentPointFromViewPoint(Point point)

Parameters

point

Point

The view point.

Returns

Point

The document point.

Implements IRadWorksheetEditorPresenter.GetDocumentPointFromViewPoint(Point)

GetNearestCellIndexFromViewPoint(Point)

Gets the nearest cell index from view point.

Declaration

cs-api-definition
public abstract CellIndex GetNearestCellIndexFromViewPoint(Point point)

Parameters

point

Point

The view point.

Returns

CellIndex

The nearest cell index.

Implements IRadWorksheetEditorPresenter.GetNearestCellIndexFromViewPoint(Point)

GetViewPointFromDocumentPoint(Point)

Gets the view point from document point.

Declaration

cs-api-definition
public abstract Point GetViewPointFromDocumentPoint(Point point)

Parameters

point

Point

The document point.

Returns

Point

The view point.

Implements IRadWorksheetEditorPresenter.GetViewPointFromDocumentPoint(Point)

HideDropMarker()

Hides the drop marker.

Declaration

cs-api-definition
public abstract void HideDropMarker()

Implements IRadWorksheetEditorPresenter.HideDropMarker()

HideSelectionMarkers()

Hides the selection markers.

Declaration

cs-api-definition
public void HideSelectionMarkers()

Implements IRadWorksheetEditorPresenter.HideSelectionMarkers()

InitializeUILayers()

Initializes the UI layers.

Declaration

cs-api-definition
protected abstract void InitializeUILayers()

InvalidateAndUpdateLayout()

Invalidates the and update layout.

Declaration

cs-api-definition
protected void InvalidateAndUpdateLayout()

MoveDropMarker(CellIndex)

Moves the drop marker.

Declaration

cs-api-definition
public abstract void MoveDropMarker(CellIndex position)

Parameters

position

CellIndex

The position.

Implements IRadWorksheetEditorPresenter.MoveDropMarker(CellIndex)

OnGotFocus(RoutedEventArgs)

Raises the  routed event by using the event data provided.

Declaration

cs-api-definition
protected override void OnGotFocus(RoutedEventArgs e)

Parameters

e

RoutedEventArgs

A RoutedEventArgs that contains event data. This event data must contain the identifier for the event.

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

cs-api-definition
protected override void OnKeyUp(KeyEventArgs e)

Parameters

e

KeyEventArgs

The KeyEventArgs that contains the event data.

OnLostMouseCapture(MouseEventArgs)

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

cs-api-definition
protected override void OnLostMouseCapture(MouseEventArgs e)

Parameters

e

MouseEventArgs

The MouseEventArgs that contains event data.

OnMouseLeftButtonDown(MouseButtonEventArgs)

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

Declaration

cs-api-definition
protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)

Parameters

e

MouseButtonEventArgs

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

OnMouseLeftButtonUp(MouseButtonEventArgs)

Invoked when an unhandled  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

cs-api-definition
protected override void OnMouseLeftButtonUp(MouseButtonEventArgs e)

Parameters

e

MouseButtonEventArgs

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

OnMouseMove(MouseEventArgs)

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

cs-api-definition
protected override void OnMouseMove(MouseEventArgs e)

Parameters

e

MouseEventArgs

The MouseEventArgs that contains the event data.

OnMouseRightButtonUp(MouseButtonEventArgs)

Invoked when an unhandled  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

cs-api-definition
protected override void OnMouseRightButtonUp(MouseButtonEventArgs e)

Parameters

e

MouseButtonEventArgs

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

OnMouseWheel(MouseWheelEventArgs)

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

cs-api-definition
protected override void OnMouseWheel(MouseWheelEventArgs e)

Parameters

e

MouseWheelEventArgs

The MouseWheelEventArgs that contains the event data.

OnOwnerChanged()

Called when the owner is changed.

Declaration

cs-api-definition
protected virtual void OnOwnerChanged()

OnOwnerChanging()

Called when the owner is changing.

Declaration

cs-api-definition
protected virtual void OnOwnerChanging()

OnSheetViewportChanged()

Called when the SheetViewport is changed.

Declaration

cs-api-definition
protected override void OnSheetViewportChanged()

Overrides WorksheetPresenterBase.OnSheetViewportChanged()

OnUIUpdated(WorksheetUIUpdatedEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnUIUpdated(WorksheetUIUpdatedEventArgs args)

Parameters

args

WorksheetUIUpdatedEventArgs

The WorksheetUIUpdatedEventArgs instance containing the event data.

SetHorizontalOffset(double)

Sets the horizontal offset.

Declaration

cs-api-definition
public void SetHorizontalOffset(double offset)

Parameters

offset

double

The offset.

Implements IRadWorksheetEditorPresenter.SetHorizontalOffset(double)

SetVerticalOffset(double)

Sets the vertical offset.

Declaration

cs-api-definition
public void SetVerticalOffset(double offset)

Parameters

offset

double

The offset.

Implements IRadWorksheetEditorPresenter.SetVerticalOffset(double)

SetupUILayers()

Setups the UI layers.

Declaration

cs-api-definition
protected abstract void SetupUILayers()

ShowDropMarker(CellIndex)

Shows the drop marker.

Declaration

cs-api-definition
public abstract void ShowDropMarker(CellIndex position)

Parameters

position

CellIndex

The position.

Implements IRadWorksheetEditorPresenter.ShowDropMarker(CellIndex)

ShowSelectionMarkers()

Shows the selection markers.

Declaration

cs-api-definition
public void ShowSelectionMarkers()

Implements IRadWorksheetEditorPresenter.ShowSelectionMarkers()

UpdateHorizontalScrollBar(SheetViewport, double)

Updates the horizontal scroll bar.

Declaration

cs-api-definition
protected void UpdateHorizontalScrollBar(SheetViewport sheetViewport, double smallChange)

Parameters

sheetViewport

SheetViewport

The sheetViewport.

smallChange

double

The small change.

UpdateScrollBarsMaximum(CellLayoutBox)

Updates the scroll bars maximum.

Declaration

cs-api-definition
protected void UpdateScrollBarsMaximum(CellLayoutBox topLeftCellLayoutBox = null)

Parameters

topLeftCellLayoutBox

CellLayoutBox

UpdateScrollBarsMinMax(CellLayoutBox)

Updates the scroll bars min and max value.

Declaration

cs-api-definition
protected void UpdateScrollBarsMinMax(CellLayoutBox topLeftCellLayoutBox = null)

Parameters

topLeftCellLayoutBox

CellLayoutBox

UpdateToViewWithTopLeftCellIndex(CellIndex)

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

Declaration

cs-api-definition
public abstract void UpdateToViewWithTopLeftCellIndex(CellIndex topLeftCellIndex)

Parameters

topLeftCellIndex

CellIndex

The desired index of the top left visible cell.

Implements IRadWorksheetEditorPresenter.UpdateToViewWithTopLeftCellIndex(CellIndex)

UpdateVerticalScrollBar(SheetViewport, double)

Updates the vertical scroll bar.

Declaration

cs-api-definition
protected void UpdateVerticalScrollBar(SheetViewport sheetViewport, double smallChange)

Parameters

sheetViewport

SheetViewport

The sheetViewport.

smallChange

double

The small change.

Events

FreezePanesChanged

Occurs when the freeze panes has changed.

Declaration

cs-api-definition
public event EventHandler FreezePanesChanged

Event Value

EventHandler

UIUpdated

Occurs when the UI is updated.

Declaration

cs-api-definition
public event EventHandler<WorksheetUIUpdatedEventArgs> UIUpdated

Event Value

EventHandler<WorksheetUIUpdatedEventArgs>

Implements IRadWorksheetEditorPresenter.UIUpdated