CommentEndUIProvider
Creates and manages the bracket, connector, and balloon visuals at the end of each comment range.
Definition
Namespace:Telerik.WinForms.Documents.Model
Assembly:Telerik.WinControls.RichTextEditor.dll
Syntax:
public class CommentEndUIProvider : CommentUIProviderBase, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor
Inheritance: objectDisposableObjectRadObjectCommentUIProviderBaseCommentEndUIProvider
Implements:
Inherited Members
Constructors
public CommentEndUIProvider()
Properties
Gets the shared provider used for comment end markers.
public static CommentUIProviderBase Instance { get; }
Methods
Positions one of the provider's visuals relative to its comment marker and section.
public override void ArrangeUIElement(IUILayerContainer pagePresenter, CommentsPaneLayout layout, FrameworkElement element, AnnotationMarkerLayoutBox annotationMarkerBox, SectionLayoutBox sectionBox, PointF viewOffset)
The presenter that hosts the comments pane.
layoutCommentsPaneLayoutThe layout of the comments pane.
elementFrameworkElementThe visual to position.
annotationMarkerBoxAnnotationMarkerLayoutBoxsectionBoxSectionLayoutBoxThe section containing the marker.
viewOffsetPointFOverrides:
Positions balloons in the comments pane and places their bracket and connector beside the marker.
Creates the visuals for a comment range marker.
public override IEnumerable<FrameworkElement> CreateUIElements(IUILayerContainer pagePresenter, AnnotationMarkerLayoutBox markerBox, ObjectPool pool, RectangleF viewPort)
The presenter that hosts the comments pane.
markerBoxAnnotationMarkerLayoutBoxpoolObjectPoolThe pool available for reusing visual elements.
viewPortRectangleFThe visible document area for the current layer update.
Returns:IEnumerable<FrameworkElement>
The visuals associated with the marker.
Overrides:
If
poolis null, no visuals are created. Otherwise, the provider yields a bracket, a connector, and a pooled comment balloon.
Notifies the provider that one of its visuals is being detached from the comments layer.
public override void ElementRemovingFromUI(FrameworkElement element)
The visual being detached.
Overrides:
For a comment balloon, detaches its focus and body-change handlers and clears its read-only binding.
Determines whether the layer should create visuals for the specified comment marker.
public override bool HasVisibleElements(CommentsPaneLayout layout, AnnotationMarkerLayoutBox annotationMarkerBox, SectionLayoutBox sectionBox, RectangleF viewPort, PointF viewOffset)
The layout of the comments pane.
annotationMarkerBoxAnnotationMarkerLayoutBoxThe layout box for the comment marker.
sectionBoxSectionLayoutBoxThe section containing the marker.
viewPortRectangleFThe visible document area.
viewOffsetPointFThe offset between document and layer coordinates.
Returns:true if the layer should create visuals for the marker; otherwise, false.
Overrides:
Returns true for every comment end; its visuals are not culled by the viewport.
Updates a comment visual after the marker, comment, or layout has changed.
public override void UpdateUIElement(IUILayerContainer pagePresenter, CommentsPaneLayout layout, FrameworkElement element, AnnotationMarkerLayoutBox annotationMarkerBox, SectionLayoutBox sectionBox, PointF viewOffset)
The visual to update.
annotationMarkerBoxAnnotationMarkerLayoutBoxThe layout box for the associated comment marker.
sectionBoxSectionLayoutBoxThe section containing the marker.
viewOffsetPointFOverrides:
Updates the comment's bracket and connector; balloons receive the comment's configured brushes and are focused when their comment is selected.