New to Telerik UI for WPF? Start a free 30-day trial

SectionLayoutBox

Class

Represents a layout box for a section in Telerik's RadRichTextBox. This class is responsible for managing the layout and rendering of section content during document creation or manipulation.

Definition

Namespace:Telerik.Windows.Documents.Layout

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

C#

public class SectionLayoutBox : LayoutBox

Inheritance: objectLayoutElementLayoutBoxSectionLayoutBox

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.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.LocalBoundingRectangleLayoutElement.ControlBoundingRectangleLayoutElement.ClippedControlBoundingRectangleLayoutElement.TotalTransformLayoutElement.ChildrenLayoutElement.BitStateLayoutElement.DesiredSizeLayoutElement.IsMeasureInProgressLayoutElement.BypassLayoutPoliciesLayoutElement.MeasureWithoutParentNotificationLayoutElement.SizeLayoutElement.IsArrangeValidLayoutElement.IsMeasureValidLayoutElement.TreeLevelLayoutElement.PreviousArrangeRectLayoutElement.AlignmentLayoutElement.AutoSizeLayoutElement.TransformLayoutElement.ParentChangingLayoutElement.ParentChanged...

Constructors

SectionLayoutBox(DocumentElement, DocumentStructureCollection, bool)

C#

public SectionLayoutBox(DocumentElement associatedDocumentElement, DocumentStructureCollection collection, bool shouldFragmentize)

Parameters:associatedDocumentElementDocumentElementcollectionDocumentStructureCollectionshouldFragmentizebool

SectionLayoutBox(DocumentElement, DocumentStructureCollection)

C#

public SectionLayoutBox(DocumentElement associatedDocumentElement, DocumentStructureCollection collection)

Parameters:associatedDocumentElementDocumentElementcollectionDocumentStructureCollection

Properties

AssociatedSection

Gets or sets the associated section for the layout box.

C#

public Section AssociatedSection { get; }

Property Value:

The associated section.

CanCreateLayoutBoxesFromContent

C#

protected override bool CanCreateLayoutBoxesFromContent { get; }

Overrides: LayoutBox.CanCreateLayoutBoxesFromContent

HasVisualRepresentation

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

C#

public override bool HasVisualRepresentation { get; }

Overrides: LayoutBox.HasVisualRepresentation

IsTopContainer

Gets a value indicating whether the current layout box is the top container in the layout hierarchy.

C#

public override bool IsTopContainer { get; }

Overrides: LayoutElement.IsTopContainer

PageNumber

Gets the page number associated with the section layout box.

C#

public int PageNumber { get; }

Property Value:

The page number as an integer value.

Methods

ArrangeOverride(SizeF)

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:

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.

CanGrowVerticallyOverride(float)

C#

protected override bool? CanGrowVerticallyOverride(float desiredHeight)

Parameters:desiredHeightfloatReturns:

Overrides: LayoutBox.CanGrowVerticallyOverride(float)

CreateLayoutBoxesFromContent(LayoutElementCollection)

C#

protected void CreateLayoutBoxesFromContent(LayoutElementCollection fragmentList)

Parameters:fragmentListLayoutElementCollection

CreateLayoutElement()

Creates a new layout element for the section layout box.

C#

public override LayoutElement CreateLayoutElement()

Returns:

A layout element representing the visual structure of the section.

Overrides: LayoutBox.CreateLayoutElement()

GetFooter()

Gets the footer for this page.

C#

public Footer GetFooter()

Returns:

GetFooterContentMargins()

Gets the margin of the footer inside the bottom page margin.

C#

public Padding GetFooterContentMargins()

Returns:

GetFooterHeight()

Gets the height of the footer.

C#

public float GetFooterHeight()

Returns:

GetHeader()

Gets the header for this page.

C#

public Header GetHeader()

Returns:

GetHeaderContentMargins()

Gets the margin of the header content inside the top page margin.

C#

public Padding GetHeaderContentMargins()

Returns:

GetHeaderFooterType()

HeaderFooterType

Gets the type of the header and footer for this page.

C#

public HeaderFooterType GetHeaderFooterType()

Returns:

HeaderFooterType

GetHeaderHeight()

Gets the height of the header.

C#

public float GetHeaderHeight()

Returns:

MeasureOverride(SizeF)

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:

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.

SetFooter(Footer)

Sets the footer.

C#

public void SetFooter(Footer footer)

Parameters:footerFooter

The footer.

SetHeader(Header)

Sets the header.

C#

public void SetHeader(Header header)

Parameters:headerHeader

The header.