Class
DocumentWebLayoutPresenter

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:

cs-api-definition
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

DocumentWebLayoutPresenter()

Declaration

cs-api-definition
public DocumentWebLayoutPresenter()

Properties

CaretTextInputHandler

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

Declaration

cs-api-definition
public CaretTextInputHandler CaretTextInputHandler { get; set; }

Property Value

CaretTextInputHandler

IsFocused

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

Declaration

cs-api-definition
public override bool IsFocused { get; }

Property Value

bool

Overrides DocumentPresenterBase.IsFocused

ScrollableHeight

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

Declaration

cs-api-definition
public override double ScrollableHeight { get; }

Property Value

double

Overrides DocumentPresenterBase.ScrollableHeight

ScrollableWidth

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

Declaration

cs-api-definition
public override double ScrollableWidth { get; }

Property Value

double

Overrides DocumentPresenterBase.ScrollableWidth

UILayers

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

Declaration

cs-api-definition
public UILayerStack UILayers { get; }

Property Value

UILayerStack

Implements IUILayerContainer.UILayers

Methods

ArrangeOverride(Size)

Declaration

cs-api-definition
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

cs-api-definition
public override void DoOnDocumentChanged()

Overrides DocumentPresenterBase.DoOnDocumentChanged()

DoOnDocumentChanging()

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

Declaration

cs-api-definition
public override void DoOnDocumentChanging()

Overrides DocumentPresenterBase.DoOnDocumentChanging()

FocusCaret()

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

Declaration

cs-api-definition
public override void FocusCaret()

Overrides DocumentPresenterBase.FocusCaret()

GetCurrentPage()

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

Declaration

cs-api-definition
public override int GetCurrentPage()

Returns

int

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

Overrides DocumentPresenterBase.GetCurrentPage()

GetCurrentSectionBoundsInViewOverride()

Declaration

cs-api-definition
protected override Rect GetCurrentSectionBoundsInViewOverride()

Returns

Rect

Overrides DocumentPresenterBase.GetCurrentSectionBoundsInViewOverride()

GetDocumentPointFromViewPoint(Point)

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

Declaration

cs-api-definition
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 DocumentPresenterBase.GetDocumentPointFromViewPoint(Point)

GetDocumentPositionFromViewPoint(Point)

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

Declaration

cs-api-definition
public override DocumentPosition GetDocumentPositionFromViewPoint(Point viewPoint)

Parameters

viewPoint

Point

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)

GetDropPositionMarker()

Declaration

cs-api-definition
protected override DropPositionMarker GetDropPositionMarker()

Returns

DropPositionMarker

Overrides DocumentPresenterBase.GetDropPositionMarker()

GetViewPointFromDocumentPosition(DocumentPosition)

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

Declaration

cs-api-definition
public override Point GetViewPointFromDocumentPosition(DocumentPosition position)

Parameters

position

DocumentPosition

The document position from which to retrieve the viewpoint.

Returns

Point

A Point representing the viewpoint in the document layout.

Overrides DocumentPresenterBase.GetViewPointFromDocumentPosition(DocumentPosition)

HandlePageDown()

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

Declaration

cs-api-definition
public override void HandlePageDown()

Overrides DocumentPresenterBase.HandlePageDown()

HandlePageUp()

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

Declaration

cs-api-definition
public override void HandlePageUp()

Overrides DocumentPresenterBase.HandlePageUp()

HideCaret()

Hides the caret in the document web layout presenter.

Declaration

cs-api-definition
public override void HideCaret()

Overrides DocumentPresenterBase.HideCaret()

IsLayerSupported(IUILayer)

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

Declaration

cs-api-definition
public bool IsLayerSupported(IUILayer layer)

Parameters

layer

IUILayer

The user interface layer to check for support.

Returns

bool

True if the layer is supported; otherwise, false.

Implements IUILayerContainer.IsLayerSupported(IUILayer)

MeasureOverride(Size)

Declaration

cs-api-definition
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

cs-api-definition
public override void OnApplyTemplate()

OnInitialized(EventArgs)

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

Declaration

cs-api-definition
protected override void OnInitialized(EventArgs e)

Parameters

e

EventArgs

The RoutedEventArgs that contains the event data.

OnOwnerChanged()

Declaration

cs-api-definition
protected override void OnOwnerChanged()

Overrides DocumentPresenterBase.OnOwnerChanged()

OnOwnerChanging()

Declaration

cs-api-definition
protected override void OnOwnerChanging()

Overrides DocumentPresenterBase.OnOwnerChanging()

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

cs-api-definition
public override void RecreateUI()

Overrides DocumentPresenterBase.RecreateUI()

ScrollToNote(Note)

Scrolls the view to the specified note within the document.

Declaration

cs-api-definition
public override void ScrollToNote(Note note)

Parameters

note

Note

The note to which the view will scroll.

Overrides DocumentPresenterBase.ScrollToNote(Note)

SetCaretBlinking(bool)

Declaration

cs-api-definition
protected override void SetCaretBlinking(bool isBlinking)

Parameters

isBlinking

bool

Overrides DocumentPresenterBase.SetCaretBlinking(bool)

ShowCaret()

Displays the caret in the document web layout presenter.

Declaration

cs-api-definition
public override void ShowCaret()

Overrides DocumentPresenterBase.ShowCaret()

UpdateCaretProperties()

Updates the caret properties in the document web layout presenter.

Declaration

cs-api-definition
public override void UpdateCaretProperties()

Overrides DocumentPresenterBase.UpdateCaretProperties()

UpdateCaretSize()

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

Declaration

cs-api-definition
public override void UpdateCaretSize()

Overrides DocumentPresenterBase.UpdateCaretSize()

UpdateProofingTextDecoration()

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

Declaration

cs-api-definition
public override void UpdateProofingTextDecoration()

Overrides DocumentPresenterBase.UpdateProofingTextDecoration()

UpdateScrollOffsetFromDocumentPosition(DocumentPosition)

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

Declaration

cs-api-definition
public override void UpdateScrollOffsetFromDocumentPosition(DocumentPosition position)

Parameters

position

DocumentPosition

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

Overrides DocumentPresenterBase.UpdateScrollOffsetFromDocumentPosition(DocumentPosition)