Class RadFormControlBase

Represents the base class for all Telerik forms that provides core functionality for themed form controls. This abstract class serves as the foundation for creating custom forms with advanced UI capabilities and theming support.

Inheritance
System.Object
RadFormControlBase
RadForm
RadNonClientUIBaseForm<T, U>
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public abstract class RadFormControlBase : Form, IComponentTreeHandler, ILayoutHandler, ISupportInitializeNotification, ISupportInitialize, INotifyPropertyChanged, IAnalyticsProvider

Constructors

RadFormControlBase()

Initializes a new instance of the RadFormControlBase class.

Declaration
public RadFormControlBase()

Fields

controlIsInitializingRootComponent

Declaration
public bool controlIsInitializingRootComponent
Field Value
System.Boolean

currentDpi

The current DPI value.

Declaration
protected int currentDpi
Field Value
System.Int32

isBehaviorPrepared

Declaration
protected bool isBehaviorPrepared
Field Value
System.Boolean

isPainting

Declaration
protected bool isPainting
Field Value
System.Boolean

newBounds

The new bounds for the new DPI that we receive on WM_DPICHANGED.

Declaration
protected Rectangle newBounds
Field Value
System.Drawing.Rectangle

oldDpi

The old DPI value before a DPI change occurs.

Declaration
protected int oldDpi
Field Value
System.Int32

Properties

AllowShowFocusCues

Gets or sets a value indicating whether focus cues are shown when available, based on the corresponding control type and the current UI state.

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

AllowTheming

Gets or sets a value indicating whether the form customizes its non-client area when under Vista with Composition enabled.

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

AnalyticsName

This member is not relevant for this class.

Declaration
public virtual string AnalyticsName { get; set; }
Property Value
System.String

Implements

BackColor

Gets or sets the BackColor of the control. This is actually the BackColor property of the root element.

Declaration
public override Color BackColor { get; set; }
Property Value
System.Drawing.Color

Behavior

Gets the ComponentInputBehavior instance that handles all logic and user interaction in RadControl.

Declaration
public virtual ComponentInputBehavior Behavior { get; }
Property Value
ComponentInputBehavior

CommandBindings

Gets the command bindings collection for input handling.

Declaration
public InputBindingsCollection CommandBindings { get; }
Property Value
InputBindingsCollection

CreateParams

Gets or sets the creation parameters for the window.

Declaration
protected override CreateParams CreateParams { get; }
Property Value
System.Windows.Forms.CreateParams

ElementTree

Gets the element tree for this control.

Declaration
public ComponentThemableElementTree ElementTree { get; }
Property Value
ComponentThemableElementTree

Implements

EnableAnalytics

Gets or sets a value indicating whether the Analytics functionality is enabled or disbaled for this control.

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

Implements

EnableKeyMap

Gets or sets a value indicating whether the Key Map (Office 2007 like accelerator keys map) is used for this specific control. Currently this option is implemented for the RadRibbonBar control only.

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

FocusedElement

Gets or sets the currently focused element.

Declaration
public RadElement FocusedElement { get; set; }
Property Value
RadElement

Font

Gets or sets the Font of the control. This is actually the Font property of the root element.

Declaration
public override Font Font { get; set; }
Property Value
System.Drawing.Font

ForeColor

Gets or sets the ForeColor of the control. This is actually the ForeColor property of the root element.

Declaration
public override Color ForeColor { get; set; }
Property Value
System.Drawing.Color

FormBehavior

Gets the behavior associated with this form if any.

Declaration
public FormControlBehavior FormBehavior { get; set; }
Property Value
FormControlBehavior

FormBorderStyle

Gets or sets the FormBorderStyle of the Form.

Declaration
public FormBorderStyle FormBorderStyle { get; set; }
Property Value
System.Windows.Forms.FormBorderStyle

HasOwnToolbar

Gets a value indicating whether the form has its own toolbar.

Declaration
protected virtual bool HasOwnToolbar { get; }
Property Value
System.Boolean

