Class

DocumentPresenterBase

Declaration

public DocumentPresenterBase()

Declaration

protected static readonly double DragMargin

Field Value

Gets the current caret position.

Declaration

protected DocumentPosition CaretPosition { get; }

Property Value

Gets the horizontal scroll position.

Declaration

public double HorizontalOffset { get; }

Property Value

Implements IDocumentEditorPresenter.HorizontalOffset

Gets the horizontal scroll position.

Declaration

protected double HorizontalScrollOffset { get; set; }

Property Value

Gets a value indicating whether the Ctrl button of the keyboard is pressed.

Declaration

public static bool IsCtrlOrMacPressed { get; }

Property Value

Gets a value indicating whether this presenter is focused.

Declaration

public abstract bool IsFocused { get; }

Property Value

Implements IDocumentEditorPresenter.IsFocused

Declaration

public KeyboardSelectionHandler KeyboardSelectionHandler { get; set; }

Property Value

Gets or sets the current selection handler.

Declaration

public MouseSelectionHandler MouseSelectionHandler { get; set; }

Property Value

Gets or sets the owner RadRichTextBox.

Declaration

public RadRichTextBox Owner { get; set; }

Property Value

Implements IDocumentEditorPresenter.Owner

Gets the current scaling factor.

Declaration

public Size ScaleFactor { get; }

Property Value

Gets the height of the scroll bar view.

Declaration

public abstract double ScrollableHeight { get; }

Property Value

Implements IDocumentEditorPresenter.ScrollableHeight

Gets the width of the scroll bar view.

Declaration

public abstract double ScrollableWidth { get; }

Property Value

Implements IDocumentEditorPresenter.ScrollableWidth

Gets the vertical scroll position.

Declaration

public double VerticalOffset { get; }

Property Value

Implements IDocumentEditorPresenter.VerticalOffset

Gets the vertical scroll position.

Declaration

protected double VerticalScrollOffset { get; set; }

Property Value

Gets the height of the scroll bar viewport.

Declaration

public double ViewportHeight { get; }

Property Value

Implements IDocumentEditorPresenter.ViewportHeight

Gets the width of the scroll bar viewport.

Declaration

public double ViewportWidth { get; }

Property Value

Implements IDocumentEditorPresenter.ViewportWidth

Called after the owner document is changed.

Declaration

public virtual void DoOnDocumentChanged()

Implements IDocumentEditorPresenter.DoOnDocumentChanged()

Called before the owner document is changed.

Declaration

public virtual void DoOnDocumentChanging()

Implements IDocumentEditorPresenter.DoOnDocumentChanging()

Focuses the caret.

Declaration

public abstract void FocusCaret()

Implements IDocumentEditorPresenter.FocusCaret()

Gets the number of the current page.

Declaration

public abstract int GetCurrentPage()

Returns

This method supports control infrastructure and is not intended for use directly from your code.

Declaration

protected abstract Rect GetCurrentSectionBoundsInViewOverride()

Returns

Gets a Point in the document from a point of the viewport.

Declaration

public abstract Point GetDocumentPointFromViewPoint(Point viewPoint)

Parameters

Returns

Implements IDocumentEditorPresenter.GetDocumentPointFromViewPoint(Point)

Gets a DocumentPosition from a Point in the viewport.

Declaration

public abstract DocumentPosition GetDocumentPositionFromViewPoint(Point viewPoint)

Parameters

Returns

Implements IDocumentEditorPresenter.GetDocumentPositionFromViewPoint(Point)

Gets the drop marker for a drag and drop operation.

Declaration

protected abstract DropPositionMarker GetDropPositionMarker()

Returns

Gets a scale factor taking into account the min and max scale factor properties of RadRichTextBox.

Declaration

protected Size GetValidScaleFactor(double width, double height)

Parameters

Returns

Gets a Point in the document from a DocumentPosition.

Declaration

public abstract Point GetViewPointFromDocumentPosition(DocumentPosition position)

Parameters

Returns

Implements IDocumentEditorPresenter.GetViewPointFromDocumentPosition(DocumentPosition)

Called when the caret is moved a page down.

Declaration

public abstract void HandlePageDown()

Implements IDocumentEditorPresenter.HandlePageDown()

