New to Telerik UI for WPFStart a free 30-day trial

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:

C#
public class DocumentWebLayoutPresenter : DocumentPresenterBase, IDocumentEditorPresenter, IUILayerContainer

Inheritance: objectDocumentPresenterBaseDocumentWebLayoutPresenter

Derived Classes: ShapeDocumentPresenter

Implements: IDocumentEditorPresenterIUILayerContainer

Inherited Members DocumentPresenterBase.DragMarginDocumentPresenterBase.InvalidatePresenterArrangeOverride()DocumentPresenterBase.InvalidatePresenterMeasureOverride()DocumentPresenterBase.OnPreviewKeyDown(KeyEventArgs)DocumentPresenterBase.OnKeyUp(KeyEventArgs)DocumentPresenterBase.ScrollToHorizontalOffset(double)DocumentPresenterBase.ScrollToVerticalOffset(double)DocumentPresenterBase.InvalidatePresenterArrange()DocumentPresenterBase.InvalidatePresenterMeasure()DocumentPresenterBase.OnGotFocus(RoutedEventArgs)DocumentPresenterBase.OnLostFocus(RoutedEventArgs)DocumentPresenterBase.ShowDropMarker(DocumentPosition)DocumentPresenterBase.MoveDropMarker(DocumentPosition)DocumentPresenterBase.HideDropMarker()DocumentPresenterBase.GetValidScaleFactor(double, double)DocumentPresenterBase.IsNavigationKey(Key)DocumentPresenterBase.InvalidateLayout()DocumentPresenterBase.InvalidateAndUpdateLayout()DocumentPresenterBase.UpdateScrollBar(double, double, ScrollBar, ScrollBarVisibility)DocumentPresenterBase.UpdateCurrentVisiblePage(int)DocumentPresenterBase.HorizontalOffsetDocumentPresenterBase.VerticalOffsetDocumentPresenterBase.ViewportHeightDocumentPresenterBase.ViewportWidthDocumentPresenterBase.VerticalScrollOffsetDocumentPresenterBase.HorizontalScrollOffsetDocumentPresenterBase.ScaleFactorDocumentPresenterBase.MouseSelectionHandlerDocumentPresenterBase.KeyboardSelectionHandlerDocumentPresenterBase.CaretPositionDocumentPresenterBase.Owner...

Constructors

C#
public DocumentWebLayoutPresenter()

Properties

Gets or sets the CaretTextInputHandler that handles the input of the caret.

C#
public CaretTextInputHandler CaretTextInputHandler { get; set; }

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

C#
public override bool IsFocused { get; }

Overrides: DocumentPresenterBase.IsFocused

Gets the height of the scrollable area in the document web layout presenter.

C#
public override double ScrollableHeight { get; }

Overrides: DocumentPresenterBase.ScrollableHeight

Gets the width of the scrollable area in the Document Web Layout Presenter.

C#
public override double ScrollableWidth { get; }

Overrides: DocumentPresenterBase.ScrollableWidth

Gets the user interface layers associated with the document web layout presenter.

C#
public UILayerStack UILayers { get; }

Implements: IUILayerContainer.UILayers

Methods

C#
protected override Size ArrangeOverride(Size finalSize)
Parameters:finalSizeSizeReturns:

Size

Executes actions when the document has changed in the web layout presenter.

C#
public override void DoOnDocumentChanged()

Overrides: DocumentPresenterBase.DoOnDocumentChanged()

Executes a set of actions when the document is about to change.

C#
public override void DoOnDocumentChanging()

Overrides: DocumentPresenterBase.DoOnDocumentChanging()

Sets the focus to the caret within the document web layout presenter.

C#
public override void FocusCaret()

Overrides: DocumentPresenterBase.FocusCaret()

Retrieves the current page displayed in the document web layout presenter.

C#
public override int GetCurrentPage()
Returns:

int

The current page as an integer, representing the 1-based index of the page.

Overrides: DocumentPresenterBase.GetCurrentPage()

C#
protected override Rect GetCurrentSectionBoundsInViewOverride()
Returns:

Rect

Overrides: DocumentPresenterBase.GetCurrentSectionBoundsInViewOverride()

