CommentsUILayer
Represents the UI layer for managing comments in Telerik documentation.
Definition
Namespace:Telerik.Windows.Documents.UI.Layers
Assembly:Telerik.Windows.Controls.RichTextBox.dll
Syntax:
public class CommentsUILayer : IUILayerInheritance: objectCommentsUILayer
Implements:
Constructors
public CommentsUILayer(IUILayerContainer pagePresenter)Properties
Gets or sets the current update context for the Comments UI layer.
public UILayerUpdateContext CurrentUpdateContext { get; }The current update context, which provides information and state for updates.
Gets or sets a value indicating whether the Comments User Interface (UI) layer is visible for hit testing. When set to true, the layer will respond to user interactions.
public bool IsHitTestVisible { get; set; }A boolean value that indicates the hit test visibility state of the Comments UI layer.
Implements:
Gets the name of the Comments UI Layer.
public virtual string Name { get; }Implements:
protected ObjectPool ObjectPool { get; }Gets an enumerable collection of providers from the Comments UI Layer.
public virtual IEnumerable<AnnotationMarkerLayoutBox> ProvidersEnumerable { get; }Determines whether the Comments UI Layer should clip its contents.
public virtual bool ShouldClip { get; }Implements:
Determines whether the Comments UI layer should update when it has not been invalidated.
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; }protected bool ViewOffsetChanged { get; }Gets the rectangle currently visible
protected RectangleF ViewPort { get; }protected bool ViewportChanged { get; }Methods
Adds a child element to the Comments UI Layer.
public void AddChild(FrameworkElement uiElement)The child FrameworkElement to be added to the layer.
Arranges the children of the Comments UI layer based on the current layout settings.
public void ArrangeChildren()Implements:
Clears all child elements from the Comments UI Layer.
public void ClearChildren()Implements:
This method removes all the comment-related visual elements from the UI layer, effectively resetting its state to an empty state.
Executes actions that need to be performed when the presentation changes.
public void DoOnPresentationChanged()Implements:
This method is typically called internally to update the UI and re-render the comment layers when there are changes to the presentation.
GetLayerUIElement()
UIElement
Retrieves the user interface element associated with the Comments UI layer.
public UIElement GetLayerUIElement()UIElement
The UI element of type T that represents the Comments layer.
Implements:
Removes a specified child element from the Comments UI Layer.
public void RemoveChild(FrameworkElement existingElement)The child element to be removed from the layer.
Unregisters a child user interface element from the comments UI layer.
public void UnregisterChildUIElement(FrameworkElement existingElement)The FrameworkElement that represents the child UI element to be unregistered.
protected virtual void UpdateUI()Updates the viewport for the Comments UI layer based on the specified position and bounds.
public void UpdateViewPort(PointF viewOffset, RectangleF viewPort, ObjectPool uiElementPool)A PointF representing the position of the viewport.
viewPortRectangleFA RectangleF defining the dimensions of the viewport.
uiElementPoolObjectPoolAn instance of ObjectPool used for managing objects within the Comments UI layer.
Updates the viewport to reflect changes in the specified rectangle.
public void UpdateViewPort(RectangleF viewPort)The rectangle defining the new viewport area.
Updates the viewport of the comment layer based on the specified update context.
public void UpdateViewPort(UILayerUpdateContext context)The context containing the information needed to update the viewport.
Implements: