IDocumentEditorPresenter
Defines the view, caret, selection, and scrolling operations required by a document presenter.
The print presenter also implements this interface for rendering, but does not provide interactive caret, scroll-offset, or hit-testing behavior.
Definition
Namespace:Telerik.WinForms.RichTextEditor
Assembly:Telerik.WinControls.RichTextEditor.dll
Syntax:
public interface IDocumentEditorPresenter : IDisposable
Inherited Members
Properties
Gets or sets the horizontal alignment of the presenter in its host.
HorizontalAlignment HorizontalAlignment { get; set; }
Gets the current horizontal scroll offset in document coordinates.
double HorizontalOffset { get; }
Gets or sets the RadRichTextBox whose document is displayed by this presenter.
RadRichTextBox Owner { get; set; }
Gets the height of the presenter's scrollable document content.
double ScrollableHeight { get; }
Gets the width of the presenter's scrollable document content.
double ScrollableWidth { get; }
Gets the current vertical scroll offset in document coordinates.
double VerticalOffset { get; }
Gets the height of the visible presenter viewport.
double ViewportHeight { get; }
Gets the width of the visible presenter viewport.
double ViewportWidth { get; }
Methods
Reinitializes presenter state and document-position handlers after the owner's document changes.
void DoOnDocumentChanged()
Detaches presenter state and document-position handlers before the owner's document changes.
void DoOnDocumentChanging()
Gives keyboard focus to the insertion caret.
void FocusCaret()
Gets the bounds of the section containing the caret in presenter coordinates.
Converts a point in the presenter viewport to document coordinates, accounting for scrolling and scaling.
Point GetDocumentPointFromViewPoint(Point viewPoint)
A point relative to the presenter's viewport.
Returns:The corresponding point in document coordinates.
Exceptions: NotImplementedExceptionThe presenter is rendering the print view.
Converts a point in the presenter viewport to the corresponding document position.
DocumentPosition GetDocumentPositionFromViewPoint(Point viewPoint)
A point relative to the presenter's viewport.
Returns:The document position under the point.
Exceptions: NotImplementedExceptionThe presenter is rendering the print view.
Converts a document position to a point in the presenter's viewport.
Point GetViewPointFromDocumentPosition(DocumentPosition position)
The document position to convert.
Returns:The viewport point corresponding to the position.
Moves the caret down by approximately one viewport page.
void HandlePageDown()
Moves the caret up by approximately one viewport page.
void HandlePageUp()
Hides the insertion caret.
void HideCaret()
Hides the drag-and-drop insertion marker.
void HideDropMarker()
Invalidates the presenter's arrangement so its children are repositioned.
void InvalidatePresenterArrange()
Invalidates the presenter's measurement so its desired size is recalculated.
void InvalidatePresenterMeasure()
Moves the drag-and-drop insertion marker to another document position.
void MoveDropMarker(DocumentPosition position)
The new insertion position.
Rebuilds the presenter's visual elements for its current owner document.
void RecreateUI()
Scrolls the presenter to the specified horizontal content offset.
void ScrollToHorizontalOffset(double offset)
The horizontal offset to apply.
Exceptions: ArgumentOutOfRangeExceptionThe offset is NaN.
NotSupportedExceptionThe presenter is rendering a print view.
Scrolls the viewport until the specified note is visible.
Scrolls the presenter to the specified vertical content offset.
void ScrollToVerticalOffset(double offset)
The vertical offset to apply.
Exceptions: ArgumentOutOfRangeExceptionThe offset is NaN.
NotSupportedExceptionThe presenter is rendering a print view.
Makes the insertion caret visible.
void ShowCaret()
Displays the drag-and-drop insertion marker at a document position.
void ShowDropMarker(DocumentPosition position)
The position where content would be inserted.
Refreshes caret-specific visual and input settings from the owner.
void UpdateCaretProperties()
Recalculates the caret's dimensions for the current document position and zoom.
void UpdateCaretSize()
Immediately processes pending layout changes for the presenter.
void UpdateLayout()
Refreshes the presenter's proofing text-decorations layer.
void UpdateProofingTextDecoration()
Updates the scroll position to bring a document position into view.
void UpdateScrollOffsetFromDocumentPosition(DocumentPosition documentPosition)
The document position to reveal.