Creates the bracket visual at the start of each comment range.
Definition
Namespace:Telerik.WinForms.Documents.Model
Assembly:Telerik.WinControls.RichTextEditor.dll
Syntax:
public class CommentStartUIProvider : CommentUIProviderBase, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor
Inheritance: objectDisposableObjectRadObjectCommentUIProviderBaseCommentStartUIProvider
Implements:
Inherited Members
Constructors
public CommentStartUIProvider()
Properties
Gets the shared provider used for comment start 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 box, SectionLayoutBox sectionBox, PointF viewOffset)
The presenter that hosts the comments pane.
layoutCommentsPaneLayoutThe layout of the comments pane.
elementFrameworkElementThe visual to position.
boxAnnotationMarkerLayoutBoxThe layout box for the associated comment marker.
sectionBoxSectionLayoutBoxThe section containing the marker.
viewOffsetPointFOverrides:
Places the bracket immediately before the inline following the start marker.
Creates the visuals for a comment range marker.
public override IEnumerable<FrameworkElement> CreateUIElements(IUILayerContainer pagePresenter, AnnotationMarkerLayoutBox box, ObjectPool pool, RectangleF viewPort)
The presenter that hosts the comments pane.
boxAnnotationMarkerLayoutBoxThe layout box for the comment range marker.
poolObjectPoolThe 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:
Creates a single bracket polyline for the marker.
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 start; the bracket is 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:
The bracket follows the line after the start marker and uses the comment's configured border brush.