ImageList

Gets or sets the ImageList that contains the images displayed by this control.

Declaration
public ImageList ImageList { get; set; }
Property Value
System.Windows.Forms.ImageList

Implements

ImageScalingSize

Gets or sets the scaling size for images.

Declaration
public Size ImageScalingSize { get; set; }
Property Value
System.Drawing.Size

Implements

IsDesignMode

Gets a value indicating whether the control is in design mode.

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

Implements

IsDpiScalingSuspended

Gets a value indicating whether DPI scaling is suspended.

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

IsInitialized

Gets a value indicating whether the component is initialized.

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

IsLoaded

Gets a value indicating whether the control is loaded.

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

IsPerformingScale

Gets a value indicating whether the control is currently performing scaling operations.

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

IsUpdateSuspended

Gets a value indicating whether the control's update is suspended.

Declaration
protected bool IsUpdateSuspended { get; }
Property Value
System.Boolean

LayoutManager

Gets the layout manager for this control.

Declaration
public ILayoutManager LayoutManager { get; }
Property Value
ILayoutManager

Implements

MaximumSize

Gets or sets the maximum size of the control.

Declaration
public override Size MaximumSize { get; set; }
Property Value
System.Drawing.Size

MinimumSize

Gets or sets the minimum size of the control.

Declaration
public override Size MinimumSize { get; set; }
Property Value
System.Drawing.Size

RootElement

Gets the RootElement of the control.

Declaration
public RootRadElement RootElement { get; }
Property Value
RootRadElement

Implements

ShowItemToolTips

Gets or sets a value indicating whether ToolTips are shown for the RadItem objects contained in the RadControl.

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

Site

Gets or sets the site of the control and manages design mode state.

Declaration
public override ISite Site { get; set; }
Property Value
System.ComponentModel.ISite

SmallImageList

Gets or sets the ImageList that contains the images displayed by this control.

Declaration
public virtual ImageList SmallImageList { get; set; }
Property Value
System.Windows.Forms.ImageList

SmallImageScalingSize

Gets or sets the scaling size for small images.

Declaration
public Size SmallImageScalingSize { get; set; }
Property Value
System.Drawing.Size

Implements

ThemeClassName

Gets or sets the name of the theme class for styling.

Declaration
public virtual string ThemeClassName { get; set; }
Property Value
System.String

ThemeName

Gets or sets the theme name.

Declaration
public string ThemeName { get; set; }
Property Value
System.String

Implements

WindowsSettings

Gets or sets the windows related settings.

Declaration
public WindowsSettings WindowsSettings { get; set; }
Property Value
WindowsSettings

Methods

AddInvalidatedRect(Rectangle)

Adds an invalidated rectangle to the control.

Declaration
protected void AddInvalidatedRect(Rectangle rect)
Parameters
System.Drawing.Rectangle rect

The rectangle to invalidate.

BeginInit()

Signals the object that initialization is starting.

Declaration
public virtual void BeginInit()

CallBaseWndProc(ref Message)

Calls the base WndProc method.

Declaration
protected virtual void CallBaseWndProc(ref Message m)
Parameters
System.Windows.Forms.Message m

The Windows System.Windows.Forms.Message to process.

Construct()

Constructs the core components of the form control including managers and element tree.

Declaration
protected virtual void Construct()

ControlDefinesThemeForElement(RadElement)

Gets a value indicating if control themes by default define PropertySettings for the specified element. If true is returned the ThemeResolutionService would not set any theme to the element to avoid duplicating the style settings of the element.

Declaration
public virtual bool ControlDefinesThemeForElement(RadElement element)
Parameters
RadElement element

The element to check.
Returns
System.Boolean

True if the control defines theme for the element; otherwise, false.
Implements

ControlThemeChangedCallback()

Called when the control theme has changed.

Declaration
public void ControlThemeChangedCallback()
Implements

CreateChildItems(RadElement)

Creates the child items for the specified parent element.

