Back to all docs
API Reference / Telerik.Windows.Documents.Layout / DocumentLayoutBox

Class
DocumentLayoutBox

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:
cs-api-definition
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

DocumentLayoutBox(RadDocument)

Declaration

cs-api-definition
public DocumentLayoutBox(RadDocument ownerDocument)

Parameters

ownerDocument

RadDocument

Properties

AssociatedDocument

Gets the associated document for the current layout box.

Declaration

cs-api-definition
public RadDocument AssociatedDocument { get; }

Property Value

RadDocument

The associated document if one exists; otherwise, null.

CanCreateLayoutBoxesFromContent

Declaration

cs-api-definition
protected override bool CanCreateLayoutBoxesFromContent { get; }

Property Value

bool

Overrides LayoutBox.CanCreateLayoutBoxesFromContent

HasVisualRepresentation

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

Declaration

cs-api-definition
public override bool HasVisualRepresentation { get; }

Property Value

bool

Overrides LayoutBox.HasVisualRepresentation

OwnerDocument

Gets the document that owns the current layout box.

Declaration

cs-api-definition
public RadDocument OwnerDocument { get; }

Property Value

RadDocument

Methods

ArrangeOverride(SizeF)

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

Declaration

cs-api-definition
protected override SizeF ArrangeOverride(SizeF finalSize)

Parameters

finalSize

SizeF

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.

CreateLayoutBoxesFromContent(LayoutElementCollection)

Declaration

cs-api-definition
protected void CreateLayoutBoxesFromContent(LayoutElementCollection fragmentList)

Parameters

fragmentList

LayoutElementCollection

CreateLayoutElement()

Creates a layout element for the document layout box.

Declaration

cs-api-definition
public override LayoutElement CreateLayoutElement()

Returns

LayoutElement

A LayoutElement instance representing the created layout element.

Overrides LayoutBox.CreateLayoutElement()

MeasureOverride(SizeF)

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

Declaration

cs-api-definition
protected override SizeF MeasureOverride(SizeF availableSize)

Parameters

availableSize

SizeF

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.

UpdateLayout()

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

Declaration

cs-api-definition
public void UpdateLayout()
In this article
DefinitionConstructorsDocumentLayoutBox(RadDocument)PropertiesAssociatedDocumentCanCreateLayoutBoxesFromContentHasVisualRepresentationOwnerDocumentMethodsArrangeOverride(SizeF)CreateLayoutBoxesFromContent(LayoutElementCollection)CreateLayoutElement()MeasureOverride(SizeF)UpdateLayout()
Not finding the help you need?
Contact Support