Documentation

Class LayoutElement

Inheritance
System.Object
LayoutElement
LayoutBox
Namespace: Telerik.Windows.Documents.Layout
Assembly: Telerik.Windows.Controls.RichTextBox.dll

Syntax

public abstract class LayoutElement : Object

Constructors

LayoutElement(DocumentStructureCollection)

Declaration
public LayoutElement(DocumentStructureCollection collection)
Parameters
DocumentStructureCollection collection

Properties

Alignment

Declaration
public ContentAlignment Alignment { get; set; }
Property Value
ContentAlignment

AutoSize

Gets or sets a value indicating whether the element size will be calculated automatically by the layout system. Value of false indicates that the element's size will not be changed when calculating the layout.

Declaration
public virtual bool AutoSize { get; }
Property Value
System.Boolean

BitState

Gets the RadBitVector64 structure that holds all the bit states of the object.

Declaration
protected DocumentElementStateBitVector BitState { get; }
Property Value
DocumentElementStateBitVector

BypassLayoutPolicies

Declaration
public bool BypassLayoutPolicies { get; set; }
Property Value
System.Boolean

Children

Declaration
public ILinkedListCollection<LayoutElement> Children { get; }
Property Value
ILinkedListCollection<LayoutElement>

ClippedControlBoundingRectangle

Declaration
public virtual RectangleF ClippedControlBoundingRectangle { get; }
Property Value
RectangleF

ControlBoundingRectangle

Declaration
public virtual RectangleF ControlBoundingRectangle { get; }
Property Value
RectangleF

DesiredSize

Declaration
public SizeF DesiredSize { get; set; }
Property Value
SizeF

IsArrangeValid

Declaration
public bool IsArrangeValid { get; }
Property Value
System.Boolean

IsMeasureInProgress

Declaration
public bool IsMeasureInProgress { get; }
Property Value
System.Boolean

IsMeasureValid

Declaration
public bool IsMeasureValid { get; }
Property Value
System.Boolean

IsTopContainer

Declaration
public virtual bool IsTopContainer { get; }
Property Value
System.Boolean

LayoutOffset

Declaration
public PointF LayoutOffset { get; }
Property Value
PointF

LocalBoundingRectangle

Declaration
public RectangleF LocalBoundingRectangle { get; }
Property Value
RectangleF

MeasureWithoutParentNotification

Declaration
public bool MeasureWithoutParentNotification { get; set; }
Property Value
System.Boolean

Parent

Declaration
public LayoutElement Parent { get; }
Property Value
LayoutElement

PreviousArrangeRect

Declaration
public RectangleF PreviousArrangeRect { get; }
Property Value
RectangleF

Size

Gets or sets the size of the element which is the height and width of the visual rectangle that would contain the element. Size corresponds to element's Bounds.Size. When the AutoSize property is set to true setting the Size property to some value has no effect.

Declaration
public SizeF Size { get; set; }
Property Value
SizeF

TotalTransform

Declaration
public RadMatrix TotalTransform { get; }
Property Value
RadMatrix

Transform

Declaration
public RadMatrix Transform { get; }
Property Value
RadMatrix

TreeLevel

Gets the level of this element in the LayoutElement tree it currently resides.

Declaration
public byte TreeLevel { get; protected set; }
Property Value
System.Byte

Methods

Arrange(RectangleF)

Declaration
public void Arrange(RectangleF finalRect)
Parameters
RectangleF finalRect

ArrangeCore(RectangleF)

Declaration
protected virtual void ArrangeCore(RectangleF finalRect)
Parameters
RectangleF finalRect

ArrangeOverride(SizeF)

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

Declaration
protected virtual SizeF ArrangeOverride(SizeF finalSize)
Parameters
SizeF finalSize

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.
Remarks

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

CreateChildren()

Declaration
protected virtual ILinkedListCollection<LayoutElement> CreateChildren()
Returns
ILinkedListCollection<LayoutElement>

CreateChildrenCollection(DocumentStructureCollection)

Declaration
protected virtual ILinkedListCollection<LayoutElement> CreateChildrenCollection(DocumentStructureCollection collection)
Parameters
DocumentStructureCollection collection

Returns
ILinkedListCollection<LayoutElement>

EnsureChildrenCreated()

Declaration
protected void EnsureChildrenCreated()

InvalidateArrange()

Declaration
public void InvalidateArrange()

InvalidateArrange(Boolean)

Declaration
public void InvalidateArrange(bool recursive)
Parameters
System.Boolean recursive

InvalidateMeasure()

Declaration
public virtual void InvalidateMeasure()

InvalidateMeasure(Boolean)

Declaration
public void InvalidateMeasure(bool recursive)
Parameters
System.Boolean recursive

IsInValidState(Boolean)

Determines whether the element is currently in valid state. That is having a valid RadElementTree reference and being in either Constructed or Loaded state.

Declaration
protected bool IsInValidState(bool checkElementTree)
Parameters
System.Boolean checkElementTree

Returns
System.Boolean

Measure(SizeF)

Declaration
public void Measure(SizeF availableSize)
Parameters
SizeF availableSize

MeasureCore(SizeF)

Declaration
protected virtual SizeF MeasureCore(SizeF availableSize)
Parameters
SizeF availableSize

Returns
SizeF

MeasureOverride(SizeF)

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

Declaration
protected virtual SizeF MeasureOverride(SizeF availableSize)
Parameters
SizeF availableSize

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.
Remarks

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

OnBitStateChanged(DocumentElementStates, Boolean, Boolean)

Notifies the object for a change in its bit state.

Declaration
protected virtual void OnBitStateChanged(DocumentElementStates key, bool oldValue, bool newValue)
Parameters
DocumentElementStates key

System.Boolean oldValue

System.Boolean newValue

OnChildDesiredSizeChanged(LayoutElement)

Declaration
protected virtual void OnChildDesiredSizeChanged(LayoutElement child)
Parameters
LayoutElement child

OnInvalidateArrange()

Declaration
protected virtual void OnInvalidateArrange()

OnInvalidateMeasure()

Declaration
protected virtual void OnInvalidateMeasure()

OnParentChanged()

Declaration
protected virtual void OnParentChanged()

OnParentChanging()

Declaration
protected virtual void OnParentChanging()

SetBitState(DocumentElementStates, Boolean)

Applies the specified boolean value to the BitVector of the object.

Declaration
protected virtual void SetBitState(DocumentElementStates key, bool value)
Parameters
DocumentElementStates key

System.Boolean value

SetParent(LayoutElement, LayoutElement)

Declaration
protected virtual void SetParent(LayoutElement oldParent, LayoutElement newParent)
Parameters
LayoutElement oldParent

LayoutElement newParent

SetParentCore(LayoutElement)

Declaration
protected void SetParentCore(LayoutElement newParent)
Parameters
LayoutElement newParent

ValidateParent(LayoutElement)

Declaration
protected virtual void ValidateParent(LayoutElement newParent)
Parameters
LayoutElement newParent

Events

ParentChanged

Declaration
public event EventHandler ParentChanged
Event Type
System.EventHandler

ParentChanging

Declaration
public event EventHandler ParentChanging
Event Type
System.EventHandler

Extension Methods