Class
LayoutElement

Definition

Namespace:Telerik.WinForms.Documents.Layout

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

cs-api-definition
public abstract class LayoutElement : RadObject, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor

Inheritance: objectDisposableObjectRadObjectLayoutElement

Derived Classes: LayoutBox

Implements: ICustomTypeDescriptorIDisposableINotifyPropertyChanged

Inherited Members RadObject.BindingContextPropertyRadObject.RadTypeRadObject.ReplaceDefaultDescriptors(PropertyDescriptorCollection)RadObject.DisposeManagedResources()RadObject.ClearPropertyStore()RadObject.SuspendPropertyNotifications()RadObject.ResumePropertyNotifications()RadObject.GetPropertyValue(RadProperty)RadObject.SetDefaultValueOverride(RadProperty, object)RadObject.GetValue(RadProperty)RadObject.SetValue(RadProperty, object)RadObject.ResetValue(RadProperty)RadObject.ResetLocalValue(RadProperty)RadObject.ResetValue(RadProperty, ValueResetFlags)RadObject.UpdateValue(RadProperty)RadObject.GetValueSource(RadProperty)RadObject.GetRegisteredRadProperty(string)RadObject.UpdateValueCore(RadPropertyValue)RadObject.SetValueCore(RadPropertyValue, object, object, ValueSource)RadObject.ResetValueCore(RadPropertyValue, ValueResetFlags)RadObject.GetDefaultValue(RadPropertyValue, object)RadObject.CoerceValue(RadPropertyValue, object)RadObject.ShouldSerializeProperty(RadProperty)RadObject.CanRaisePropertyChangeNotifications(RadPropertyValue)RadObject.BindProperty(RadProperty, RadObject, RadProperty, PropertyBindingOptions)RadObject.UnbindProperty(RadProperty)RadObject.AddStylePropertySetting(IPropertySetting)RadObject.GetInheritedValue(RadProperty)RadObject.OnPropertyChanging(RadPropertyChangingEventArgs)RadObject.OnPropertyChanged(RadPropertyChangedEventArgs)RadObject.OnNotifyPropertyChanged(string)RadObject.OnNotifyPropertyChanged(PropertyChangedEventArgs)RadObject.OnShouldSerializeProperty(ShouldSerializePropertyEventArgs)RadObject.IsPropertyCancelable(RadPropertyMetadata)RadObject.PropertyValuesRadObject.PropertyFilterRadObject.RadObjectTypeRadObject.BindingContextRadObject.PropertyChangedRadObject.RadPropertyChangedRadObject.RadPropertyChangingDisposableObject.GetBitState(long)DisposableObject.SetBitState(long, bool)DisposableObject.OnBitStateChanged(long, bool, bool)DisposableObject.Dispose()DisposableObject.Dispose(bool)DisposableObject.PerformDispose(bool)DisposableObject.DisposeUnmanagedResources()DisposableObject.EventsDisposableObject.IsDisposingDisposableObject.IsDisposedDisposableObject.DisposedDisposableObject.Disposing

Constructors

LayoutElement(DocumentStructureCollection)

Declaration

cs-api-definition
public LayoutElement(DocumentStructureCollection collection)

Parameters

collection

DocumentStructureCollection

Properties

Alignment

Declaration

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

cs-api-definition
public virtual bool AutoSize { get; }

Property Value

bool

BitState

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

Declaration

cs-api-definition
protected DocumentElementStateBitVector BitState { get; }

Property Value

DocumentElementStateBitVector

BypassLayoutPolicies

Declaration

cs-api-definition
public bool BypassLayoutPolicies { get; set; }

Property Value

bool

Children

Declaration

cs-api-definition
public ILinkedListCollection<LayoutElement> Children { get; }

Property Value

ILinkedListCollection<LayoutElement>

ClippedControlBoundingRectangle

Declaration

cs-api-definition
public virtual RectangleF ClippedControlBoundingRectangle { get; }

Property Value

RectangleF

ControlBoundingRectangle

Declaration

cs-api-definition
public virtual RectangleF ControlBoundingRectangle { get; }

Property Value

RectangleF

DesiredSize

Declaration

cs-api-definition
public SizeF DesiredSize { get; set; }

Property Value

SizeF

IsArrangeValid

Declaration

cs-api-definition
public bool IsArrangeValid { get; }

Property Value

bool

IsMeasureInProgress

Declaration

cs-api-definition
public bool IsMeasureInProgress { get; }

Property Value

bool

IsMeasureValid

Declaration

cs-api-definition
public bool IsMeasureValid { get; }

Property Value

bool

IsTopContainer

Declaration

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

Property Value

bool

LayoutOffset

Declaration

cs-api-definition
public PointF LayoutOffset { get; }

Property Value

PointF

LocalBoundingRectangle

Declaration

cs-api-definition
public RectangleF LocalBoundingRectangle { get; }

