Creates and manages the visuals associated with comment range markers in the comments pane.
Definition
Namespace:Telerik.WinForms.Documents.Model
Assembly:Telerik.WinControls.RichTextEditor.dll
Syntax:
public abstract class CommentUIProviderBase : RadObject, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor
Inheritance: objectDisposableObjectRadObjectCommentUIProviderBase
Derived Classes:
Implements:
Inherited Members
Constructors
protected CommentUIProviderBase()
Methods
Positions one of the provider's visuals relative to its comment marker and section.
public abstract void ArrangeUIElement(IUILayerContainer pagePresenter, CommentsPaneLayout layout, FrameworkElement element, AnnotationMarkerLayoutBox box, SectionLayoutBox sectionBox, PointF pointF)
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.
pointFPointFThe view offset used to convert document coordinates to layer coordinates.
Creates the visuals for a comment range marker.
public abstract 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.
Notifies the provider that one of its visuals is being detached from the comments layer.
public virtual void ElementRemovingFromUI(FrameworkElement element)
The visual being detached.
Creates the polyline used to bracket a comment marker. In debug builds, an unpaired marker is colored blue.
protected FrameworkElement GetBorderBracket(AnnotationMarkerLayoutBox marker)
The comment marker whose layout box is being bracketed.
Returns:A polyline visual positioned by the provider.
Determines whether the layer should create visuals for the specified comment marker.
public virtual 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.
Updates a comment visual after the marker, comment, or layout has changed.
public abstract void UpdateUIElement(IUILayerContainer uiLayerContainer, CommentsPaneLayout commentPaneLayout, FrameworkElement element, AnnotationMarkerLayoutBox annotationMarkerBox, SectionLayoutBox sectionBox, PointF pointF)
The presenter that hosts the comments pane.
commentPaneLayoutCommentsPaneLayoutThe current layout of the comments pane.
elementFrameworkElementThe visual to update.
annotationMarkerBoxAnnotationMarkerLayoutBoxThe layout box for the associated comment marker.
sectionBoxSectionLayoutBoxThe section containing the marker.
pointFPointFThe offset between document and layer coordinates.