Back to all docs
API Reference / Telerik.WinControls / IComponentTreeHandler
New to Telerik UI for WinForms? Start a free 30-day trial

IComponentTreeHandler

Interface

Defines the contract for handling component tree operations and ambient property management in RadControls.

IComponentTreeHandler extends ILayoutHandler to provide comprehensive component tree management capabilities including element tree creation, initialization, and ambient property handling. This interface is essential for RadControls that need to manage complex element hierarchies.

The interface handles ambient properties (properties that can be inherited from parent controls such as BackColor, ForeColor, and Font), theme management, tooltip support, and focus cues. It provides the foundation for RadControl's element tree architecture.

Implementers are responsible for creating and managing the root element, handling tree loading operations, and coordinating with the layout system to ensure proper rendering and behavior.

Definition

Namespace:Telerik.WinControls

Assembly:Telerik.WinControls.dll

Syntax:
C#
public interface IComponentTreeHandler : ILayoutHandler

Inherited Members ILayoutHandler.InvokeLayoutCallback(LayoutCallback)ILayoutHandler.LayoutManager

Properties

Behavior

C#
ComponentInputBehavior Behavior { get; }

ElementTree

C#
ComponentThemableElementTree ElementTree { get; }

ImageList

C#
ImageList ImageList { get; set; }

ImageScalingSize

C#
Size ImageScalingSize { get; set; }

Initializing

C#
bool Initializing { get; }

IsDesignMode

C#
bool IsDesignMode { get; }

Name

C#
string Name { get; set; }

RootElement

C#
RootRadElement RootElement { get; }

SmallImageList

C#
ImageList SmallImageList { get; set; }

SmallImageScalingSize

C#
Size SmallImageScalingSize { get; set; }

ThemeClassName

C#
string ThemeClassName { get; set; }

ThemeName

C#
string ThemeName { get; set; }

Methods

CallOnMouseCaptureChanged(EventArgs)

C#
void CallOnMouseCaptureChanged(EventArgs e)
Parameters:eEventArgs

CallOnScreenTipNeeded(object, ScreenTipNeededEventArgs)

C#
void CallOnScreenTipNeeded(object sender, ScreenTipNeededEventArgs e)
Parameters:senderobjecteScreenTipNeededEventArgs

CallOnThemeNameChanged(ThemeNameChangedEventArgs)

C#
void CallOnThemeNameChanged(ThemeNameChangedEventArgs e)
Parameters:eThemeNameChangedEventArgs

CallOnToolTipTextNeeded(object, ToolTipTextNeededEventArgs)

C#
void CallOnToolTipTextNeeded(object sender, ToolTipTextNeededEventArgs e)
Parameters:senderobjecteToolTipTextNeededEventArgs

ControlDefinesThemeForElement(RadElement)

C#
bool ControlDefinesThemeForElement(RadElement element)
Parameters:elementRadElementReturns:

bool

ControlThemeChangedCallback()

C#
void ControlThemeChangedCallback()

CreateChildItems(RadElement)

C#
void CreateChildItems(RadElement parent)
Parameters:parentRadElement

CreateRootElement()

C#
RootRadElement CreateRootElement()
Returns:

RootRadElement

GetAmbientPropertyValue(RadProperty)

Returns the value for some ambient properties like BackColor, ForelColor, Font, etc.

C#
object GetAmbientPropertyValue(RadProperty property)
Parameters:propertyRadPropertyReturns:

object

GetShowFocusCues()

C#
bool GetShowFocusCues()
Returns:

bool

InitializeRootElement(RootRadElement)

C#
void InitializeRootElement(RootRadElement rootElement)
Parameters:rootElementRootRadElement

InvalidateElement(RadElement, Rectangle)

C#
void InvalidateElement(RadElement element, Rectangle bounds)
Parameters:elementRadElementboundsRectangle

InvalidateElement(RadElement)

C#
void InvalidateElement(RadElement element)
Parameters:elementRadElement

InvalidateIfNotSuspended()

C#
void InvalidateIfNotSuspended()

LoadElementTree()

C#
void LoadElementTree()

LoadElementTree(Size)

C#
void LoadElementTree(Size size)
Parameters:sizeSize

OnAmbientPropertyChanged(RadProperty)

Updates after a change in an ambient property like BackColor, ForeColor, Font, etc.

C#
void OnAmbientPropertyChanged(RadProperty property)
Parameters:propertyRadProperty

OnCaptureChangeRequested(RadElement, bool)

C#
bool OnCaptureChangeRequested(RadElement element, bool capture)
Parameters:elementRadElementcaptureboolReturns:

bool

OnDisplayPropertyChanged(RadPropertyChangedEventArgs)

C#
void OnDisplayPropertyChanged(RadPropertyChangedEventArgs e)
Parameters:eRadPropertyChangedEventArgs

OnFocusRequested(RadElement)

C#
bool OnFocusRequested(RadElement element)
Parameters:elementRadElementReturns:

bool

RegisterHostedControl(RadHostItem)

C#
void RegisterHostedControl(RadHostItem hostElement)
Parameters:hostElementRadHostItem

ResumeUpdate()

C#
void ResumeUpdate()

SuspendUpdate()

C#
void SuspendUpdate()

UnregisterHostedControl(RadHostItem, bool)

C#
void UnregisterHostedControl(RadHostItem hostElement, bool removeControl)
Parameters:hostElementRadHostItemremoveControlbool

Events

ThemeNameChanged

C#
event ThemeNameChangedEventHandler ThemeNameChanged

ToolTipTextNeeded

C#
event ToolTipTextNeededEventHandler ToolTipTextNeeded
In this article
DefinitionPropertiesBehaviorElementTreeImageListImageScalingSizeInitializingIsDesignModeNameRootElementSmallImageListSmallImageScalingSizeThemeClassNameThemeNameMethodsCallOnMouseCaptureChanged(EventArgs)CallOnScreenTipNeeded(object, ScreenTipNeededEventArgs)CallOnThemeNameChanged(ThemeNameChangedEventArgs)CallOnToolTipTextNeeded(object, ToolTipTextNeededEventArgs)ControlDefinesThemeForElement(RadElement)ControlThemeChangedCallback()CreateChildItems(RadElement)CreateRootElement()GetAmbientPropertyValue(RadProperty)GetShowFocusCues()InitializeRootElement(RootRadElement)InvalidateElement(RadElement, Rectangle)InvalidateElement(RadElement)InvalidateIfNotSuspended()LoadElementTree()LoadElementTree(Size)OnAmbientPropertyChanged(RadProperty)OnCaptureChangeRequested(RadElement, bool)OnDisplayPropertyChanged(RadPropertyChangedEventArgs)OnFocusRequested(RadElement)RegisterHostedControl(RadHostItem)ResumeUpdate()SuspendUpdate()UnregisterHostedControl(RadHostItem, bool)EventsThemeNameChangedToolTipTextNeeded
Not finding the help you need?
Contact Support