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

Class
SectionLayoutBox

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

Declaration

cs-api-definition
public SectionLayoutBox(DocumentElement associatedDocumentElement, DocumentStructureCollection collection)

Parameters

associatedDocumentElement

DocumentElement

collection

DocumentStructureCollection

SectionLayoutBox(DocumentElement, DocumentStructureCollection, bool)

Declaration

cs-api-definition
public SectionLayoutBox(DocumentElement associatedDocumentElement, DocumentStructureCollection collection, bool shouldFragmentize)

Parameters

associatedDocumentElement

DocumentElement

collection

DocumentStructureCollection

shouldFragmentize

bool

Properties

AssociatedSection

Gets or sets the associated section for the layout box.

Declaration

cs-api-definition
public Section AssociatedSection { get; }

Property Value

Section

The associated section.

CanCreateLayoutBoxesFromContent

Declaration

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

Property Value

bool

Overrides LayoutBox.CanCreateLayoutBoxesFromContent

HasVisualRepresentation

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

Declaration

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

Property Value

bool

Overrides LayoutBox.HasVisualRepresentation

IsTopContainer

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

Declaration

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

Property Value

bool

Overrides LayoutElement.IsTopContainer

PageNumber

Gets the page number associated with the section layout box.

Declaration

cs-api-definition
public int PageNumber { get; }

Property Value

int

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.

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.

CanGrowVerticallyOverride(float)

Declaration

cs-api-definition
protected override bool? CanGrowVerticallyOverride(float desiredHeight)

Parameters

desiredHeight

float

Returns

bool?

Overrides LayoutBox.CanGrowVerticallyOverride(float)

CreateLayoutBoxesFromContent(LayoutElementCollection)

Declaration

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

Parameters

fragmentList

LayoutElementCollection

CreateLayoutElement()

Creates a new layout element for the section layout box.

Declaration

cs-api-definition
public override LayoutElement CreateLayoutElement()

Returns

LayoutElement

A layout element representing the visual structure of the section.

Overrides LayoutBox.CreateLayoutElement()

GetFooter()

Gets the footer for this page.

Declaration

cs-api-definition
public Footer GetFooter()

Returns

Footer

GetFooterContentMargins()

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

Declaration

cs-api-definition
public Padding GetFooterContentMargins()

Returns

Padding

GetFooterHeight()

Gets the height of the footer.

Declaration

cs-api-definition
public float GetFooterHeight()

Returns

float

GetHeader()

Gets the header for this page.

Declaration

cs-api-definition
public Header GetHeader()

Returns

Header

GetHeaderContentMargins()

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

Declaration

cs-api-definition
public Padding GetHeaderContentMargins()

Returns

Padding

GetHeaderFooterType()

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

Declaration

cs-api-definition
public HeaderFooterType GetHeaderFooterType()

Returns

HeaderFooterType

GetHeaderHeight()

Gets the height of the header.

Declaration

cs-api-definition
public float GetHeaderHeight()

Returns

float

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.

SetFooter(Footer)

Sets the footer.

Declaration

cs-api-definition
public void SetFooter(Footer footer)

Parameters

footer

Footer

The footer.

SetHeader(Header)

Sets the header.

Declaration

cs-api-definition
public void SetHeader(Header header)

Parameters

header

Header

The header.

In this article
DefinitionConstructorsSectionLayoutBox(DocumentElement, DocumentStructureCollection)SectionLayoutBox(DocumentElement, DocumentStructureCollection, bool)PropertiesAssociatedSectionCanCreateLayoutBoxesFromContentHasVisualRepresentationIsTopContainerPageNumberMethodsArrangeOverride(SizeF)CanGrowVerticallyOverride(float)CreateLayoutBoxesFromContent(LayoutElementCollection)CreateLayoutElement()GetFooter()GetFooterContentMargins()GetFooterHeight()GetHeader()GetHeaderContentMargins()GetHeaderFooterType()GetHeaderHeight()MeasureOverride(SizeF)SetFooter(Footer)SetHeader(Header)
Not finding the help you need?
Contact Support