ClassDocumentWebLayoutPresenter
Used by RadRichTextBox for presenting documents in "Web" LayoutMode (with no paging). See also DocumentPrintLayoutPresenter
Definition
Namespace:Telerik.Windows.Documents.UI
Assembly:Telerik.Windows.Controls.RichTextBox.dll
Syntax:
public class DocumentWebLayoutPresenter : DocumentPresenterBase, IDocumentEditorPresenter, IUILayerContainer
Inheritance: objectDocumentPresenterBaseDocumentWebLayoutPresenter
Derived Classes:
Implements:
Inherited Members
Constructors
DocumentWebLayoutPresenter()
Declaration
public DocumentWebLayoutPresenter()
Properties
CaretTextInputHandler
Gets or sets the CaretTextInputHandler that handles the input of the caret.
Declaration
public CaretTextInputHandler CaretTextInputHandler { get; set; }
Property Value
IsFocused
Gets a value indicating whether the document presenter is currently focused.
ScrollableHeight
Gets the height of the scrollable area in the document web layout presenter.
Declaration
public override double ScrollableHeight { get; }
Property Value
Overrides
ScrollableWidth
Gets the width of the scrollable area in the Document Web Layout Presenter.
Declaration
public override double ScrollableWidth { get; }
Property Value
Overrides
UILayers
Gets the user interface layers associated with the document web layout presenter.
Declaration
public UILayerStack UILayers { get; }
Property Value
Implements
Methods
ArrangeOverride(Size)
Declaration
protected override Size ArrangeOverride(Size finalSize)
Parameters
finalSize
Size
Returns
Size
DoOnDocumentChanged()
Executes actions when the document has changed in the web layout presenter.
Declaration
public override void DoOnDocumentChanged()
Overrides
DoOnDocumentChanging()
Executes a set of actions when the document is about to change.
Declaration
public override void DoOnDocumentChanging()
Overrides
FocusCaret()
Sets the focus to the caret within the document web layout presenter.
Declaration
public override void FocusCaret()
Overrides
GetCurrentPage()
Retrieves the current page displayed in the document web layout presenter.
Declaration
public override int GetCurrentPage()
Returns
The current page as an integer, representing the 1-based index of the page.
Overrides
GetCurrentSectionBoundsInViewOverride()
Declaration
protected override Rect GetCurrentSectionBoundsInViewOverride()
Returns
Rect
Overrides
GetDocumentPointFromViewPoint(Point)
Converts a specified point in the view to a point in the document coordinate system.
Declaration
public override Point GetDocumentPointFromViewPoint(Point viewPoint)
Parameters
viewPoint
Point
A Point representing the point in the view to be converted.
Returns
Point
A Point representing the corresponding point in the document coordinate system.
Overrides
GetDocumentPositionFromViewPoint(Point)
Retrieves the document position corresponding to a specified point in the view.
Declaration
public override DocumentPosition GetDocumentPositionFromViewPoint(Point viewPoint)
Parameters
viewPoint
Point
The point in the view for which to obtain the document position.
Returns
A DocumentPosition representing the document position that corresponds to the specified view point.
Overrides
GetDropPositionMarker()
Declaration
protected override DropPositionMarker GetDropPositionMarker()
Returns
Overrides
GetViewPointFromDocumentPosition(DocumentPosition)
Retrieves the viewpoint corresponding to a specific document position in the web layout.
Declaration
public override Point GetViewPointFromDocumentPosition(DocumentPosition position)
Parameters
position
The document position from which to retrieve the viewpoint.
Returns
Point
A Point representing the viewpoint in the document layout.
Overrides
HandlePageDown()
Handles the Page Down key event, scrolling the document view down by one page.
Declaration
public override void HandlePageDown()
Overrides
HandlePageUp()
Handles the Page Up key event, allowing navigation to the previous page in the document view.
Declaration
public override void HandlePageUp()
Overrides
HideCaret()
Hides the caret in the document web layout presenter.
Declaration
public override void HideCaret()
Overrides
IsLayerSupported(IUILayer)
Determines whether the specified user interface layer is supported by the document web layout presenter.
MeasureOverride(Size)
Declaration
protected override Size MeasureOverride(Size availableSize)
Parameters
availableSize
Size
Returns
Size
OnApplyTemplate()
Called when the template is applied to the DocumentWebLayoutPresenter. This method is responsible for initializing the presenter with the necessary templates and settings after they have been applied.
Declaration
public override void OnApplyTemplate()
OnInitialized(EventArgs)
Raises the event. This method is invoked whenever is set to true internally.
Declaration
protected override void OnInitialized(EventArgs e)
Parameters
e
The RoutedEventArgs that contains the event data.
OnOwnerChanged()
Declaration
protected override void OnOwnerChanged()
Overrides
OnOwnerChanging()
Declaration
protected override void OnOwnerChanging()
Overrides
RecreateUI()
Recreates the user interface for the document web layout presenter. This method refreshes the visual representation of the document, ensuring that any changes to the document or its properties are reflected in the UI.
Declaration
public override void RecreateUI()
Overrides
ScrollToNote(Note)
Scrolls the view to the specified note within the document.
Declaration
public override void ScrollToNote(Note note)
Parameters
note
The note to which the view will scroll.
Overrides
SetCaretBlinking(bool)
Declaration
protected override void SetCaretBlinking(bool isBlinking)
Parameters
isBlinking
Overrides
ShowCaret()
Displays the caret in the document web layout presenter.
Declaration
public override void ShowCaret()
Overrides
UpdateCaretProperties()
Updates the caret properties in the document web layout presenter.
Declaration
public override void UpdateCaretProperties()
Overrides
UpdateCaretSize()
Updates the size of the caret in the document web layout presenter.
Declaration
public override void UpdateCaretSize()
Overrides
UpdateProofingTextDecoration()
Updates the proofing text decoration in the document web layout presenter.
Declaration
public override void UpdateProofingTextDecoration()
Overrides
UpdateScrollOffsetFromDocumentPosition(DocumentPosition)
Updates the scroll offset in the document web layout presenter based on the specified document position.
Declaration
public override void UpdateScrollOffsetFromDocumentPosition(DocumentPosition position)
Parameters
position
The position in the document from which to update the scroll offset.
Overrides