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

Creates the bracket visual at the start of each comment range.

Definition

Namespace:Telerik.WinForms.Documents.Model

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

C#
public class CommentStartUIProvider : CommentUIProviderBase, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor

Inheritance: objectDisposableObjectRadObjectCommentUIProviderBaseCommentStartUIProvider

Implements: ICustomTypeDescriptorIDisposableINotifyPropertyChanged

Inherited Members CommentUIProviderBase.GetBorderBracket(AnnotationMarkerLayoutBox)CommentUIProviderBase.ElementRemovingFromUI(FrameworkElement)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#
public CommentStartUIProvider()

Properties

Gets the shared provider used for comment start markers.

C#
public static CommentUIProviderBase Instance { get; }

Methods

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

C#
public override void ArrangeUIElement(IUILayerContainer pagePresenter, CommentsPaneLayout layout, FrameworkElement element, AnnotationMarkerLayoutBox box, SectionLayoutBox sectionBox, PointF viewOffset)
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.

viewOffsetPointF

Overrides: CommentUIProviderBase.ArrangeUIElement(IUILayerContainer, CommentsPaneLayout, FrameworkElement, AnnotationMarkerLayoutBox, SectionLayoutBox, PointF)

Places the bracket immediately before the inline following the start marker.

Creates the visuals for a comment range marker.

C#
public override 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.

Overrides: CommentUIProviderBase.CreateUIElements(IUILayerContainer, AnnotationMarkerLayoutBox, ObjectPool, RectangleF)

Creates a single bracket polyline for the marker.

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

C#
public override 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.

Overrides: CommentUIProviderBase.HasVisibleElements(CommentsPaneLayout, AnnotationMarkerLayoutBox, SectionLayoutBox, RectangleF, PointF)

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.

C#
public override void UpdateUIElement(IUILayerContainer pagePresenter, CommentsPaneLayout layout, FrameworkElement element, AnnotationMarkerLayoutBox annotationMarkerBox, SectionLayoutBox sectionBox, PointF viewOffset)
Parameters:pagePresenterIUILayerContainerlayoutCommentsPaneLayoutelementFrameworkElement

The visual to update.

annotationMarkerBoxAnnotationMarkerLayoutBox

The layout box for the associated comment marker.

sectionBoxSectionLayoutBox

The section containing the marker.

viewOffsetPointF

Overrides: CommentUIProviderBase.UpdateUIElement(IUILayerContainer, CommentsPaneLayout, FrameworkElement, AnnotationMarkerLayoutBox, SectionLayoutBox, PointF)

The bracket follows the line after the start marker and uses the comment's configured border brush.