Property Value

RectangleF

MeasureWithoutParentNotification

Declaration

cs-api-definition
public bool MeasureWithoutParentNotification { get; set; }

Property Value

bool

Parent

Declaration

cs-api-definition
public LayoutElement Parent { get; }

Property Value

LayoutElement

PreviousArrangeRect

Declaration

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

cs-api-definition
public SizeF Size { get; set; }

Property Value

SizeF

TotalTransform

Declaration

cs-api-definition
public RadMatrix TotalTransform { get; }

Property Value

RadMatrix

Transform

Declaration

cs-api-definition
public RadMatrix Transform { get; }

Property Value

RadMatrix

TreeLevel

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

Declaration

cs-api-definition
public byte TreeLevel { get; protected set; }

Property Value

byte

Methods

Arrange(RectangleF)

Declaration

cs-api-definition
public void Arrange(RectangleF finalRect)

Parameters

finalRect

RectangleF

ArrangeCore(RectangleF)

Declaration

cs-api-definition
protected virtual void ArrangeCore(RectangleF finalRect)

Parameters

finalRect

RectangleF

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

Remarks

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

CreateChildren()

Declaration

cs-api-definition
protected virtual ILinkedListCollection<LayoutElement> CreateChildren()

Returns

ILinkedListCollection<LayoutElement>

CreateChildrenCollection(DocumentStructureCollection)

Declaration

cs-api-definition
protected virtual ILinkedListCollection<LayoutElement> CreateChildrenCollection(DocumentStructureCollection collection)

Parameters

collection

DocumentStructureCollection

Returns

ILinkedListCollection<LayoutElement>

EnsureChildrenCreated()

Declaration

cs-api-definition
protected void EnsureChildrenCreated()

InvalidateArrange()

Declaration

cs-api-definition
public void InvalidateArrange()

InvalidateArrange(bool)

Declaration

cs-api-definition
public void InvalidateArrange(bool recursive)

Parameters

recursive

bool

InvalidateMeasure()

Declaration

cs-api-definition
public virtual void InvalidateMeasure()

InvalidateMeasure(bool)

Declaration

cs-api-definition
public void InvalidateMeasure(bool recursive)

Parameters

recursive

bool

IsInValidState(bool)

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

cs-api-definition
protected bool IsInValidState(bool checkElementTree)

Parameters

checkElementTree

bool

Returns

bool

Measure(SizeF)

Declaration

cs-api-definition
public void Measure(SizeF availableSize)

Parameters

availableSize

SizeF

MeasureCore(SizeF)

Declaration

cs-api-definition
protected virtual SizeF MeasureCore(SizeF availableSize)

Parameters

availableSize

SizeF

Returns

SizeF

MeasureOverride(SizeF)

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

Declaration

cs-api-definition
protected virtual 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.

Remarks

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

OnBitStateChanged(DocumentElementStates, bool, bool)

Notifies the object for a change in its bit state.

Declaration

cs-api-definition
protected virtual void OnBitStateChanged(DocumentElementStates key, bool oldValue, bool newValue)

Parameters

key

DocumentElementStates

The DocumentElementStates key.

oldValue

bool

The old value.

newValue

bool

The new value.

OnChildDesiredSizeChanged(LayoutElement)

Declaration

cs-api-definition
protected virtual void OnChildDesiredSizeChanged(LayoutElement child)

Parameters

child

LayoutElement

OnInvalidateArrange()

Declaration

cs-api-definition
protected virtual void OnInvalidateArrange()

OnInvalidateMeasure()

Declaration

cs-api-definition
protected virtual void OnInvalidateMeasure()

OnParentChanged()

Declaration

cs-api-definition
protected virtual void OnParentChanged()

OnParentChanging()

Declaration

cs-api-definition
protected virtual void OnParentChanging()

SetBitState(DocumentElementStates, bool)

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

Declaration

cs-api-definition
protected virtual void SetBitState(DocumentElementStates key, bool value)

Parameters

key

DocumentElementStates

The DocumentElementStates key.

value

bool

The value.

SetParent(LayoutElement, LayoutElement)

Declaration

cs-api-definition
protected virtual void SetParent(LayoutElement oldParent, LayoutElement newParent)

Parameters

oldParent

LayoutElement

newParent

LayoutElement

SetParentCore(LayoutElement)

Declaration

cs-api-definition
protected void SetParentCore(LayoutElement newParent)

Parameters

newParent

LayoutElement

ValidateParent(LayoutElement)

Declaration

cs-api-definition
protected virtual void ValidateParent(LayoutElement newParent)

Parameters

newParent

LayoutElement

Events

ParentChanged

Declaration

cs-api-definition
public event EventHandler ParentChanged

Event Value

EventHandler

ParentChanging

Declaration

cs-api-definition
public event EventHandler ParentChanging

Event Value

EventHandler