Class DocumentPresenterBase

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
UIElement
FrameworkElement
ContentControl
DocumentPresenterBase
DocumentPrintLayoutPresenter
DocumentWebLayoutPresenter
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.WinControls.RichTextEditor.UI
Assembly: Telerik.WinControls.RichTextEditor.dll

Syntax

public abstract class DocumentPresenterBase : ContentControl, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IStylableNode, ISupportDrop, IDocumentEditorPresenter, IDisposable

Constructors

DocumentPresenterBase()

Declaration
public DocumentPresenterBase()

Fields

DragMargin

Declaration
protected static readonly double DragMargin
Field Value
System.Double

Properties

CaretPosition

Gets the current caret position.

Declaration
protected DocumentPosition CaretPosition { get; }
Property Value
DocumentPosition

HorizontalOffset

Gets the horizontal scroll position.

Declaration
public double HorizontalOffset { get; }
Property Value
System.Double

Implements

HorizontalScrollOffset

Gets the horizontal scroll position.

Declaration
protected double HorizontalScrollOffset { get; set; }
Property Value
System.Double

IsCtrlOrMacPressed

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

Declaration
public static bool IsCtrlOrMacPressed { get; }
Property Value
System.Boolean

IsFocused

Gets a value indicating whether this presenter is focused.

Declaration
public abstract bool IsFocused { get; }
Property Value
System.Boolean

Implements

KeyboardSelectionHandler

Declaration
protected KeyboardSelectionHandler KeyboardSelectionHandler { get; set; }
Property Value
KeyboardSelectionHandler

Owner

Gets or sets the owner RadRichTextBox.

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

Implements

ScaleFactor

Gets the current scaling factor.

Declaration
public Size ScaleFactor { get; }
Property Value
Size

ScrollableHeight

Gets the height of the scroll bar view.

Declaration
public abstract double ScrollableHeight { get; }
Property Value
System.Double

Implements

ScrollableWidth

Gets the width of the scroll bar view.

Declaration
public abstract double ScrollableWidth { get; }
Property Value
System.Double

Implements

VerticalOffset

Gets the vertical scroll position.

Declaration
public double VerticalOffset { get; }
Property Value
System.Double

Implements

VerticalScrollOffset

Gets the vertical scroll position.

Declaration
protected double VerticalScrollOffset { get; set; }
Property Value
System.Double

ViewportHeight

Gets the height of the scroll bar viewport.

Declaration
public double ViewportHeight { get; }
Property Value
System.Double

Implements

ViewportWidth

Gets the width of the scroll bar viewport.

Declaration
public double ViewportWidth { get; }
Property Value
System.Double

Implements

Methods

DoOnDocumentChanged()

Called after the owner document is changed.

Declaration
public virtual void DoOnDocumentChanged()
Implements

DoOnDocumentChanging()

Called before the owner document is changed.

Declaration
public virtual void DoOnDocumentChanging()
Implements

FocusCaret()

Focuses the caret.

Declaration
public abstract void FocusCaret()
Implements

GetCurrentPage()

Gets the number of the current page.

Declaration
public abstract int GetCurrentPage()
Returns
System.Int32

An integer number representing the number of the current page.

GetCurrentSectionBoundsInViewOverride()

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

Declaration
protected abstract Rect GetCurrentSectionBoundsInViewOverride()
Returns
Rect

GetDocumentPointFromViewPoint(Point)

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

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

Point containing X and Y coordinates in the viewport.
Returns
Point

A Point in the document.
Implements

GetDocumentPositionFromViewPoint(Point)

Gets a DocumentPosition from a Point in the viewport.

Declaration
public abstract DocumentPosition GetDocumentPositionFromViewPoint(Point viewPoint)
Parameters
Point viewPoint

Point containing X and Y coordinates in the viewport.
Returns
DocumentPosition

A DocumentPosition in the document.
Implements

GetDropPositionMarker()

Gets the drop marker for a drag and drop operation.

Declaration
protected abstract DropPositionMarker GetDropPositionMarker()
Returns
DropPositionMarker

A drop position marker.

GetValidScaleFactor(Double, Double)

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
System.Double width

The horizontal scale.
System.Double height

The vertical scale.
Returns
Size

The clamped scale factor.

GetViewPointFromDocumentPosition(DocumentPosition)

Gets a Point in the document from a DocumentPosition.

Declaration
public abstract Point GetViewPointFromDocumentPosition(DocumentPosition position)
Parameters
DocumentPosition position

A DocumentPosition in the document.
Returns
Point

A Point in the document.
Implements

HandlePageDown()

Called when the caret is moved a page down.

Declaration
public abstract void HandlePageDown()
Implements

HandlePageUp()

Called when the caret is moved a page up.

Declaration
public abstract void HandlePageUp()
Implements

