LayoutBox
Represents a layout box in the Telerik document layout system. This class is responsible for managing the layout structure and visual representation of elements within a document, allowing for complex arrangements and styling.
Definition
Namespace:Telerik.Windows.Documents.Layout
Assembly:Telerik.Windows.Controls.RichTextBox.dll
Syntax:
public abstract class LayoutBox : LayoutElementInheritance: objectLayoutElementLayoutBox
Derived Classes:
Inherited Members
Constructors
public LayoutBox(DocumentElement associatedDocumentElement, DocumentStructureCollection collection, bool isFragment)public LayoutBox(DocumentElement associatedDocumentElement, DocumentStructureCollection collection)public LayoutBox(DocumentElement associatedDocumentElement)Fields
AssociatedLayoutBoxProperty
DependencyProperty
public static readonly DependencyProperty AssociatedLayoutBoxPropertyProperties
Gets the associated document element for the LayoutBox.
public DocumentElement AssociatedDocumentElement { get; }Gets the bounding rectangle of the layout box, which defines the area occupied by the box within the layout.
public RectangleF BoundingRectangle { get; }Gets the child boxes contained within the layout box.
public virtual bool BoundsChildBoxes { get; }protected virtual bool CanCreateLayoutBoxesFromContent { get; }Gets the index of the child element within the layout box.
public int ChildIndex { get; }Gets the collection of child layout boxes contained within the layout box.
public LayoutElementCollection ChildLayoutBoxes { get; }Determines whether the layout box has a visual representation.
public virtual bool HasVisualRepresentation { get; }Gets a value indicating whether the layout box is a container box.
public virtual bool IsContainerBox { get; }Gets a value indicating whether the current layout box is the first box in its parent layout container.
public bool IsFirstBox { get; }Gets a value indicating whether the current layout box is the first child of its parent.
public bool IsFirstChild { get; }Gets or sets a value indicating whether the LayoutBox should use formatting symbols.
public virtual bool IsFormattingSymbol { get; }Gets a value indicating whether the LayoutBox is a fragment.
public bool IsFragment { get; }Gets a value indicating whether the current LayoutBox is the last box in its parent container.
public virtual bool IsLastBox { get; }Gets a value indicating whether this LayoutBox is the last child in its parent container.
public bool IsLastChild { get; }Gets a value indicating whether the layout box has been removed from the layout.
public bool IsRemoved { get; }Determines whether the specified position is valid within the layout box.
public virtual bool IsValidPosition { get; }Methods
protected override ILinkedListCollection<LayoutElement> CreateChildrenCollection(DocumentStructureCollection collection)Overrides:
Creates a new layout element within the LayoutBox.
public abstract LayoutElement CreateLayoutElement()A new instance of a layout element.
Creates a new fragment based on the specified layout box.
public virtual void CreateNewFragment(LayoutBox currentLineStartNode)The layout box from which to create the new fragment.
Retrieves the associated layout box for the specified UI element.
public static LayoutBox GetAssociatedLayoutBox(UIElement element)The UI element for which to retrieve the associated layout box.
Returns:The layout box associated with the specified UI element, or null if none exists.
Gets the position of the LayoutBox.
public virtual PositionHandler GetPositionHandler()A Point representing the position of the LayoutBox.
Retrieves the root document from the layout box.
Invalidates the arrangement of the layout box and all of its parent elements up to the root. This method recalculates the layout for the box and ensures that the visual tree is updated accordingly.
public void InvalidateArrangeUpToTheRoot()Invalidates the layout of the layout box after an edit operation. This method should be called whenever there are changes that affect the layout, ensuring that the layout is updated accordingly.
public void InvalidateLayoutAfterEdit()Invalidates the current measure of the layout box, forcing it to recompute its layout during the next pass of the layout system.
public override void InvalidateMeasure()Overrides:
Invalidates the measurement of the current layout box and all its parent layout boxes up to the root. This method triggers a re-measure of the layout tree to ensure that all layout boxes reflect the latest changes in their properties or children.
public void InvalidateMeasureUpToTheRoot()Invalidates the measure of the current LayoutBox and all its parent elements up to the root, ensuring that the layout is recalculated.
public void InvalidateMeasureUpToTheRootStable()Merges the current layout box with the next layout box, if applicable.
public virtual void MergeWithNext(LayoutBox nextSpanBox)The layout box to merge with the current layout box.
protected virtual void OnAssociateDocumentElementChanged()protected virtual void OnElementStructureChanged()protected virtual void OnElementStructureChanging()Associates a specified UIElement with a LayoutBox.
public static void SetAssociatedLayoutBox(UIElement element, LayoutBox uiElementProvider)The UIElement to associate with the LayoutBox.
uiElementProviderLayoutBoxThe LayoutBox to which the UIElement will be associated.
Returns a string representation of the current LayoutBox instance.
public override string ToString()A string that describes the LayoutBox object, which may include its properties and state.
Overrides:
Validates the specified child LayoutBox for the current LayoutBox instance.
public void ValidateChild(LayoutBox child)The child LayoutBox to be validated.
Events
public event EventHandler ElementStructureChangedpublic event EventHandler ElementStructureChanging