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

Provides a UI provider for the end of a comment in the document model.

Definition

Namespace:Telerik.Windows.Documents.Model

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

C#
public class CommentEndUIProvider : CommentUIProviderBase

Inheritance: objectCommentUIProviderBaseCommentEndUIProvider

Inherited Members CommentUIProviderBase.GetBorderBracket(AnnotationMarkerLayoutBox)

Constructors

C#
public CommentEndUIProvider()

Properties

Gets the singleton instance of the CommentEndUIProvider.

C#
public static CommentUIProviderBase Instance { get; }

Methods

Arranges the UI element for the comment end based on the specified layout parameters.

C#
public override void ArrangeUIElement(IUILayerContainer pagePresenter, CommentsPaneLayout layout, FrameworkElement element, AnnotationMarkerLayoutBox annotationMarkerBox, SectionLayoutBox sectionBox, PointF viewOffset)
Parameters:pagePresenterIUILayerContainer

The UI layer container that holds the UI elements.

layoutCommentsPaneLayout

The layout settings for the comments pane.

elementFrameworkElement

The framework element to be arranged.

annotationMarkerBoxAnnotationMarkerLayoutBox

The layout box for the annotation marker.

sectionBoxSectionLayoutBox

The layout box for the section.

viewOffsetPointF

The point at which to position the UI element.

Overrides: CommentUIProviderBase.ArrangeUIElement(IUILayerContainer, CommentsPaneLayout, FrameworkElement, AnnotationMarkerLayoutBox, SectionLayoutBox, PointF)

Creates UI elements for the comment end marker in the specified layout box.

C#
public override IEnumerable<FrameworkElement> CreateUIElements(IUILayerContainer pagePresenter, AnnotationMarkerLayoutBox markerBox, ObjectPool pool, RectangleF viewPort)
Parameters:pagePresenterIUILayerContainer

The container that provides the UI layer for rendering the elements.

markerBoxAnnotationMarkerLayoutBox

The layout box where the annotation marker is positioned.

poolObjectPool

The pool of reusable UI objects to optimize performance.

viewPortRectangleF

The rectangle that defines the bounds for the UI elements to be created.

Returns:

IEnumerable<FrameworkElement>

A list of UI elements created for the comment end marker.

Overrides: CommentUIProviderBase.CreateUIElements(IUILayerContainer, AnnotationMarkerLayoutBox, ObjectPool, RectangleF)

Notifies the provider that a UI element is being removed from the comment end.

C#
public override void ElementRemovingFromUI(FrameworkElement element)
Parameters:elementFrameworkElement

The FrameworkElement that is being removed from the UI.

Overrides: CommentUIProviderBase.ElementRemovingFromUI(FrameworkElement)

Determines whether there are visible elements in the specified comments pane layout and annotation marker layout.

C#
public override bool HasVisibleElements(CommentsPaneLayout layout, AnnotationMarkerLayoutBox annotationMarkerBox, SectionLayoutBox sectionBox, RectangleF viewPort, PointF viewOffset)
Parameters:layoutCommentsPaneLayout

The comments pane layout to check for visible elements.

annotationMarkerBoxAnnotationMarkerLayoutBox

The layout box of the annotation marker.

sectionBoxSectionLayoutBox

The layout box of the section.

viewPortRectangleF

The rectangle that defines the area of interest.

viewOffsetPointF

The point that is checked against the visible elements.

Returns:

bool

Returns true if there are visible elements; otherwise, false.

Overrides: CommentUIProviderBase.HasVisibleElements(CommentsPaneLayout, AnnotationMarkerLayoutBox, SectionLayoutBox, RectangleF, PointF)

Updates the user interface element for a comment based on the provided parameters.

C#
public override void UpdateUIElement(IUILayerContainer pagePresenter, CommentsPaneLayout layout, FrameworkElement element, AnnotationMarkerLayoutBox annotationMarkerBox, SectionLayoutBox sectionBox, PointF viewOffset)
Parameters:pagePresenterIUILayerContainer

The container that holds the UI elements.

layoutCommentsPaneLayout

The layout of the comments pane.

elementFrameworkElement

The framework element representing the comment.

annotationMarkerBoxAnnotationMarkerLayoutBox

The layout box for the annotation marker.

sectionBoxSectionLayoutBox

The layout box for the section.

viewOffsetPointF

The point at which to update the UI element.

Overrides: CommentUIProviderBase.UpdateUIElement(IUILayerContainer, CommentsPaneLayout, FrameworkElement, AnnotationMarkerLayoutBox, SectionLayoutBox, PointF)