Converts a specified point in the view to a point in the document coordinate system.

C#
public override Point GetDocumentPointFromViewPoint(Point viewPoint)
Parameters:viewPointPoint

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: DocumentPresenterBase.GetDocumentPointFromViewPoint(Point)

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

C#
public override DocumentPosition GetDocumentPositionFromViewPoint(Point viewPoint)
Parameters:viewPointPoint

The point in the view for which to obtain the document position.

Returns:

DocumentPosition

A DocumentPosition representing the document position that corresponds to the specified view point.

Overrides: DocumentPresenterBase.GetDocumentPositionFromViewPoint(Point)

C#
protected override DropPositionMarker GetDropPositionMarker()
Returns:

DropPositionMarker

Overrides: DocumentPresenterBase.GetDropPositionMarker()

Retrieves the viewpoint corresponding to a specific document position in the web layout.

C#
public override Point GetViewPointFromDocumentPosition(DocumentPosition position)
Parameters:positionDocumentPosition

The document position from which to retrieve the viewpoint.

Returns:

Point

A Point representing the viewpoint in the document layout.

Overrides: DocumentPresenterBase.GetViewPointFromDocumentPosition(DocumentPosition)

Handles the Page Down key event, scrolling the document view down by one page.

C#
public override void HandlePageDown()

Overrides: DocumentPresenterBase.HandlePageDown()

Handles the Page Up key event, allowing navigation to the previous page in the document view.

C#
public override void HandlePageUp()

Overrides: DocumentPresenterBase.HandlePageUp()

Hides the caret in the document web layout presenter.

C#
public override void HideCaret()

Overrides: DocumentPresenterBase.HideCaret()

Determines whether the specified user interface layer is supported by the document web layout presenter.

C#
public bool IsLayerSupported(IUILayer layer)
Parameters:layerIUILayer

The user interface layer to check for support.

Returns:

bool

True if the layer is supported; otherwise, false.

Implements: IUILayerContainer.IsLayerSupported(IUILayer)

C#
protected override Size MeasureOverride(Size availableSize)
Parameters:availableSizeSizeReturns:

Size

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.

C#
public override void OnApplyTemplate()

Raises the event. This method is invoked whenever is set to true internally.

C#
protected override void OnInitialized(EventArgs e)
Parameters:eEventArgs

The RoutedEventArgs that contains the event data.

C#
protected override void OnOwnerChanged()

Overrides: DocumentPresenterBase.OnOwnerChanged()

C#
protected override void OnOwnerChanging()

Overrides: DocumentPresenterBase.OnOwnerChanging()

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.

C#
public override void RecreateUI()

Overrides: DocumentPresenterBase.RecreateUI()

Scrolls the view to the specified note within the document.

C#
public override void ScrollToNote(Note note)
Parameters:noteNote

The note to which the view will scroll.

Overrides: DocumentPresenterBase.ScrollToNote(Note)

C#
protected override void SetCaretBlinking(bool isBlinking)
Parameters:isBlinkingbool

Overrides: DocumentPresenterBase.SetCaretBlinking(bool)

Displays the caret in the document web layout presenter.

C#
public override void ShowCaret()

Overrides: DocumentPresenterBase.ShowCaret()

Updates the caret properties in the document web layout presenter.

C#
public override void UpdateCaretProperties()

Overrides: DocumentPresenterBase.UpdateCaretProperties()

Updates the size of the caret in the document web layout presenter.

C#
public override void UpdateCaretSize()

Overrides: DocumentPresenterBase.UpdateCaretSize()

Updates the proofing text decoration in the document web layout presenter.

C#
public override void UpdateProofingTextDecoration()

Overrides: DocumentPresenterBase.UpdateProofingTextDecoration()

Updates the scroll offset in the document web layout presenter based on the specified document position.

C#
public override void UpdateScrollOffsetFromDocumentPosition(DocumentPosition position)
Parameters:positionDocumentPosition

The position in the document from which to update the scroll offset.

Overrides: DocumentPresenterBase.UpdateScrollOffsetFromDocumentPosition(DocumentPosition)