Called when the caret is moved a page up.

Declaration

public abstract void HandlePageUp()

Implements IDocumentEditorPresenter.HandlePageUp()

Hides the caret.

Declaration

public abstract void HideCaret()

Implements IDocumentEditorPresenter.HideCaret()

Hides the drop marker for a drag and drop operation.

Declaration

public void HideDropMarker()

Implements IDocumentEditorPresenter.HideDropMarker()

Invalidates and updates the presenter layout.

Declaration

protected void InvalidateAndUpdateLayout(bool recursive = false)

Parameters

Invalidates the presenter layout.

Declaration

protected void InvalidateLayout(bool recursive = false)

Parameters

Inavlidates the arrange of the presenter.

Declaration

public void InvalidatePresenterArrange()

Implements IDocumentEditorPresenter.InvalidatePresenterArrange()

Called when an Invalidate arrange is made.

Declaration

protected virtual void InvalidatePresenterArrangeOverride()

Invaldiates the measure of the presenter.

Declaration

public void InvalidatePresenterMeasure()

Implements IDocumentEditorPresenter.InvalidatePresenterMeasure()

Called when an Invalidate measure is made.

Declaration

protected virtual void InvalidatePresenterMeasureOverride()

Gets a value indicating whether the provided key is used in navigation.

Declaration

protected bool IsNavigationKey(Keys key)

Parameters

Returns

Moves the drop marker for a drag and drop operation at the provided DocumentPosition.

Declaration

public void MoveDropMarker(DocumentPosition documentPosition)

Parameters

Implements IDocumentEditorPresenter.MoveDropMarker(DocumentPosition)

Called after the owner RadRichTextBox is changed.

Declaration

protected virtual void OnOwnerChanged()

Called before the owner RadRichTextBox is cahnged.

Declaration

protected virtual void OnOwnerChanging()

Forces a recreation of all UI elements.

Declaration

public abstract void RecreateUI()

Implements IDocumentEditorPresenter.RecreateUI()

Moves the horizontal scroll bar to the specified offset.

Declaration

public void ScrollToHorizontalOffset(double offset)

Parameters

Implements IDocumentEditorPresenter.ScrollToHorizontalOffset(double)

Scrolls the viewport so that the provided Note comes into view.

Declaration

public abstract void ScrollToNote(Note note)

Parameters

Implements IDocumentEditorPresenter.ScrollToNote(Note)

Moves the vertical scroll bar to the specified offset.

Declaration

public void ScrollToVerticalOffset(double offset)

Parameters

Implements IDocumentEditorPresenter.ScrollToVerticalOffset(double)

Sets a value indicating whether the caret is blinking or not.

Declaration

protected abstract void SetCaretBlinking(bool isBlinking)

Parameters

Shows the caret.

Declaration

public abstract void ShowCaret()

Implements IDocumentEditorPresenter.ShowCaret()

Shows the drop marker for a drag and drop operation at the provided DocumentPosition.

Declaration

public void ShowDropMarker(DocumentPosition position)

Parameters

Implements IDocumentEditorPresenter.ShowDropMarker(DocumentPosition)

Updates the caret size.

Declaration

public abstract void UpdateCaretSize()

Implements IDocumentEditorPresenter.UpdateCaretSize()

Makes the page at the provided page number visible in the viewport.

Declaration

protected void UpdateCurrentVisiblePage(int newValue)

Parameters

Updates the cursor after the Ctrl key is pressed or released on the keyboard.

Declaration

public void UpdateCursorOnCtrlKey()

Forces an update of the proofing UI layer.

Declaration

public abstract void UpdateProofingTextDecoration()

Implements IDocumentEditorPresenter.UpdateProofingTextDecoration()

Updates the provided scroll bar.

Declaration

protected static void UpdateScrollBar(double viewportSize, double max, RadScrollBarElement scrollBar, ScrollBarVisibility suggestedVisibility)

Parameters

Scrolls the viewport so that the provided DocumentPosition is brought into view.

Declaration

public abstract void UpdateScrollOffsetFromDocumentPosition(DocumentPosition position)

Parameters

Implements IDocumentEditorPresenter.UpdateScrollOffsetFromDocumentPosition(DocumentPosition)