Declaration
protected virtual void CreateChildItems(RadElement parent)
Parameters
RadElement parent

The parent element to create child items for.

CreateHandle()

Creates the handle for the control.

Declaration
protected override void CreateHandle()

CreateRootElement()

Creates the root element for the form.

Declaration
protected virtual RootRadElement CreateRootElement()
Returns
RootRadElement

A new RootRadElement instance.

Dispose(Boolean)

Disposes of the resources (other than memory) used by the RadFormControlBase.

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

True to release both managed and unmanaged resources; false to release only unmanaged resources.

EndInit()

Signals the object that initialization is complete.

Declaration
public virtual void EndInit()

GetPreferredSize(Size)

Retrieves the size of a rectangular area into which a control can be fitted.

Declaration
public override Size GetPreferredSize(Size proposedSize)
Parameters
System.Drawing.Size proposedSize

The custom-sized area for a control.
Returns
System.Drawing.Size

An ordered pair of type System.Drawing.Size representing the width and height of a rectangle.

GetUseNewLayout()

This method is not relevant for this class.

Declaration
[Obsolete("This method is not used.")]
protected virtual bool GetUseNewLayout()
Returns
System.Boolean

Always returns true.

HandleDpiChanged()

Handles DPI change operations.

Declaration
protected virtual void HandleDpiChanged()

InitializeFormBehavior()

Called to initialize the behavior of the form when implemented in a derived class.

Declaration
protected abstract FormControlBehavior InitializeFormBehavior()
Returns
FormControlBehavior

A FormControlBehavior instance that defines the form's behavior.

InvalidateElement(RadElement)

Invalidates the specified element.

Declaration
public void InvalidateElement(RadElement element)
Parameters
RadElement element

The element to invalidate.
Implements

InvalidateElement(RadElement, Rectangle)

Invalidates the specified element within the given bounds.

Declaration
public void InvalidateElement(RadElement element, Rectangle bounds)
Parameters
RadElement element

The element to invalidate.
System.Drawing.Rectangle bounds

The bounds to invalidate.
Implements

InvalidateIfNotSuspended()

Invalidates the control if not suspended.

Declaration
public void InvalidateIfNotSuspended()
Implements

InvokeLayoutCallback(LayoutCallback)

Invokes a layout callback.

Declaration
public void InvokeLayoutCallback(LayoutCallback callback)
Parameters
LayoutCallback callback

The callback to invoke.
Implements

LoadElementTree()

Loads the element tree. While not loaded, no layout operations are allowed upon the tree. By default, the tree will be loaded when the control is displayed for the first time.

Declaration
public virtual void LoadElementTree()
Implements

LoadElementTree(Size)

Loads the element tree using the specified desired size.

Declaration
public virtual void LoadElementTree(Size desiredSize)
Parameters
System.Drawing.Size desiredSize

Implements

OnAutoSizeChanged(EventArgs)

Raises the System.Windows.Forms.Control.AutoSizeChanged event.

