CommentsUILayer
Positions comment balloons and the comments pane alongside annotation markers in the current view.
Definition
Namespace:Telerik.WinForms.Documents.UI.Layers
Assembly:Telerik.WinControls.RichTextEditor.dll
Syntax:
public class CommentsUILayer : IUILayerInheritance: objectCommentsUILayer
Implements:
Constructors
Initializes the comments layer for the specified presenter.
public CommentsUILayer(IUILayerContainer pagePresenter)The presenter that owns the comments layer.
Properties
Gets the most recently supplied layer-update context.
public UILayerUpdateContext CurrentUpdateContext { get; }Gets or sets whether comment visuals in the layer's canvas participate in hit testing; this does not affect the comments pane.
public bool IsHitTestVisible { get; set; }Implements:
Gets the identifier used to register the comments layer.
public virtual string Name { get; }Implements:
Gets the object pool used to create and release comment visuals.
protected ObjectPool ObjectPool { get; }ProvidersEnumerable
IEnumerable<AnnotationMarkerLayoutBox>
Gets the comment annotation markers in the current page, or across the document for web layout.
public virtual IEnumerable<AnnotationMarkerLayoutBox> ProvidersEnumerable { get; }Gets whether the presenter clips this layer to the displayed section's bounds; this layer returns false.
public virtual bool ShouldClip { get; }Implements:
Gets whether this layer updates for viewport changes when it is not invalidated; the layer returns false.
public virtual bool ShouldUpdateWhenNotInvalidated { get; }Implements:
Offset of the view from the initial point (0, 0) generally related to scroll offset
public PointF ViewOffset { get; }Gets whether the view offset changed during the most recent viewport update.
protected bool ViewOffsetChanged { get; }Gets the rectangle currently visible
protected RectangleF ViewPort { get; }Gets whether the viewport rectangle changed during the most recent viewport update.
protected bool ViewportChanged { get; }Methods
Adds a comment visual, first removing it from another comments layer when necessary.
public void AddChild(FrameworkElement uiElement)The comment visual to add.
Positions the comments pane and comment balloons for the visible section boxes.
public void ArrangeChildren()Implements:
Unregisters and releases all comment visuals and clears tracked layout boxes.
public void ClearChildren()Implements:
Invalidates comments-pane measurement and the editor layout of visible comment balloons.
public void DoOnPresentationChanged()Implements:
Gets the root visual containing the comments pane and comment balloons.
public UIElement GetLayerUIElement()The canvas representing this layer.
Implements:
Unregisters a comment visual and removes it from the layer's canvas.
public void RemoveChild(FrameworkElement existingElement)The comment visual to remove.
Removes a visual's association with its annotation marker and notifies its comment provider.
public void UnregisterChildUIElement(FrameworkElement existingElement)The comment visual being detached.
Lays out the comments pane and creates, updates, or removes visible comment balloons.
protected virtual void UpdateUI()Updates the view offset, visible rectangle, and object pool used by subsequent comment layout.
public void UpdateViewPort(PointF viewOffset, RectangleF viewPort, ObjectPool uiElementPool)The document-space offset of the view.
viewPortRectangleFThe visible rectangle in document coordinates.
uiElementPoolObjectPoolThe pool used for comment visuals.
Recalculates visible comment visuals for the specified finite viewport.
public void UpdateViewPort(RectangleF viewPort)The visible rectangle in document coordinates.
Stores the current presenter context and updates comment visuals for its viewport.
public void UpdateViewPort(UILayerUpdateContext context)The current layer-update context.
Implements: