New to Telerik UI for WinForms? Start a free 30-day trial

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:

C#
public abstract class CommentUIProviderBase : RadObject, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor

Inheritance: objectDisposableObjectRadObjectCommentUIProviderBase

Derived Classes: CommentEndUIProviderCommentStartUIProvider

Implements: ICustomTypeDescriptorIDisposableINotifyPropertyChanged

Inherited Members RadObject.BindingContextPropertyRadObject.RadTypeRadObject.ReplaceDefaultDescriptors(PropertyDescriptorCollection)RadObject.DisposeManagedResources()RadObject.ClearPropertyStore()RadObject.SuspendPropertyNotifications()RadObject.ResumePropertyNotifications()RadObject.GetPropertyValue(RadProperty)RadObject.SetDefaultValueOverride(RadProperty, object)RadObject.GetValue(RadProperty)RadObject.SetValue(RadProperty, object)RadObject.ResetValue(RadProperty)RadObject.ResetLocalValue(RadProperty)RadObject.ResetValue(RadProperty, ValueResetFlags)RadObject.UpdateValue(RadProperty)RadObject.GetValueSource(RadProperty)RadObject.GetRegisteredRadProperty(string)RadObject.UpdateValueCore(RadPropertyValue)RadObject.SetValueCore(RadPropertyValue, object, object, ValueSource)RadObject.ResetValueCore(RadPropertyValue, ValueResetFlags)RadObject.GetDefaultValue(RadPropertyValue, object)RadObject.CoerceValue(RadPropertyValue, object)RadObject.ShouldSerializeProperty(RadProperty)RadObject.CanRaisePropertyChangeNotifications(RadPropertyValue)RadObject.BindProperty(RadProperty, RadObject, RadProperty, PropertyBindingOptions)RadObject.UnbindProperty(RadProperty)RadObject.AddStylePropertySetting(IPropertySetting)RadObject.GetInheritedValue(RadProperty)RadObject.OnPropertyChanging(RadPropertyChangingEventArgs)RadObject.OnPropertyChanged(RadPropertyChangedEventArgs)RadObject.OnNotifyPropertyChanged(string)RadObject.OnNotifyPropertyChanged(PropertyChangedEventArgs)RadObject.OnShouldSerializeProperty(ShouldSerializePropertyEventArgs)RadObject.IsPropertyCancelable(RadPropertyMetadata)RadObject.PropertyValuesRadObject.PropertyFilterRadObject.RadObjectTypeRadObject.BindingContextRadObject.PropertyChangedRadObject.RadPropertyChangedRadObject.RadPropertyChangingDisposableObject.GetBitState(long)DisposableObject.SetBitState(long, bool)DisposableObject.OnBitStateChanged(long, bool, bool)DisposableObject.Dispose()DisposableObject.Dispose(bool)DisposableObject.PerformDispose(bool)DisposableObject.DisposeUnmanagedResources()DisposableObject.BitStateDisposableObject.EventsDisposableObject.IsDisposingDisposableObject.IsDisposedDisposableObject.DisposedDisposableObject.Disposing...

Constructors

C#
protected CommentUIProviderBase()

Methods

Positions one of the provider's visuals relative to its comment marker and section.

C#
public abstract void ArrangeUIElement(IUILayerContainer pagePresenter, CommentsPaneLayout layout, FrameworkElement element, AnnotationMarkerLayoutBox box, SectionLayoutBox sectionBox, PointF pointF)
Parameters:pagePresenterIUILayerContainer

The presenter that hosts the comments pane.

layoutCommentsPaneLayout

The layout of the comments pane.

elementFrameworkElement

The visual to position.

boxAnnotationMarkerLayoutBox

The layout box for the associated comment marker.

sectionBoxSectionLayoutBox

The section containing the marker.

pointFPointF

The view offset used to convert document coordinates to layer coordinates.

Creates the visuals for a comment range marker.

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

The presenter that hosts the comments pane.

boxAnnotationMarkerLayoutBox

The layout box for the comment range marker.

poolObjectPool

The pool available for reusing visual elements.

viewPortRectangleF

The 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.

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

The visual being detached.

Creates the polyline used to bracket a comment marker. In debug builds, an unpaired marker is colored blue.

C#
protected FrameworkElement GetBorderBracket(AnnotationMarkerLayoutBox marker)
Parameters:markerAnnotationMarkerLayoutBox

The comment marker whose layout box is being bracketed.

Returns:

FrameworkElement

A polyline visual positioned by the provider.

Determines whether the layer should create visuals for the specified comment marker.

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

The layout of the comments pane.

annotationMarkerBoxAnnotationMarkerLayoutBox

The layout box for the comment marker.

sectionBoxSectionLayoutBox

The section containing the marker.

viewPortRectangleF

The visible document area.

viewOffsetPointF

The offset between document and layer coordinates.

Returns:

bool

true if the layer should create visuals for the marker; otherwise, false.

Updates a comment visual after the marker, comment, or layout has changed.

C#
public abstract void UpdateUIElement(IUILayerContainer uiLayerContainer, CommentsPaneLayout commentPaneLayout, FrameworkElement element, AnnotationMarkerLayoutBox annotationMarkerBox, SectionLayoutBox sectionBox, PointF pointF)
Parameters:uiLayerContainerIUILayerContainer

The presenter that hosts the comments pane.

commentPaneLayoutCommentsPaneLayout

The current layout of the comments pane.

elementFrameworkElement

The visual to update.

annotationMarkerBoxAnnotationMarkerLayoutBox

The layout box for the associated comment marker.

sectionBoxSectionLayoutBox

The section containing the marker.

pointFPointF

The offset between document and layer coordinates.