ClassCommentsUILayer
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
CommentsUILayer(IUILayerContainer)
Declaration
public CommentsUILayer(IUILayerContainer pagePresenter)Parameters
pagePresenter
Properties
CurrentUpdateContext
Gets or sets the current update context for the Comments UI layer.
Declaration
public UILayerUpdateContext CurrentUpdateContext { get; }Property Value
The current update context, which provides information and state for updates.
IsHitTestVisible
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.
Declaration
public bool IsHitTestVisible { get; set; }Property Value
A boolean value that indicates the hit test visibility state of the Comments UI layer.
Implements
Name
Gets the name of the Comments UI Layer.
ProvidersEnumerable
Gets an enumerable collection of providers from the Comments UI Layer.
Declaration
public virtual IEnumerable<AnnotationMarkerLayoutBox> ProvidersEnumerable { get; }Property Value
ShouldClip
Determines whether the Comments UI Layer should clip its contents.
Declaration
public virtual bool ShouldClip { get; }Property Value
Implements
ShouldUpdateWhenNotInvalidated
Determines whether the Comments UI layer should update when it has not been invalidated.
Declaration
public virtual bool ShouldUpdateWhenNotInvalidated { get; }Property Value
Implements
ViewOffset
Offset of the view from the initial point (0, 0) generally related to scroll offset
ViewPort
Gets the rectangle currently visible
Methods
AddChild(FrameworkElement)
Adds a child element to the Comments UI Layer.
Declaration
public void AddChild(FrameworkElement uiElement)Parameters
uiElement
FrameworkElement
The child FrameworkElement to be added to the layer.
ArrangeChildren()
Arranges the children of the Comments UI layer based on the current layout settings.
Declaration
public void ArrangeChildren()Implements
ClearChildren()
Clears all child elements from the Comments UI Layer.
Declaration
public void ClearChildren()Implements
Remarks
This method removes all the comment-related visual elements from the UI layer, effectively resetting its state to an empty state.
DoOnPresentationChanged()
Executes actions that need to be performed when the presentation changes.
Declaration
public void DoOnPresentationChanged()Implements
Remarks
This method is typically called internally to update the UI and re-render the comment layers when there are changes to the presentation.
GetLayerUIElement()
Retrieves the user interface element associated with the Comments UI layer.
Declaration
public UIElement GetLayerUIElement()Returns
UIElement
The UI element of type T that represents the Comments layer.
Implements
RemoveChild(FrameworkElement)
Removes a specified child element from the Comments UI Layer.
Declaration
public void RemoveChild(FrameworkElement existingElement)Parameters
existingElement
FrameworkElement
The child element to be removed from the layer.
UnregisterChildUIElement(FrameworkElement)
Unregisters a child user interface element from the comments UI layer.
Declaration
public void UnregisterChildUIElement(FrameworkElement existingElement)Parameters
existingElement
FrameworkElement
The FrameworkElement that represents the child UI element to be unregistered.
UpdateUI()
Declaration
protected virtual void UpdateUI()UpdateViewPort(PointF, RectangleF, ObjectPool)
Updates the viewport for the Comments UI layer based on the specified position and bounds.
Declaration
public void UpdateViewPort(PointF viewOffset, RectangleF viewPort, ObjectPool uiElementPool)Parameters
viewOffset
A PointF representing the position of the viewport.
viewPort
A RectangleF defining the dimensions of the viewport.
uiElementPool
An instance of ObjectPool used for managing objects within the Comments UI layer.
UpdateViewPort(RectangleF)
Updates the viewport to reflect changes in the specified rectangle.
Declaration
public void UpdateViewPort(RectangleF viewPort)Parameters
viewPort
The rectangle defining the new viewport area.
UpdateViewPort(UILayerUpdateContext)
Updates the viewport of the comment layer based on the specified update context.
Declaration
public void UpdateViewPort(UILayerUpdateContext context)Parameters
context
The context containing the information needed to update the viewport.
Implements