New to Telerik UI for WPFStart a free 30-day trial

Represents the layout box for a document in the Telerik layout system. This class is responsible for managing the visual arrangement of document elements within a defined layout region.

Definition

Namespace:Telerik.Windows.Documents.Layout

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

C#
public class DocumentLayoutBox : LayoutBox

Inheritance: objectLayoutElementLayoutBoxDocumentLayoutBox

Inherited Members LayoutBox.currentYLayoutBox.AssociatedLayoutBoxPropertyLayoutBox.NodeLayoutBox.GetAssociatedLayoutBox(UIElement)LayoutBox.SetAssociatedLayoutBox(UIElement, LayoutBox)LayoutBox.OnElementStructureChanging()LayoutBox.OnElementStructureChanged()LayoutBox.OnAssociateDocumentElementChanged()LayoutBox.CreateChildrenCollection(DocumentStructureCollection)LayoutBox.ToString()LayoutBox.InvalidateMeasureUpToTheRoot()LayoutBox.InvalidateMeasureUpToTheRootStable()LayoutBox.InvalidateArrangeUpToTheRoot()LayoutBox.InvalidateLayoutAfterEdit()LayoutBox.ValidateChild(LayoutBox)LayoutBox.GetRootDocument()LayoutBox.CanGrowVerticallyOverride(float)LayoutBox.CanGrowVertically(float)LayoutBox.GetBoxDesiredGrow()LayoutBox.CreateNewFragment(LayoutBox)LayoutBox.MergeWithNext(LayoutBox)LayoutBox.GetPositionHandler()LayoutBox.InvalidateMeasure()LayoutBox.IsRemovedLayoutBox.IsFragmentLayoutBox.AssociatedDocumentElementLayoutBox.ChildLayoutBoxesLayoutBox.IsFormattingSymbolLayoutBox.BoundsChildBoxesLayoutBox.IsFirstBoxLayoutBox.IsLastBoxLayoutBox.IsFirstChildLayoutBox.IsLastChildLayoutBox.IsValidPositionLayoutBox.ParentLayoutBox.ChildIndexLayoutBox.BoundingRectangleLayoutBox.IsContainerBoxLayoutBox.ElementStructureChangingLayoutBox.ElementStructureChangedLayoutElement.EnsureChildrenCreated()LayoutElement.CreateChildren()LayoutElement.OnBitStateChanged(DocumentElementStates, bool, bool)LayoutElement.SetBitState(DocumentElementStates, bool)LayoutElement.ValidateParent(LayoutElement)LayoutElement.SetParent(LayoutElement, LayoutElement)LayoutElement.SetParentCore(LayoutElement)LayoutElement.IsInValidState(bool)LayoutElement.OnInvalidateMeasure()LayoutElement.InvalidateMeasure(bool)LayoutElement.InvalidateArrange()LayoutElement.OnInvalidateArrange()LayoutElement.InvalidateArrange(bool)LayoutElement.Arrange(RectangleF)LayoutElement.ArrangeCore(RectangleF)LayoutElement.Measure(SizeF)LayoutElement.MeasureCore(SizeF)LayoutElement.OnChildDesiredSizeChanged(LayoutElement)LayoutElement.OnParentChanging()LayoutElement.OnParentChanged()LayoutElement.LayoutOffsetLayoutElement.IsTopContainerLayoutElement.LocalBoundingRectangleLayoutElement.ControlBoundingRectangleLayoutElement.ClippedControlBoundingRectangleLayoutElement.TotalTransformLayoutElement.ChildrenLayoutElement.BitStateLayoutElement.DesiredSizeLayoutElement.IsMeasureInProgressLayoutElement.BypassLayoutPoliciesLayoutElement.MeasureWithoutParentNotificationLayoutElement.SizeLayoutElement.IsArrangeValidLayoutElement.IsMeasureValidLayoutElement.TreeLevelLayoutElement.PreviousArrangeRectLayoutElement.AlignmentLayoutElement.AutoSizeLayoutElement.TransformLayoutElement.ParentChangingLayoutElement.ParentChanged...

Constructors

C#
public DocumentLayoutBox(RadDocument ownerDocument)
Parameters:ownerDocumentRadDocument

Properties

Gets the associated document for the current layout box.

C#
public RadDocument AssociatedDocument { get; }
Property Value:

The associated document if one exists; otherwise, null.

C#
protected override bool CanCreateLayoutBoxesFromContent { get; }

Overrides: LayoutBox.CanCreateLayoutBoxesFromContent

Gets a value indicating whether the document layout box has a visual representation.

C#
public override bool HasVisualRepresentation { get; }

Overrides: LayoutBox.HasVisualRepresentation

Gets the document that owns the current layout box.

C#
public RadDocument OwnerDocument { get; }

Methods

Arranges the LayoutElement to its final location. The element must call the Arrange method of each of its children.

C#
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters:finalSizeSizeF

The size that is available for element.

Returns:

SizeF

The rectangle occupied by the element. Usually finalSize. Should you return different size, the Layout system will restart measuring and rearranging the items. That could lead to infinite recursion.

Overrides: LayoutElement.ArrangeOverride(SizeF)

Remarks:

In this method call to the Arrange method of each child must be made.

C#
protected void CreateLayoutBoxesFromContent(LayoutElementCollection fragmentList)
Parameters:fragmentListLayoutElementCollection

Creates a layout element for the document layout box.

C#
public override LayoutElement CreateLayoutElement()
Returns:

LayoutElement

A LayoutElement instance representing the created layout element.

Overrides: LayoutBox.CreateLayoutElement()

Measures the space required by the LayoutElement Used by the layout system.

C#
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters:availableSizeSizeF

The size that is available to the LayoutElement. The available size can be infinity (to take the full size of the element)

Returns:

SizeF

The minimum size required by the element to be completely visible. Cannot be infinity.

Overrides: LayoutElement.MeasureOverride(SizeF)

Remarks:

In this method call to the Measure method of each child must be made.

Updates the layout for the document layout box, recalculating its size and position.

C#
public void UpdateLayout()