Declaration
protected override void OnAutoSizeChanged(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.

OnBackColorChanged(EventArgs)

Raises the System.Windows.Forms.Control.BackColorChanged event.

Declaration
protected override void OnBackColorChanged(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.

OnCreateControl()

Called when the control is created and loads the element tree.

Declaration
protected override void OnCreateControl()

OnDisplayPropertyChanged(RadPropertyChangedEventArgs)

Called when a display property has changed.

Declaration
protected virtual void OnDisplayPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

A RadPropertyChangedEventArgs that contains the event data.

OnFontChanged(EventArgs)

Raises the System.Windows.Forms.Control.FontChanged event.

Declaration
protected override void OnFontChanged(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.

OnForeColorChanged(EventArgs)

Raises the System.Windows.Forms.Control.ForeColorChanged event.

Declaration
protected override void OnForeColorChanged(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.

OnHandleCreated(EventArgs)

Raises the System.Windows.Forms.Control.HandleCreated event.

Declaration
protected override void OnHandleCreated(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.

OnLayout(LayoutEventArgs)

Raises the System.Windows.Forms.Control.Layout event.

Declaration
protected override void OnLayout(LayoutEventArgs levent)
Parameters
System.Windows.Forms.LayoutEventArgs levent

A System.Windows.Forms.LayoutEventArgs that contains the event data.

OnLoad(Size)

Notifies that the control is about to be visualized.

Declaration
protected virtual void OnLoad(Size desiredSize)
Parameters
System.Drawing.Size desiredSize

OnLoad(EventArgs)

In this override we set the initial dpi scaling.

Declaration
protected override void OnLoad(EventArgs e)
Parameters
System.EventArgs e

OnNotifyPropertyChanged(PropertyChangedEventArgs)

Raises the property changed notification with the specified event arguments.

Declaration
protected virtual void OnNotifyPropertyChanged(PropertyChangedEventArgs e)
Parameters
System.ComponentModel.PropertyChangedEventArgs e

A System.ComponentModel.PropertyChangedEventArgs that contains the event data.

OnNotifyPropertyChanged(String)

Raises the property changed notification for the specified property name.

Declaration
protected virtual void OnNotifyPropertyChanged(string propertyName)
Parameters
System.String propertyName

The name of the property that changed.

OnPaint(PaintEventArgs)

Raises the System.Windows.Forms.Control.Paint event and delegates to the form behavior if present.

Declaration
protected override void OnPaint(PaintEventArgs e)
Parameters
System.Windows.Forms.PaintEventArgs e

A System.Windows.Forms.PaintEventArgs that contains the event data.

OnPaintBackground(PaintEventArgs)

Raises the background paint event and delegates to the form behavior if present.

Declaration
protected override void OnPaintBackground(PaintEventArgs e)
Parameters
System.Windows.Forms.PaintEventArgs e

A System.Windows.Forms.PaintEventArgs that contains the event data.

OnParentChanged(EventArgs)

Raises the System.Windows.Forms.Control.ParentChanged event.

Declaration
protected override void OnParentChanged(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.

OnScreenTipNeeded(Object, ScreenTipNeededEventArgs)

Raises the ScreenTipNeeded event.

Declaration
protected virtual void OnScreenTipNeeded(object sender, ScreenTipNeededEventArgs e)
Parameters
System.Object sender

The source of the event.
ScreenTipNeededEventArgs e

A ScreenTipNeededEventArgs that contains the event data.

OnShown(EventArgs)

Declaration
protected override void OnShown(EventArgs e)
Parameters
System.EventArgs e

OnThemeChanged()

Called when the theme has changed.

Declaration
protected virtual void OnThemeChanged()

OnThemeNameChanged(ThemeNameChangedEventArgs)

Raises the ThemeNameChanged event.

Declaration
protected virtual void OnThemeNameChanged(ThemeNameChangedEventArgs e)
Parameters
ThemeNameChangedEventArgs e

A ThemeNameChangedEventArgs that contains the event data.

OnToolTipTextNeeded(Object, ToolTipTextNeededEventArgs)

Raises the ToolTipTextNeeded event.

Declaration
protected virtual void OnToolTipTextNeeded(object sender, ToolTipTextNeededEventArgs e)
Parameters
System.Object sender

The source of the event.
ToolTipTextNeededEventArgs e

A ToolTipTextNeededEventArgs that contains the event data.

OnVisibleChanged(EventArgs)

Raises the System.Windows.Forms.Control.VisibleChanged event.

Declaration
protected override void OnVisibleChanged(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.

OnWm_SettingChange(Message)

Handles the WM_SETTINGCHANGE message to detect Windows theme changes.

Declaration
protected virtual void OnWm_SettingChange(Message m)
Parameters
System.Windows.Forms.Message m

The Windows message.

PerformDesignModeLocationCorrection(ref Message)

Performs design mode location correction for the form.

Declaration
protected virtual void PerformDesignModeLocationCorrection(ref Message msg)
Parameters
System.Windows.Forms.Message msg

The Windows message to process.

ProcessCaptureChangeRequested(RadElement, Boolean)

Processes a capture request from the specified element.

Declaration
protected virtual bool ProcessCaptureChangeRequested(RadElement element, bool capture)
Parameters
RadElement element

The element which requested the capture.
System.Boolean capture

True to capture; otherwise, false.
Returns
System.Boolean

True if the capture request is approved; otherwise, false.

ProcessDialogKey(Keys)

Processes a dialog box key.

Declaration
protected override bool ProcessDialogKey(Keys keyData)
Parameters
System.Windows.Forms.Keys keyData

One of the System.Windows.Forms.Keys values that represents the key to process.

Returns
System.Boolean

true if the keystroke was processed and consumed by the control; otherwise, false to allow further processing.

ProcessFocusRequested(RadElement)

Processes a focus request from the specified element.

Declaration
protected virtual bool ProcessFocusRequested(RadElement element)
Parameters
RadElement element

The element that requested the focus.
Returns
System.Boolean

True if focus is approved; otherwise, false.

RegisterHostedControl(RadHostItem)

Registers a hosted control with this form.

Declaration
public void RegisterHostedControl(RadHostItem hostElement)
Parameters
RadHostItem hostElement

The host element containing the control to register.
Implements

ResetFormBehavior(Boolean)

Resets the behavior associated with the Form. This method is used internally.

Declaration
public void ResetFormBehavior(bool callInitialize)
Parameters
System.Boolean callInitialize

True to call the InitializeFormBehavior method after resetting; otherwise, false.

ResumeDpiScaling()

Resumes DPI scaling operations.

Declaration
public void ResumeDpiScaling()

ResumeUpdate()

Resumes the painting of the control.

Declaration
public void ResumeUpdate()
Implements

ResumeUpdate(Boolean)

Resumes the painting of the control.

Declaration
public void ResumeUpdate(bool invalidate)
Parameters
System.Boolean invalidate

True to invalidate the control when resuming; otherwise, false.

ScaleControl(SizeF, BoundsSpecified)

Scales the control's location, size, and other properties.

Declaration
protected override void ScaleControl(SizeF factor, BoundsSpecified specified)
Parameters
System.Drawing.SizeF factor

The scaling factor.
System.Windows.Forms.BoundsSpecified specified

Which bounds to scale.

SetBoundsCore(Int32, Int32, Int32, Int32, BoundsSpecified)

Performs the work of setting the specified bounds of this control.

Declaration
protected override void SetBoundsCore(int x, int y, int width, int height, BoundsSpecified specified)
Parameters
System.Int32 x

The new Left property value of the control.
System.Int32 y

The new Top property value of the control.
System.Int32 width

The new Width property value of the control.
System.Int32 height

The new Height property value of the control.
System.Windows.Forms.BoundsSpecified specified

A bitwise combination of the System.Windows.Forms.BoundsSpecified values.

SetClientSizeCore(Int32, Int32)

Sets the size of the client area of the form.

Declaration
protected override void SetClientSizeCore(int x, int y)
Parameters
System.Int32 x

The width of the client area.
System.Int32 y

The height of the client area.

SetIconPrimitiveVisibility(Boolean)

Declaration
protected abstract void SetIconPrimitiveVisibility(bool visible)
Parameters
System.Boolean visible

ShouldSerializeBackColor()

Determines whether the BackColor property should be serialized.

Declaration
public bool ShouldSerializeBackColor()
Returns
System.Boolean

True if the BackColor should be serialized; otherwise, false.

ShouldSerializeFont()

Determines whether the Font property should be serialized.

Declaration
public bool ShouldSerializeFont()
Returns
System.Boolean

True if the Font should be serialized; otherwise, false.

ShouldSerializeForeColor()

Determines whether the ForeColor property should be serialized.

Declaration
public bool ShouldSerializeForeColor()
Returns
System.Boolean

True if the ForeColor should be serialized; otherwise, false.

ShouldSerializeProperty(RadProperty)

Determines whether the specified RadProperty should be serialized.

Declaration
protected virtual bool ShouldSerializeProperty(RadProperty property)
Parameters
RadProperty property

The property to check for serialization.
Returns
System.Boolean

True if the property should be serialized; otherwise, false.

SuspendDpiScaling()

Suspends DPI scaling operations.

Declaration
public void SuspendDpiScaling()

SuspendUpdate()

Suspends the painting of the control.

Declaration
public void SuspendUpdate()
Implements

UnregisterHostedControl(RadHostItem, Boolean)

Unregisters a hosted control from this form.

Declaration
public void UnregisterHostedControl(RadHostItem hostElement, bool removeControl)
Parameters
RadHostItem hostElement

The host element containing the control to unregister.
System.Boolean removeControl

True to remove the control from the Controls collection; otherwise, false.
Implements

UpdateDefaultButton()

Updates which button is the default button.

Declaration
protected override void UpdateDefaultButton()

WndProc(ref Message)

Processes Windows messages.

Declaration
protected override void WndProc(ref Message m)
Parameters
System.Windows.Forms.Message m

The Windows System.Windows.Forms.Message to process.

Events

Initialized

Occurs when the component's initialization is complete.

Declaration
public event EventHandler Initialized
Event Type
System.EventHandler

PropertyChanged

Occurs when a property of an object changes. Calling the event is developer's responsibility.

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
System.ComponentModel.PropertyChangedEventHandler

ScreenTipNeeded

Occurs prior to the ScreenTip of a RadItem instance inside the RadControl being displayed.

Declaration
public event ScreenTipNeededEventHandler ScreenTipNeeded
Event Type
ScreenTipNeededEventHandler

ThemeNameChanged

Occurs when the theme name has changed.

Declaration
public event ThemeNameChangedEventHandler ThemeNameChanged
Event Type
ThemeNameChangedEventHandler

Implements

ToolTipTextNeeded

Occurs when a RadItem instance inside the RadControl requires ToolTip text.

Declaration
public event ToolTipTextNeededEventHandler ToolTipTextNeeded
Event Type
ToolTipTextNeededEventHandler

Implements

WindowsThemeChanged

Occurs when the Windows theme is changed (to Light, Dark or HighContrast).

Declaration
public event WindowsThemeEventHandler WindowsThemeChanged
Event Type
WindowsThemeEventHandler

Explicit Interface Implementations

IComponentTreeHandler.Behavior

Gets the behavior for handling component input.

Declaration
ComponentInputBehavior IComponentTreeHandler.Behavior { get; }
Returns
ComponentInputBehavior

Implements

IComponentTreeHandler.CallOnMouseCaptureChanged(EventArgs)

Calls the OnMouseCaptureChanged method.

Declaration
void IComponentTreeHandler.CallOnMouseCaptureChanged(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.
Implements

IComponentTreeHandler.CallOnScreenTipNeeded(Object, ScreenTipNeededEventArgs)

Calls the OnScreenTipNeeded method.

Declaration
void IComponentTreeHandler.CallOnScreenTipNeeded(object sender, ScreenTipNeededEventArgs e)
Parameters
System.Object sender

The source of the event.
ScreenTipNeededEventArgs e

A ScreenTipNeededEventArgs that contains the event data.
Implements

IComponentTreeHandler.CallOnThemeNameChanged(ThemeNameChangedEventArgs)

Calls the OnThemeNameChanged method.

Declaration
void IComponentTreeHandler.CallOnThemeNameChanged(ThemeNameChangedEventArgs e)
Parameters
ThemeNameChangedEventArgs e

A ThemeNameChangedEventArgs that contains the event data.
Implements

IComponentTreeHandler.CallOnToolTipTextNeeded(Object, ToolTipTextNeededEventArgs)

Calls the OnToolTipTextNeeded method.

Declaration
void IComponentTreeHandler.CallOnToolTipTextNeeded(object sender, ToolTipTextNeededEventArgs e)
Parameters
System.Object sender

The source of the event.
ToolTipTextNeededEventArgs e

A ToolTipTextNeededEventArgs that contains the event data.
Implements

IComponentTreeHandler.CreateChildItems(RadElement)

Creates child items for the parent element.

Declaration
void IComponentTreeHandler.CreateChildItems(RadElement parent)
Parameters
RadElement parent

The parent element.
Implements

IComponentTreeHandler.CreateRootElement()

Creates the root element.

Declaration
RootRadElement IComponentTreeHandler.CreateRootElement()
Returns
RootRadElement

A new RootRadElement instance.
Implements

IComponentTreeHandler.get_Name()

Declaration
string IComponentTreeHandler.get_Name()
Returns
System.String

Implements
Telerik.WinControls.IComponentTreeHandler.get_Name()

IComponentTreeHandler.GetAmbientPropertyValue(RadProperty)

Gets the ambient property value for the specified property.

Declaration
object IComponentTreeHandler.GetAmbientPropertyValue(RadProperty property)
Parameters
RadProperty property

The property to get the ambient value for.
Returns
System.Object

The ambient property value, or RadProperty.UnsetValue if not found.
Implements

IComponentTreeHandler.GetShowFocusCues()

Gets a value indicating whether focus cues should be shown.

Declaration
bool IComponentTreeHandler.GetShowFocusCues()
Returns
System.Boolean

True if focus cues should be shown; otherwise, false.
Implements

IComponentTreeHandler.InitializeRootElement(RootRadElement)

Initializes the root element.

Declaration
void IComponentTreeHandler.InitializeRootElement(RootRadElement rootElement)
Parameters
RootRadElement rootElement

The root element to initialize.
Implements

IComponentTreeHandler.Initializing

Gets a value indicating whether the control is initializing.

Declaration
bool IComponentTreeHandler.Initializing { get; }
Returns
System.Boolean

Implements

IComponentTreeHandler.OnAmbientPropertyChanged(RadProperty)

Called when an ambient property has changed.

Declaration
void IComponentTreeHandler.OnAmbientPropertyChanged(RadProperty property)
Parameters
RadProperty property

The property that has changed.
Implements

IComponentTreeHandler.OnCaptureChangeRequested(RadElement, Boolean)

Processes a capture change request from an element.

Declaration
bool IComponentTreeHandler.OnCaptureChangeRequested(RadElement element, bool capture)
Parameters
RadElement element

The element that requested the capture change.
System.Boolean capture

True to capture; otherwise, false.
Returns
System.Boolean

True if capture change is approved; otherwise, false.
Implements

IComponentTreeHandler.OnDisplayPropertyChanged(RadPropertyChangedEventArgs)

Called when a display property has changed.

Declaration
void IComponentTreeHandler.OnDisplayPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

A RadPropertyChangedEventArgs that contains the event data.
Implements

IComponentTreeHandler.OnFocusRequested(RadElement)

Processes a focus request from an element.

Declaration
bool IComponentTreeHandler.OnFocusRequested(RadElement element)
Parameters
RadElement element

The element that requested the focus.
Returns
System.Boolean

True if focus is approved; otherwise, false.
Implements

IComponentTreeHandler.set_Name(String)

Declaration
void IComponentTreeHandler.set_Name(string value)
Parameters
System.String value

Implements
Telerik.WinControls.IComponentTreeHandler.set_Name(System.String)

IComponentTreeHandler.SmallImageList

Gets the small image list.

Declaration
ImageList IComponentTreeHandler.SmallImageList { get; set; }
Returns
System.Windows.Forms.ImageList

Implements

IComponentTreeHandler.ThemeClassName

Gets or sets the theme class name.

Declaration
string IComponentTreeHandler.ThemeClassName { get; set; }
Returns
System.String

Implements

Extension Methods