HideCaret()

Hides the caret.

Declaration
public abstract void HideCaret()
Implements

HideDropMarker()

Hides the drop marker for a drag and drop operation.

Declaration
public void HideDropMarker()
Implements

InvalidateAndUpdateLayout(Boolean)

Invalidates and updates the presenter layout.

Declaration
protected void InvalidateAndUpdateLayout(bool recursive = false)
Parameters
System.Boolean recursive

true if sub elements should be invalidated and updated recursively, otherwise false.

InvalidateLayout(Boolean)

Invalidates the presenter layout.

Declaration
protected void InvalidateLayout(bool recursive = false)
Parameters
System.Boolean recursive

true if sub elements should be invalidated recursively, otherwise false.

InvalidatePresenterArrange()

Inavlidates the arrange of the presenter.

Declaration
public void InvalidatePresenterArrange()
Implements

InvalidatePresenterArrangeOverride()

Called when an Invalidate arrange is made.

Declaration
protected virtual void InvalidatePresenterArrangeOverride()

InvalidatePresenterMeasure()

Invaldiates the measure of the presenter.

Declaration
public void InvalidatePresenterMeasure()
Implements

InvalidatePresenterMeasureOverride()

Called when an Invalidate measure is made.

Declaration
protected virtual void InvalidatePresenterMeasureOverride()

IsNavigationKey(Keys)

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

Declaration
protected bool IsNavigationKey(Keys key)
Parameters
System.Windows.Forms.Keys key

The keyboard key to test.
Returns
System.Boolean

true if the key is used in navigation, otherwise false.

MoveDropMarker(DocumentPosition)

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

Declaration
public void MoveDropMarker(DocumentPosition documentPosition)
Parameters
DocumentPosition documentPosition

The position of the drop marker.
Implements

OnOwnerChanged()

Called after the owner RadRichTextBox is changed.

Declaration
protected virtual void OnOwnerChanged()

OnOwnerChanging()

Called before the owner RadRichTextBox is cahnged.

Declaration
protected virtual void OnOwnerChanging()

RecreateUI()

Forces a recreation of all UI elements.

Declaration
public abstract void RecreateUI()
Implements

ScrollToHorizontalOffset(Double)

Moves the horizontal scroll bar to the specified offset.

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

The new offset.
Implements

ScrollToNote(Note)

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

Declaration
public abstract void ScrollToNote(Note note)
Parameters
Note note

The note to scroll to.
Implements

ScrollToVerticalOffset(Double)

Moves the vertical scroll bar to the specified offset.

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

The new offset.
Implements

SetCaretBlinking(Boolean)

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

Declaration
protected abstract void SetCaretBlinking(bool isBlinking)
Parameters
System.Boolean isBlinking

true if the caret will be blinking, otherwise false.

ShowCaret()

Shows the caret.

Declaration
public abstract void ShowCaret()
Implements

ShowDropMarker(DocumentPosition)

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

Declaration
public void ShowDropMarker(DocumentPosition position)
Parameters
DocumentPosition position

The position of the drop marker.
Implements

UpdateCaretSize()

Updates the caret size.

Declaration
public abstract void UpdateCaretSize()
Implements

UpdateCurrentVisiblePage(Int32)

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

Declaration
protected void UpdateCurrentVisiblePage(int newValue)
Parameters
System.Int32 newValue

The number of the page to make visible.

UpdateCursorOnCtrlKey()

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

Declaration
public void UpdateCursorOnCtrlKey()

UpdateProofingTextDecoration()

Forces an update of the proofing UI layer.

Declaration
public abstract void UpdateProofingTextDecoration()
Implements

UpdateScrollBar(Double, Double, RadScrollBarElement, ScrollBarVisibility)

Updates the provided scroll bar.

Declaration
protected static void UpdateScrollBar(double viewportSize, double max, RadScrollBarElement scrollBar, ScrollBarVisibility suggestedVisibility)
Parameters
System.Double viewportSize

The current viewport size.
System.Double max

The new scroll bar maximum value.
RadScrollBarElement scrollBar

The scroll bar to update.
ScrollBarVisibility suggestedVisibility

The suggested visiblity for the scroll bar.

UpdateScrollOffsetFromDocumentPosition(DocumentPosition)

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

Declaration
public abstract void UpdateScrollOffsetFromDocumentPosition(DocumentPosition position)
Parameters
DocumentPosition position

The position to scroll to.
Implements

Explicit Interface Implementations

IDocumentEditorPresenter.GetCurrentSectionBoundsInView()

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

Declaration
Rect IDocumentEditorPresenter.GetCurrentSectionBoundsInView()
Returns
Rect

Implements

IDocumentEditorPresenter.UpdateLayout()

Declaration
void IDocumentEditorPresenter.UpdateLayout()
Implements

Extension Methods