IDocumentEditorPresenter
Represents the interface for a document editor presenter in the Telerik UI library.
Definition
Namespace:Telerik.Windows.Controls
Assembly:Telerik.Windows.Controls.RichTextBox.dll
Syntax:
public interface IDocumentEditorPresenterDerived Classes:
Properties
HorizontalAlignment
HorizontalAlignment
Gets or sets the horizontal alignment of the document editor presenter.
HorizontalAlignment HorizontalAlignment { get; set; }A value of the HorizontalAlignment enumeration that specifies how the content is aligned horizontally within the document editor presenter.
Gets the horizontal offset of the document editor presenter.
double HorizontalOffset { get; }The horizontal offset as a double value, representing the distance in pixels from the left edge.
Gets a value indicating whether the document editor is currently focused.
bool IsFocused { get; }Gets the owner of the document editor presenter.
Gets the height that can be scrolled in the document editor.
double ScrollableHeight { get; }Gets the width available for scrolling within the document editor.
double ScrollableWidth { get; }Gets the vertical offset of the document editor presenter.
double VerticalOffset { get; }A double representing the vertical offset in pixels.
Gets the height of the viewport for the document editor presenter.
double ViewportHeight { get; }Gets the width of the viewport in the document editor presenter.
double ViewportWidth { get; }Methods
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.
void DoOnDocumentChanged()Initiates the document changing process, allowing for any necessary actions to be performed before the document content changes.
void DoOnDocumentChanging()Moves the focus to the caret position within the document editor.
void FocusCaret()Gets the bounding rectangle of the current section in the view.
Rect GetCurrentSectionBoundsInView()Rect
A Rect representing the dimensions and position of the current section in the view.
Converts a specified screen point to a document point within the document editor.
Point GetDocumentPointFromViewPoint(Point viewPoint)The point in the screen coordinates that needs to be converted.
Returns:Point
A Point representing the corresponding document point in the document editor.
Retrieves the document position based on the specified view point.
DocumentPosition GetDocumentPositionFromViewPoint(Point viewPoint)The point in the view from which to get the document position.
Returns:The corresponding document position as a DocumentPosition object that represents the location in the document.
Retrieves the view point corresponding to the specified document position in the document editor.
Point GetViewPointFromDocumentPosition(DocumentPosition position)The document position for which the view point is to be retrieved.
Returns:Point
The view point associated with the given document position.
Handles the Page Down command, allowing the user to navigate down one page in the document.
void HandlePageDown()Handles the Page Up key event to navigate to the previous page within the document editor.
void HandlePageUp()Hides the caret in the document editor presenter.
void HideCaret()Hides the currently displayed drop marker in the document editor.
void HideDropMarker()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.
Invalidates the layout of the presenter, forcing it to re-arrange its contents.
void InvalidatePresenterArrange()Invalidates the measure of the document editor presenter, forcing a recalculation of its layout.
void InvalidatePresenterMeasure()Moves the drop marker to the specified document position.
void MoveDropMarker(DocumentPosition position)The document position to which the drop marker should be moved.
Recreates the user interface for the document editor presenter.
void RecreateUI()Scrolls to the specified horizontal offset in the document editor.
void ScrollToHorizontalOffset(double offset)The horizontal offset to scroll to, in device-independent pixels.
Scrolls the document view to the specified note.
void ScrollToNote(Note note)The note to which the document view should scroll.
Scrolls the document view to the specified vertical offset.
void ScrollToVerticalOffset(double offset)The vertical offset in device-independent units (1/96 inch per unit) to which the document view should scroll.
Displays the caret at the current position within the document editor.
void ShowCaret()Displays a drop marker at the specified document position.
void ShowDropMarker(DocumentPosition position)The document position where the drop marker should be shown.
Updates the properties of the caret in the document editor.
void UpdateCaretProperties()Updates the size of the caret within the document editor presenter.
void UpdateCaretSize()Updates the layout of the document editor presenter.
void UpdateLayout()Updates the proofing text decoration in the document editor.
void UpdateProofingTextDecoration()Updates the scroll offset of the document editor presenter based on the specified document position.
void UpdateScrollOffsetFromDocumentPosition(DocumentPosition documentPosition)The document position from which to calculate the new scroll offset.