ClassRadElementTree
Represents the visual element tree for a Telerik control. Every Telerik control has a corresponding tree of RadElements. This provides flexibility in building controls and enables property inheritance from ancestor nodes.
Definition
Namespace:Telerik.WinControls
Assembly:Telerik.WinControls.dll
Syntax:
[TypeConverter(typeof(ExpandableObjectConverter))]
public class RadElementTree : IDisposableInheritance: objectRadElementTree
Derived Classes:
Implements:
Constructors
RadElementTree(IComponentTreeHandler)
Initializes a new instance of the RadElementTree class.
Declaration
public RadElementTree(IComponentTreeHandler component)Parameters
component
The component tree handler that manages this element tree.
Properties
ComponentTreeHandler
Gets the component tree handler that bridges the abstract RadElement layout and the RadControl instance.
Declaration
public IComponentTreeHandler ComponentTreeHandler { get; }Property Value
The IComponentTreeHandler that manages this element tree.
Control
Gets the Windows Forms control that hosts this element tree.
Disposing
Gets a value indicating whether the element tree is currently being disposed.
Declaration
public bool Disposing { get; }Property Value
true if the tree is disposing; otherwise, false.
IsLayoutSuspended
Gets a value indicating whether layout operations are currently suspended.
Declaration
public bool IsLayoutSuspended { get; }Property Value
true if layout is suspended; otherwise, false.
Remarks
Layout suspension is used to improve performance during bulk operations by preventing unnecessary layout calculations until the operations are complete.
RootElement
Gets the root element of the element tree.
Declaration
[Browsable(true)]
[TypeConverter(typeof(ExpandableObjectConverter))]
public RootRadElement RootElement { get; }Property Value
The RootRadElement that serves as the root of the element hierarchy.
Remarks
The root element is the top-level container for all visual elements in the control. It manages the overall layout and serves as the entry point for element tree operations.
Methods
Dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Declaration
public void Dispose()Implements
Dispose(bool)
Releases the unmanaged resources used by the RadElementTree and optionally releases the managed resources.
Declaration
protected virtual void Dispose(bool disposing)Parameters
disposing
true to release both managed and unmanaged resources;
false to release only unmanaged resources.
GetElementAtPoint(Point)
Gets the element at the specified coordinates that handles mouse input.
Declaration
public RadElement GetElementAtPoint(Point point)Parameters
point
The coordinates to test, in control coordinates.
Returns
The RadElement at the specified point that can handle mouse input, or null if no suitable element is found.
GetElementAtPoint(Point, Predicate<RadElement>)
Gets the element at the specified coordinates that meets the predicate criteria.
Declaration
public RadElement GetElementAtPoint(Point point, Predicate<RadElement> predicate)Parameters
point
The coordinates to test, in control coordinates.
predicate
A predicate function to test each element, or null to return the first element found.
Returns
The RadElement that meets the criteria, or null if no suitable element is found.
GetElementAtPoint<T>(Point)
Gets the first element of the specified type at the given coordinates that handles mouse input.
Declaration
public T GetElementAtPoint<T>(Point point) where T : classParameters
point
The coordinates to test, in control coordinates.
Returns
T
The element of type T at the specified point, or null if no suitable element is found.
GetPreferredSize(Size, Size)
Calculates the preferred size of the control based on the element tree layout. This method is called when AutoSize is true to determine the optimal control size.
Declaration
public virtual Size GetPreferredSize(Size proposedSize, Size sizeConstraints)Parameters
proposedSize
The proposed size for the control.
sizeConstraints
Size constraints to apply during calculation.
Returns
The preferred Size for the control.
Remarks
This method considers stretch properties of the root element and performs measure and arrange operations to determine the optimal size.
InitializeRootElement()
Initializes the root element of the tree and creates the initial element hierarchy.
Declaration
public virtual void InitializeRootElement()Remarks
This method creates the root element if it doesn't exist, initializes it through the component tree handler, and sets up the initial child elements. It also manages layout suspension during initialization to improve performance.
OnAutoSizeChanged(EventArgs)
Handles the AutoSize property change event of the associated control.
Declaration
public virtual void OnAutoSizeChanged(EventArgs e)Parameters
e
The event arguments.
Remarks
This method updates the layout when AutoSize changes and notifies the root element of the AutoSize state change.
PerformInnerLayout(bool, int, int, int, int)
Performs the internal layout operation with specified parameters.
Declaration
public Size PerformInnerLayout(bool performMeasure, int x, int y, int width, int height)Parameters
performMeasure
Whether to perform the measure phase of layout.
x
The x-coordinate for layout.
y
The y-coordinate for layout.
width
The width for layout.
height
The height for layout.
Returns
The resulting Size after layout.
Remarks
This method handles the core layout logic including measure, arrange, and size calculation while respecting AutoSize settings and stretch properties.
PerformLayout()
Performs a layout operation on the element tree using the control's current bounds.
Declaration
public void PerformLayout()Remarks
This method triggers a complete layout cycle including measure and arrange phases, and updates the control's size based on the layout results.