ClassCommentEndUIProvider
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:
public class CommentEndUIProvider : CommentUIProviderBaseInheritance: objectCommentUIProviderBaseCommentEndUIProvider
Inherited Members
Constructors
CommentEndUIProvider()
Declaration
public CommentEndUIProvider()Properties
Instance
Gets the singleton instance of the CommentEndUIProvider.
Declaration
public static CommentUIProviderBase Instance { get; }Property Value
Methods
ArrangeUIElement(IUILayerContainer, CommentsPaneLayout, FrameworkElement, AnnotationMarkerLayoutBox, SectionLayoutBox, PointF)
Arranges the UI element for the comment end based on the specified layout parameters.
Declaration
public override void ArrangeUIElement(IUILayerContainer pagePresenter, CommentsPaneLayout layout, FrameworkElement element, AnnotationMarkerLayoutBox annotationMarkerBox, SectionLayoutBox sectionBox, PointF viewOffset)Parameters
pagePresenter
The UI layer container that holds the UI elements.
layout
The layout settings for the comments pane.
element
FrameworkElement
The framework element to be arranged.
annotationMarkerBox
The layout box for the annotation marker.
sectionBox
The layout box for the section.
viewOffset
The point at which to position the UI element.
Overrides
CreateUIElements(IUILayerContainer, AnnotationMarkerLayoutBox, ObjectPool, RectangleF)
Creates UI elements for the comment end marker in the specified layout box.
Declaration
public override IEnumerable<FrameworkElement> CreateUIElements(IUILayerContainer pagePresenter, AnnotationMarkerLayoutBox markerBox, ObjectPool pool, RectangleF viewPort)Parameters
pagePresenter
The container that provides the UI layer for rendering the elements.
markerBox
The layout box where the annotation marker is positioned.
pool
The pool of reusable UI objects to optimize performance.
viewPort
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
ElementRemovingFromUI(FrameworkElement)
Notifies the provider that a UI element is being removed from the comment end.
Declaration
public override void ElementRemovingFromUI(FrameworkElement element)Parameters
element
FrameworkElement
The FrameworkElement that is being removed from the UI.
Overrides
HasVisibleElements(CommentsPaneLayout, AnnotationMarkerLayoutBox, SectionLayoutBox, RectangleF, PointF)
Determines whether there are visible elements in the specified comments pane layout and annotation marker layout.
Declaration
public override bool HasVisibleElements(CommentsPaneLayout layout, AnnotationMarkerLayoutBox annotationMarkerBox, SectionLayoutBox sectionBox, RectangleF viewPort, PointF viewOffset)Parameters
layout
The comments pane layout to check for visible elements.
annotationMarkerBox
The layout box of the annotation marker.
sectionBox
The layout box of the section.
viewPort
The rectangle that defines the area of interest.
viewOffset
The point that is checked against the visible elements.
Returns
Returns true if there are visible elements; otherwise, false.
Overrides
UpdateUIElement(IUILayerContainer, CommentsPaneLayout, FrameworkElement, AnnotationMarkerLayoutBox, SectionLayoutBox, PointF)
Updates the user interface element for a comment based on the provided parameters.
Declaration
public override void UpdateUIElement(IUILayerContainer pagePresenter, CommentsPaneLayout layout, FrameworkElement element, AnnotationMarkerLayoutBox annotationMarkerBox, SectionLayoutBox sectionBox, PointF viewOffset)Parameters
pagePresenter
The container that holds the UI elements.
layout
The layout of the comments pane.
element
FrameworkElement
The framework element representing the comment.
annotationMarkerBox
The layout box for the annotation marker.
sectionBox
The layout box for the section.
viewOffset
The point at which to update the UI element.
Overrides