Interface IDocumentEditorPresenter

Represents the interface for a document editor presenter in the Telerik UI library.

Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.RichTextBox.dll

Syntax

public interface IDocumentEditorPresenter

Properties

HorizontalAlignment

Gets or sets the horizontal alignment of the document editor presenter.

Declaration
HorizontalAlignment HorizontalAlignment { get; set; }
Property Value
System.Windows.HorizontalAlignment

A value of the HorizontalAlignment enumeration that specifies how the content is aligned horizontally within the document editor presenter.

HorizontalOffset

Gets the horizontal offset of the document editor presenter.

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

The horizontal offset as a double value, representing the distance in pixels from the left edge.

IsFocused

Gets a value indicating whether the document editor is currently focused.

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

Owner

Gets the owner of the document editor presenter.

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

The owner of type RadRichTextBox.

ScrollableHeight

Gets the height that can be scrolled in the document editor.

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

ScrollableWidth

Gets the width available for scrolling within the document editor.

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

VerticalOffset

Gets the vertical offset of the document editor presenter.

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

A double representing the vertical offset in pixels.

ViewportHeight

Gets the height of the viewport for the document editor presenter.

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

ViewportWidth

Gets the width of the viewport in the document editor presenter.

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

Methods

DoOnDocumentChanged()

Invoked when the document has been changed. This method is typically used to handle any necessary updates or processing required in response to document modifications.

Declaration
void DoOnDocumentChanged()

DoOnDocumentChanging()

Initiates the document changing process, allowing for any necessary actions to be performed before the document content changes.

Declaration
void DoOnDocumentChanging()

FocusCaret()

Moves the focus to the caret position within the document editor.

Declaration
void FocusCaret()

GetCurrentSectionBoundsInView()

Gets the bounding rectangle of the current section in the view.

Declaration
Rect GetCurrentSectionBoundsInView()
Returns
System.Windows.Rect

A System.Windows.Rect representing the dimensions and position of the current section in the view.

GetDocumentPointFromViewPoint(Point)

Converts a specified screen point to a document point within the document editor.

Declaration
Point GetDocumentPointFromViewPoint(Point viewPoint)
Parameters
System.Windows.Point viewPoint

The point in the screen coordinates that needs to be converted.
Returns
System.Windows.Point

A System.Windows.Point representing the corresponding document point in the document editor.

GetDocumentPositionFromViewPoint(Point)

Retrieves the document position based on the specified view point.

Declaration
DocumentPosition GetDocumentPositionFromViewPoint(Point viewPoint)
Parameters
System.Windows.Point viewPoint

The point in the view from which to get the document position.
Returns
DocumentPosition

The corresponding document position as a DocumentPosition object that represents the location in the document.

GetViewPointFromDocumentPosition(DocumentPosition)

Retrieves the view point corresponding to the specified document position in the document editor.

Declaration
Point GetViewPointFromDocumentPosition(DocumentPosition position)
Parameters
DocumentPosition position

The document position for which the view point is to be retrieved.
Returns
System.Windows.Point

The view point associated with the given document position.

HandlePageDown()

Handles the Page Down command, allowing the user to navigate down one page in the document.

Declaration
void HandlePageDown()

HandlePageUp()

Handles the Page Up key event to navigate to the previous page within the document editor.

Declaration
void HandlePageUp()

HideCaret()

Hides the caret in the document editor presenter.

Declaration
void HideCaret()

HideDropMarker()

Hides the currently displayed drop marker in the document editor.

Declaration
void HideDropMarker()
Remarks

This method is typically used during drag-and-drop operations to remove the visual indicator for where an item will be dropped, ensuring a clean user interface.

InvalidatePresenterArrange()

Invalidates the layout of the presenter, forcing it to re-arrange its contents.

Declaration
void InvalidatePresenterArrange()

InvalidatePresenterMeasure()

Invalidates the measure of the document editor presenter, forcing a recalculation of its layout.

Declaration
void InvalidatePresenterMeasure()

MoveDropMarker(DocumentPosition)

Moves the drop marker to the specified document position.

Declaration
void MoveDropMarker(DocumentPosition position)
Parameters
DocumentPosition position

The document position to which the drop marker should be moved.

RecreateUI()

Recreates the user interface for the document editor presenter.

Declaration
void RecreateUI()

ScrollToHorizontalOffset(Double)

Scrolls to the specified horizontal offset in the document editor.

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

The horizontal offset to scroll to, in device-independent pixels.

ScrollToNote(Note)

Scrolls the document view to the specified note.

Declaration
void ScrollToNote(Note note)
Parameters
Note note

The note to which the document view should scroll.

ScrollToVerticalOffset(Double)

Scrolls the document view to the specified vertical offset.

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

The vertical offset in device-independent units (1/96 inch per unit) to which the document view should scroll.

ShowCaret()

Displays the caret at the current position within the document editor.

Declaration
void ShowCaret()

ShowDropMarker(DocumentPosition)

Displays a drop marker at the specified document position.

Declaration
void ShowDropMarker(DocumentPosition position)
Parameters
DocumentPosition position

The document position where the drop marker should be shown.

UpdateCaretProperties()

Updates the properties of the caret in the document editor.

Declaration
void UpdateCaretProperties()

UpdateCaretSize()

Updates the size of the caret within the document editor presenter.

Declaration
void UpdateCaretSize()

UpdateLayout()

Updates the layout of the document editor presenter.

Declaration
void UpdateLayout()

UpdateProofingTextDecoration()

Updates the proofing text decoration in the document editor.

Declaration
void UpdateProofingTextDecoration()

UpdateScrollOffsetFromDocumentPosition(DocumentPosition)

Updates the scroll offset of the document editor presenter based on the specified document position.

Declaration
void UpdateScrollOffsetFromDocumentPosition(DocumentPosition documentPosition)
Parameters
DocumentPosition documentPosition

The document position from which to calculate the new scroll offset.

Extension Methods