Class RadControl
Serves as the foundational base class for all Telerik WinControls, bridging the Windows Forms framework with the Telerik Presentation Framework (TPF) element-based architecture.
Inheritance
Namespace: Telerik.WinControls
Assembly: Telerik.WinControls.dll
Syntax
public class RadControl : ScrollableControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider
Remarks
RadControl acts as the host and coordinator for the entire RadElement tree that defines a control's structure and behavior. It inherits from System.Windows.Forms.ScrollableControl for full Windows Forms compatibility while managing the sophisticated TPF element hierarchy through its RootElement.
As an IComponentTreeHandler, RadControl manages hosted controls, coordinates focus and DPI scaling, and translates Windows Forms messages into TPF element events. It implements System.ComponentModel.INotifyPropertyChanged to ensure property changes are communicated to data binding systems.
All RadControls participate in the unified theming system, automatically applying themes to their element trees and responding to runtime theme changes. The control includes comprehensive design-time support for Visual Studio integration and serves as the foundation for RadButton, RadTextBox, RadGridView, and all other Telerik controls.
Constructors
RadControl()
Declaration
public RadControl()
Fields
invalidResizeRect
Declaration
protected Rectangle invalidResizeRect
Field Value
|
System.Drawing.Rectangle
|
isAccessibilityRequested
Declaration
protected bool isAccessibilityRequested
Field Value
|
System.Boolean
|
isDisposing2
Declaration
protected bool isDisposing2
Field Value
|
System.Boolean
|
isResizing2
Declaration
protected bool isResizing2
Field Value
|
System.Boolean
|
Properties
AccessibilityRequested
Gets or sets a value indicating whether the CodedUI Tests functionality is requested from external program such a Narrator.
Declaration
public virtual bool AccessibilityRequested { get; set; }
Property Value
|
System.Boolean
|
AllowShowFocusCues
Indicates focus cues display, when available, based on the corresponding control type and the current UI state.
Declaration
public virtual bool AllowShowFocusCues { get; set; }
Property Value
|
System.Boolean
|
AnalyticsName
Gets or sets the Analytics Name associated with this control. By default the Control Name property is logged. If you want to customize the information which will be logged for this control set this property to a preferred value.
Declaration
public virtual string AnalyticsName { get; set; }
Property Value
|
System.String
|
Implements
AutoSize
Gets or sets a value indicating whether the control is automatically resized to display its entire contents.
Declaration
public override bool AutoSize { get; set; }
Property Value
|
System.Boolean
|
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 input behavior for the control.
Declaration
public ComponentInputBehavior Behavior { get; }
Property Value
|
ComponentInputBehavior
|
CausesValidation
Gets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus.
Declaration
public bool CausesValidation { get; set; }
Property Value
|
System.Boolean
|
CommandBindings
Declaration
public InputBindingsCollection CommandBindings { get; }
Property Value
|
InputBindingsCollection
|
ElementTree
Declaration
public virtual ComponentThemableElementTree ElementTree { get; }
Property Value
|
ComponentThemableElementTree
|
EnableAnalytics
Gets or sets a value indicating whether the Analytics functionality is enabled or disabled for this control.
Declaration
public virtual bool EnableAnalytics { get; set; }
Property Value
|
System.Boolean
|
Implements
EnableCodedUITests
Gets or sets a value indicating whether the CodedUI Tests functionality is enabled.
Declaration
public virtual bool EnableCodedUITests { get; set; }
Property Value
|
System.Boolean
|
EnableCodedUITestsDefaultValue
Gets or sets the default value for EnableCodedUITests property.
Declaration
public static bool EnableCodedUITestsDefaultValue { get; set; }
Property Value
|
System.Boolean
|
EnableDpiScaling
Gets or sets a value indicating whether the RadControls scaling logic will be used when the application is run in a high DPI environment.
Declaration
public static bool EnableDpiScaling { get; set; }
Property Value
|
System.Boolean
|
EnableGestures
Gets or sets a value indicating whether the Gestures functionality is enabled.
Declaration
public virtual bool EnableGestures { get; set; }
Property Value
|
System.Boolean
|
EnableImageDpiScaling
Gets or sets a value indicating whether the RadControls scaling logic will be used to resize the images when the application is run in a high DPI environment.
Declaration
public static bool EnableImageDpiScaling { get; set; }
Property Value
|
System.Boolean
|
EnableKeyMap
Gets or sets whether 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 virtual bool EnableKeyMap { get; set; }
Property Value
|
System.Boolean
|
EnableRadAccessibilityObjects
Gets or sets a value indicating whether the RadControls Accessible custom object is enabled.
Declaration
public virtual bool EnableRadAccessibilityObjects { get; set; }
Property Value
|
System.Boolean
|
EnableRadAutoScale
Gets or sets a value that indicates whether to use the new auto-scaling mechanism or not. Enabled by default.
Declaration
public static bool EnableRadAutoScale { get; set; }
Property Value
|
System.Boolean
|
EnableRadFormInitialDpiScaling
Do not modify. For internal use only.
Declaration
public static bool EnableRadFormInitialDpiScaling { get; set; }
Property Value
|
System.Boolean
|
EnableSvgImages
Gets or sets a value indicating whether the RadControls will draw use the SvgImages in ImagePrimitive and LightVisualElement objects, or if [false] will draw the corresponding Image property if applicable.
Declaration
public static bool EnableSvgImages { get; set; }
Property Value
|
System.Boolean
|
EnableTheming
Gets or sets value indicating whether the control is styled through theme
Declaration
public bool EnableTheming { get; set; }
Property Value
|
System.Boolean
|
EnableUIAutomation
Gets or sets a value indicating whether the UI Automation functionality is enabled.
Declaration
public virtual bool EnableUIAutomation { get; set; }
Property Value
|
System.Boolean
|
EnableUIAutomationDefaultValue
Gets or sets the default value for EnableUIAutomation property.
Declaration
public static bool EnableUIAutomationDefaultValue { get; set; }
Property Value
|
System.Boolean
|
Focusable
Declaration
public virtual bool Focusable { get; set; }
Property Value
|
System.Boolean
|
FocusedElement
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
|
ImageList
Gets or sets the ImageList that contains the images displayed by this control.
Declaration
public virtual ImageList ImageList { get; set; }
Property Value
|
System.Windows.Forms.ImageList
|
Implements
ImageScalingSize
Gets or sets the image scaling size.
Declaration
public Size ImageScalingSize { get; set; }
Property Value
|
System.Drawing.Size
|
Implements
IsDesignMode
Declaration
public bool IsDesignMode { get; }
Property Value
|
System.Boolean
|
IsDisplayed
Determines whether the control is currently displayed on the screen.
Declaration
public bool IsDisplayed { get; }
Property Value
|
System.Boolean
|
IsInitializing
Declaration
public bool IsInitializing { get; }
Property Value
|
System.Boolean
|
IsLoaded
Determines whether the control is properly loaded.
Declaration
public bool IsLoaded { get; }
Property Value
|
System.Boolean
|
IsTrial
Declaration
public static bool IsTrial { get; }
Property Value
|
System.Boolean
|
LayoutManager
MaximumSize
Gets or sets the size that is the upper limit that GetPreferredSize can specify.
Declaration
public override Size MaximumSize { get; set; }
Property Value
|
System.Drawing.Size
|
MinimumSize
Gets or sets the size that is the lower limit that GetPreferredSize can specify
Declaration
public override Size MinimumSize { get; set; }
Property Value
|
System.Drawing.Size
|
Padding
Gets or sets padding within the control.
Declaration
public Padding Padding { get; set; }
Property Value
|
System.Windows.Forms.Padding
A System.Windows.Forms.Padding representing the control's internal spacing characteristics. |
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
Declaration
public override ISite Site { get; set; }
Property Value
|
System.ComponentModel.ISite
|
SmallImageList
Gets or sets the SmallImageList that contains the small images which are displayed when there's not enough space.
Declaration
public virtual ImageList SmallImageList { get; set; }
Property Value
|
System.Windows.Forms.ImageList
|
Implements
SmallImageScalingSize
Gets or sets the small image scaling size.
Declaration
public Size SmallImageScalingSize { get; set; }
Property Value
|
System.Drawing.Size
|
Implements
Text
Declaration
public override string Text { get; set; }
Property Value
|
System.String
|
ThemeClassName
Gets or sets the class name string that ThemeResolutionService will use to find the themes registered for the control.
Declaration
public virtual string ThemeClassName { get; set; }
Property Value
|
System.String
|
Remarks
By default the return value is RadControl's type FullName; Some controls like drop down menu has different ThemeClassName depending on the runtime usage of the control.
ThemeName
Gets or sets control's preferred theme name. Themes are stored and retrieved using APIs of ThemeResolutionService.
Declaration
public virtual string ThemeName { get; set; }
Property Value
|
System.String
|
Implements
Remarks
If ThemeResolutionService.ApplicatonThemeName refers to a non-empty string, the theme of a RadControl can differ from the one set using RadControls.ThemeName property. If the themes differ, the RadControls.ThemeName property will be overridden by ThemeResolutionService.ApplicatonThemeName. If no theme is registered with a name as ThemeResolutionService.ApplicatonThemeName, then control will revert to the theme specified by its ThemeName property. If ThemeName is assigned to a non-existing theme name, the control may have no visual properties assigned, which will cause it look and behave in unexpected manner. If ThemeName equals empty string, control's theme is set to a theme that is registered within ThemeResolutionService with the name "ControlDefault".
UseCompatibleTextRendering
Determines whether to use compatible text rendering engine (GDI+) or not (GDI).
Declaration
public virtual bool UseCompatibleTextRendering { get; set; }
Property Value
|
System.Boolean
|
UseCompatibleTextRenderingDefaultValue
Set or get the default value for UseCompatibleTextRendering property.
Declaration
public static bool UseCompatibleTextRenderingDefaultValue { get; set; }
Property Value
|
System.Boolean
|
ValidationCancel
Declaration
protected bool ValidationCancel { get; }
Property Value
|
System.Boolean
|
Methods
BeginInit()
Suspends layout during initialization.
Declaration
public virtual void BeginInit()
CallAccessibilityNotifyClients(AccessibleEvents, Int32)
This method is used internally!
Declaration
public void CallAccessibilityNotifyClients(AccessibleEvents accEvent, int childId)
Parameters
|
System.Windows.Forms.AccessibleEvents
accEvent
|
|
System.Int32
childId
|
CallBaseOnGotFocus(EventArgs)
This method is used internally!
Declaration
public void CallBaseOnGotFocus(EventArgs e)
Parameters
|
System.EventArgs
e
|
CallBaseOnKeyDown(KeyEventArgs)
This method is used internally!
Declaration
public void CallBaseOnKeyDown(KeyEventArgs e)
Parameters
|
System.Windows.Forms.KeyEventArgs
e
|
CallBaseOnKeyPress(KeyPressEventArgs)
This method is used internally!
Declaration
public void CallBaseOnKeyPress(KeyPressEventArgs e)
Parameters
|
System.Windows.Forms.KeyPressEventArgs
e
|
CallBaseOnKeyUp(KeyEventArgs)
This method is used internally!
Declaration
public void CallBaseOnKeyUp(KeyEventArgs e)
Parameters
|
System.Windows.Forms.KeyEventArgs
e
|
CallBaseOnLostFocus(EventArgs)
This method is used internally!
Declaration
public void CallBaseOnLostFocus(EventArgs e)
Parameters
|
System.EventArgs
e
|
CallOnClick(EventArgs)
This method is used internally!
Declaration
public void CallOnClick(EventArgs e)
Parameters
|
System.EventArgs
e
|
CallOnDoubleClick(EventArgs)
This method is used internally!
Declaration
public void CallOnDoubleClick(EventArgs e)
Parameters
|
System.EventArgs
e
|
CallOnKeyDown(KeyEventArgs)
This method is used internally!
Declaration
public void CallOnKeyDown(KeyEventArgs e)
Parameters
|
System.Windows.Forms.KeyEventArgs
e
|
CallOnKeyPress(KeyPressEventArgs)
This method is used internally!
Declaration
public void CallOnKeyPress(KeyPressEventArgs e)
Parameters
|
System.Windows.Forms.KeyPressEventArgs
e
|
CallOnKeyUp(KeyEventArgs)
This method is used internally!
Declaration
public void CallOnKeyUp(KeyEventArgs e)
Parameters
|
System.Windows.Forms.KeyEventArgs
e
|
CallOnMouseCaptureChanged(EventArgs)
This method is used internally!
Declaration
public void CallOnMouseCaptureChanged(EventArgs e)
Parameters
|
System.EventArgs
e
|
CallOnMouseDown(MouseEventArgs)
This method is used internally!
Declaration
public void CallOnMouseDown(MouseEventArgs e)
Parameters
|
System.Windows.Forms.MouseEventArgs
e
|
CallOnMouseEnter(EventArgs)
This method is used internally!
Declaration
public void CallOnMouseEnter(EventArgs e)
Parameters
|
System.EventArgs
e
|
CallOnMouseHover(EventArgs)
This method is used internally!
Declaration
public void CallOnMouseHover(EventArgs e)
Parameters
|
System.EventArgs
e
|
CallOnMouseLeave(EventArgs)
This method is used internally!
Declaration
public void CallOnMouseLeave(EventArgs e)
Parameters
|
System.EventArgs
e
|
CallOnMouseMove(MouseEventArgs)
This method is used internally!
Declaration
public void CallOnMouseMove(MouseEventArgs e)
Parameters
|
System.Windows.Forms.MouseEventArgs
e
|
CallOnMouseUp(MouseEventArgs)
This method is used internally!
Declaration
public void CallOnMouseUp(MouseEventArgs e)
Parameters
|
System.Windows.Forms.MouseEventArgs
e
|
CallOnMouseWheel(MouseEventArgs)
This method is used internally!
Declaration
public void CallOnMouseWheel(MouseEventArgs e)
Parameters
|
System.Windows.Forms.MouseEventArgs
e
|
CallOnPreviewKeyDown(PreviewKeyDownEventArgs)
This method is used internally!
Declaration
public void CallOnPreviewKeyDown(PreviewKeyDownEventArgs e)
Parameters
|
System.Windows.Forms.PreviewKeyDownEventArgs
e
|
CallOnScreenTipNeeded(Object, ScreenTipNeededEventArgs)
This method is used internally!
Declaration
public void CallOnScreenTipNeeded(object sender, ScreenTipNeededEventArgs e)
Parameters
|
System.Object
sender
|
|
ScreenTipNeededEventArgs
e
|
CallOnThemeNameChanged(ThemeNameChangedEventArgs)
This method is used internally!
Declaration
public void CallOnThemeNameChanged(ThemeNameChangedEventArgs e)
Parameters
|
ThemeNameChangedEventArgs
e
|
CallOnToolTipTextNeeded(Object, ToolTipTextNeededEventArgs)
This method is used internally!
Declaration
public void CallOnToolTipTextNeeded(object sender, ToolTipTextNeededEventArgs e)
Parameters
|
System.Object
sender
|
|
ToolTipTextNeededEventArgs
e
|
CallOnVisibleChanged(EventArgs)
This method is used internally!
Declaration
public void CallOnVisibleChanged(EventArgs e)
Parameters
|
System.EventArgs
e
|
CanEditElementAtDesignTime(RadElement)
Determines whether an element may be edited via the EditUIElements dialog at design-time.
Declaration
protected virtual bool CanEditElementAtDesignTime(RadElement element)
Parameters
|
RadElement
element
|
Returns
|
System.Boolean
|
CanEditUIElement(RadElement)
Determines whether an element from this element tree may be displayed in the EditUIElements dialog.
Declaration
public bool CanEditUIElement(RadElement element)
Parameters
|
RadElement
element
|
Returns
|
System.Boolean
|
Construct()
Declaration
protected virtual void Construct()
ControlDefinesThemeForElement(RadElement)
Checks whether the element's theme is defined by the control.
Declaration
public virtual bool ControlDefinesThemeForElement(RadElement element)
Parameters
|
RadElement
element
The element to should be checked. |
Returns
|
System.Boolean
true if the control defines theme for this element, false otherwise. |
Implements
Remarks
If true is returned the ThemeResolutionService would not not set any theme to the element to avoid duplicating the style settings of the element.
CreateBehavior()
Creates the input behavior instance. Allows inheritors to provide custom input implementations.
Declaration
protected virtual ComponentInputBehavior CreateBehavior()
Returns
|
ComponentInputBehavior
|
CreateChildItems(RadElement)
CreateRootElement()
DisableGesture(GestureType)
Disable firing gesture events of the specified type.
Declaration
public void DisableGesture(GestureType type)
Parameters
|
GestureType
type
The type of gesture events to disable. |
Dispose(Boolean)
Declaration
protected override void Dispose(bool disposing)
Parameters
|
System.Boolean
disposing
|
EnableGesture(GestureType)
Enable firing gesture events of the specified type.
Declaration
public void EnableGesture(GestureType type)
Parameters
|
GestureType
type
The type of gesture events to enable. |
EndInit()
Resumes layout.
Declaration
public virtual void EndInit()
FindPropertyInChildren(RadControl, IPCMessage)
Declaration
protected virtual bool FindPropertyInChildren(RadControl radControl, IPCMessage request)
Parameters
|
RadControl
radControl
|
|
IPCMessage
request
|
Returns
|
System.Boolean
|
GetChildAt(Int32)
Method used by control Code Dom serializer to access element in the collection of RootElement.
Declaration
public RadElement GetChildAt(int index)
Parameters
|
System.Int32
index
|
Returns
|
RadElement
|
GetControlDefaultSize()
This method is used internally!
Declaration
public Size GetControlDefaultSize()
Returns
|
System.Drawing.Size
The default size for this control |
GetInputElement()
GetMonitorDpiScaleFactor(Control)
Gets the DPI scale factor for the monitor where the specified control is currently displayed.
Declaration
protected virtual SizeF GetMonitorDpiScaleFactor(Control control)
Parameters
|
System.Windows.Forms.Control
control
The control used to determine which monitor to query for DPI information. |
Returns
|
System.Drawing.SizeF
A System.Drawing.SizeF representing the DPI scale factor where both Width and Height contain the same scaling value (e.g., 1.25 for 125% scaling, 1.5 for 150% scaling). |
Remarks
This method is used by the RadAutoScale system to determine the target DPI scaling that should be applied to the control. It queries the Windows DPI awareness system to get the effective DPI for the window handle and converts it to a scale factor relative to the standard 96 DPI.
The method is virtual to allow derived controls to customize DPI detection behavior if needed, such as for specialized hosting scenarios or custom DPI handling requirements.
This method requires Windows 10 Anniversary Update (1607) or later for per-monitor DPI awareness support. On earlier versions, the system falls back to other DPI detection methods.
GetPlainText()
Strips all html tags of the text set to the control and returns only the plain text.
Declaration
public string GetPlainText()
Returns
|
System.String
Plain text stripped of any html tags. |
GetPreferredSize(Size)
Declaration
public override Size GetPreferredSize(Size proposedSize)
Parameters
|
System.Drawing.Size
proposedSize
|
Returns
|
System.Drawing.Size
|
GetRootElementDesiredSize(Int32, Int32, Int32, Int32)
Declaration
protected virtual Size GetRootElementDesiredSize(int x, int y, int width, int height)
Parameters
|
System.Int32
x
|
|
System.Int32
y
|
|
System.Int32
width
|
|
System.Int32
height
|
Returns
|
System.Drawing.Size
|
InitializeRootElement(RootRadElement)
Declaration
protected virtual void InitializeRootElement(RootRadElement rootElement)
Parameters
|
RootRadElement
rootElement
|
InvokeLayoutCallback(LayoutCallback)
Declaration
public void InvokeLayoutCallback(LayoutCallback callback)
Parameters
|
LayoutCallback
callback
|
Implements
IsInputKey(Keys)
Declaration
protected override bool IsInputKey(Keys keyData)
Parameters
|
System.Windows.Forms.Keys
keyData
|
Returns
|
System.Boolean
|
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)
Declaration
protected override void OnAutoSizeChanged(EventArgs e)
Parameters
|
System.EventArgs
e
|
OnBackColorChanged(EventArgs)
Declaration
protected override void OnBackColorChanged(EventArgs e)
Parameters
|
System.EventArgs
e
|
OnBindingContextChanged(EventArgs)
Declaration
protected override void OnBindingContextChanged(EventArgs e)
Parameters
|
System.EventArgs
e
|
OnCaptureLosing()
Declaration
protected virtual void OnCaptureLosing()
OnClick(EventArgs)
Declaration
protected override void OnClick(EventArgs e)
Parameters
|
System.EventArgs
e
|
OnCreateControl()
Declaration
protected override void OnCreateControl()
OnDoubleClick(EventArgs)
Declaration
protected override void OnDoubleClick(EventArgs e)
Parameters
|
System.EventArgs
e
|
OnEnabledChanged(EventArgs)
Declaration
protected override void OnEnabledChanged(EventArgs e)
Parameters
|
System.EventArgs
e
|
OnFontChanged(EventArgs)
Declaration
protected override void OnFontChanged(EventArgs e)
Parameters
|
System.EventArgs
e
|
OnForeColorChanged(EventArgs)
Declaration
protected override void OnForeColorChanged(EventArgs e)
Parameters
|
System.EventArgs
e
|
OnGesture(GestureEventArgs)
Declaration
protected virtual void OnGesture(GestureEventArgs args)
Parameters
|
GestureEventArgs
args
|
OnGotFocus(EventArgs)
Declaration
protected override void OnGotFocus(EventArgs e)
Parameters
|
System.EventArgs
e
|
OnHandleDestroyed(EventArgs)
Declaration
protected override void OnHandleDestroyed(EventArgs e)
Parameters
|
System.EventArgs
e
|
OnInvalidated(RadElement)
OnKeyDown(KeyEventArgs)
Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
|
System.Windows.Forms.KeyEventArgs
e
|
OnKeyPress(KeyPressEventArgs)
Declaration
protected override void OnKeyPress(KeyPressEventArgs e)
Parameters
|
System.Windows.Forms.KeyPressEventArgs
e
|
OnKeyUp(KeyEventArgs)
Declaration
protected override void OnKeyUp(KeyEventArgs e)
Parameters
|
System.Windows.Forms.KeyEventArgs
e
|
OnLayout(LayoutEventArgs)
Declaration
protected override void OnLayout(LayoutEventArgs e)
Parameters
|
System.Windows.Forms.LayoutEventArgs
e
|
OnLoad(Size)
Notifies that the control is about to be visualized.
Declaration
protected virtual void OnLoad(Size desiredSize)
Parameters
|
System.Drawing.Size
desiredSize
|
OnLocationChanged(EventArgs)
Declaration
protected override void OnLocationChanged(EventArgs e)
Parameters
|
System.EventArgs
e
|
OnLostFocus(EventArgs)
Declaration
protected override void OnLostFocus(EventArgs e)
Parameters
|
System.EventArgs
e
|
OnMouseCaptureChanged(EventArgs)
Declaration
protected override void OnMouseCaptureChanged(EventArgs e)
Parameters
|
System.EventArgs
e
|
OnMouseDown(MouseEventArgs)
Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
|
System.Windows.Forms.MouseEventArgs
e
|
OnMouseEnter(EventArgs)
Declaration
protected override void OnMouseEnter(EventArgs e)
Parameters
|
System.EventArgs
e
|
OnMouseHover(EventArgs)
Declaration
protected override void OnMouseHover(EventArgs e)
Parameters
|
System.EventArgs
e
|
OnMouseLeave(EventArgs)
Declaration
protected override void OnMouseLeave(EventArgs e)
Parameters
|
System.EventArgs
e
|
OnMouseMove(MouseEventArgs)
Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
|
System.Windows.Forms.MouseEventArgs
e
|
OnMouseUp(MouseEventArgs)
Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
|
System.Windows.Forms.MouseEventArgs
e
|
OnMouseWheel(MouseEventArgs)
Declaration
protected override void OnMouseWheel(MouseEventArgs e)
Parameters
|
System.Windows.Forms.MouseEventArgs
e
|
OnNotifyPropertyChanged(PropertyChangedEventArgs)
Declaration
protected virtual void OnNotifyPropertyChanged(PropertyChangedEventArgs e)
Parameters
|
System.ComponentModel.PropertyChangedEventArgs
e
|
OnNotifyPropertyChanged(String)
Raises the PropertyChanged event
Declaration
protected virtual void OnNotifyPropertyChanged(string propertyName)
Parameters
|
System.String
propertyName
The name of the property |
OnPaddingChanged(EventArgs)
Declaration
protected override void OnPaddingChanged(EventArgs e)
Parameters
|
System.EventArgs
e
|
OnPaint(PaintEventArgs)
Declaration
protected override void OnPaint(PaintEventArgs e)
Parameters
|
System.Windows.Forms.PaintEventArgs
e
|
OnPanGesture(PanGestureEventArgs)
Fires the PanGesture event.
Declaration
protected virtual void OnPanGesture(PanGestureEventArgs args)
Parameters
|
PanGestureEventArgs
args
The arguments for the PanGesture event. |
OnParentChanged(EventArgs)
Declaration
protected override void OnParentChanged(EventArgs e)
Parameters
|
System.EventArgs
e
|
OnPressAndTapGesture(PressAndTapGestureEventArgs)
Fires the PressAndTapGesture event.
Declaration
protected virtual void OnPressAndTapGesture(PressAndTapGestureEventArgs args)
Parameters
|
PressAndTapGestureEventArgs
args
The arguments for the PressAndTapGesture event. |
OnPreviewKeyDown(PreviewKeyDownEventArgs)
Declaration
protected override void OnPreviewKeyDown(PreviewKeyDownEventArgs e)
Parameters
|
System.Windows.Forms.PreviewKeyDownEventArgs
e
|
OnRightToLeftChanged(EventArgs)
Declaration
protected override void OnRightToLeftChanged(EventArgs e)
Parameters
|
System.EventArgs
e
|
OnRotateGesture(RotateGestureEventArgs)
Fires the RotateGesture event.
Declaration
protected virtual void OnRotateGesture(RotateGestureEventArgs args)
Parameters
|
RotateGestureEventArgs
args
The arguments for the RotateGesture event. |
OnScreenTipNeeded(Object, ScreenTipNeededEventArgs)
Declaration
protected virtual void OnScreenTipNeeded(object sender, ScreenTipNeededEventArgs e)
Parameters
|
System.Object
sender
|
|
ScreenTipNeededEventArgs
e
|
OnThemeChanged()
Declaration
protected virtual void OnThemeChanged()
OnThemeNameChanged(ThemeNameChangedEventArgs)
Declaration
protected virtual void OnThemeNameChanged(ThemeNameChangedEventArgs e)
Parameters
|
ThemeNameChangedEventArgs
e
|
OnToolTipTextNeeded(Object, ToolTipTextNeededEventArgs)
Declaration
protected virtual void OnToolTipTextNeeded(object sender, ToolTipTextNeededEventArgs e)
Parameters
|
System.Object
sender
|
|
ToolTipTextNeededEventArgs
e
|
OnTwoFingerTapGesture(GestureEventArgs)
Fires the TwoFingerTapGesture event.
Declaration
protected virtual void OnTwoFingerTapGesture(GestureEventArgs args)
Parameters
|
GestureEventArgs
args
The arguments for the TwoFingerTapGesture event. |
OnVisibleChanged(EventArgs)
Declaration
protected override void OnVisibleChanged(EventArgs e)
Parameters
|
System.EventArgs
e
|
OnZoomGesture(ZoomGestureEventArgs)
Fires the ZoomGesture event.
Declaration
protected virtual void OnZoomGesture(ZoomGestureEventArgs args)
Parameters
|
ZoomGestureEventArgs
args
The arguments for the ZoomGesture event. |
PerformRadAutoScale(Nullable<BoundsSpecified>)
Performs auto scaling of the control.
Declaration
protected virtual void PerformRadAutoScale(BoundsSpecified? specified = default(BoundsSpecified? ))
Parameters
|
System.Nullable<System.Windows.Forms.BoundsSpecified>
specified
|
ProcessAutoSizeChanged(Boolean)
Declaration
protected virtual void ProcessAutoSizeChanged(bool value)
Parameters
|
System.Boolean
value
|
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
|
Returns
|
System.Boolean
True if the capture request is approved, otherwise false. |
ProcessCodedUIMessage(ref IPCMessage)
Declaration
protected virtual void ProcessCodedUIMessage(ref IPCMessage request)
Parameters
|
IPCMessage
request
|
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, false otherwise. |
ProcessGesture(Message)
Declaration
protected bool ProcessGesture(Message m)
Parameters
|
System.Windows.Forms.Message
m
|
Returns
|
System.Boolean
|
ProcessMnemonic(Char)
Declaration
protected override bool ProcessMnemonic(char charCode)
Parameters
|
System.Char
charCode
|
Returns
|
System.Boolean
|
Refresh()
Declaration
public override void Refresh()
RegisterHostedControl(RadHostItem)
Declaration
public virtual void RegisterHostedControl(RadHostItem hostElement)
Parameters
|
RadHostItem
hostElement
|
Implements
ResetBackColorThemeOverrides()
Declaration
protected virtual void ResetBackColorThemeOverrides()
ResetForeColorThemeOverrides()
Declaration
protected virtual void ResetForeColorThemeOverrides()
ResetProperty(RadProperty, RadObject)
Reset the property to its default value.
Declaration
protected virtual void ResetProperty(RadProperty property, RadObject element)
Parameters
|
RadProperty
property
The RadProperty to be reset. |
|
RadObject
element
The RadObject owner of the property. |
ResolveStyleGroupForElement(StyleGroup, RadObject)
Replaces the default style group for specific element.
Declaration
public virtual StyleGroup ResolveStyleGroupForElement(StyleGroup styleGroup, RadObject element)
Parameters
|
StyleGroup
styleGroup
The style group to replace. |
|
RadObject
element
The element on which this style should apply. |
Returns
|
StyleGroup
An instance of StyleGroup is successfull. |
ResumeUpdate()
ResumeUpdate(Boolean)
Declaration
public void ResumeUpdate(bool invalidate)
Parameters
|
System.Boolean
invalidate
|
ScaleControl(SizeF, BoundsSpecified)
Declaration
protected override void ScaleControl(SizeF factor, BoundsSpecified specified)
Parameters
|
System.Drawing.SizeF
factor
|
|
System.Windows.Forms.BoundsSpecified
specified
|
SetBackColorThemeOverrides()
Declaration
protected virtual void SetBackColorThemeOverrides()
SetBoundsCore(Int32, Int32, Int32, Int32, BoundsSpecified)
Declaration
protected override void SetBoundsCore(int x, int y, int width, int height, BoundsSpecified specified)
Parameters
|
System.Int32
x
|
|
System.Int32
y
|
|
System.Int32
width
|
|
System.Int32
height
|
|
System.Windows.Forms.BoundsSpecified
specified
|
SetForeColorThemeOverrides()
Declaration
protected virtual void SetForeColorThemeOverrides()
SetIsInitializing(Boolean)
This method is used internally!
Declaration
public void SetIsInitializing(bool value)
Parameters
|
System.Boolean
value
|
SetRadAutoScale(Boolean)
Enables/disables RadAutoScale. If you want to disable RadAutoScale for this control, call this method immediately after creating the control.
Declaration
public void SetRadAutoScale(bool isEnabled)
Parameters
|
System.Boolean
isEnabled
|
ShouldSerializeBackColor()
Determines whether the BackColor property should be serialized.
Declaration
public bool ShouldSerializeBackColor()
Returns
|
System.Boolean
|
ShouldSerializeFont()
Determines whether the ForeColor property should be serialized.
Declaration
public virtual bool ShouldSerializeFont()
Returns
|
System.Boolean
|
ShouldSerializeForeColor()
Determines whether the ForeColor property should be serialized.
Declaration
public bool ShouldSerializeForeColor()
Returns
|
System.Boolean
|
ShouldSerializeProperty(RadProperty)
Determines whether the specified RadProperty should be serialized.
Declaration
protected virtual bool ShouldSerializeProperty(RadProperty property)
Parameters
|
RadProperty
property
The RadProperty that is about to be serialized. |
Returns
|
System.Boolean
A value indicating whether to serialize the property value. |
ShouldSerializeProperty(RadProperty, RadObject)
Determines whether the specified RadProperty should be serialized. Prevents theme and default values serialization.
Declaration
protected virtual bool ShouldSerializeProperty(RadProperty property, RadObject element)
Parameters
|
RadProperty
property
The RadProperty that is about to be serialized. |
|
RadObject
element
The element that owns the property. |
Returns
|
System.Boolean
A value indicating whether to serialize the property value. |
SuspendUpdate()
UnregisterHostedControl(RadHostItem, Boolean)
Declaration
public virtual void UnregisterHostedControl(RadHostItem hostElement, bool removeControl)
Parameters
|
RadHostItem
hostElement
|
|
System.Boolean
removeControl
|
Implements
WndProc(ref Message)
Declaration
protected override void WndProc(ref Message m)
Parameters
|
System.Windows.Forms.Message
m
|
Events
ElementInvalidated
Declaration
public event EventHandler ElementInvalidated
Event Type
|
System.EventHandler
|
Initialized
Fires when the control is initialized.
Declaration
public event EventHandler Initialized
Event Type
|
System.EventHandler
|
PanGesture
Occurs when a pan gesture was sent by a touch input device.
Declaration
public event PanGestureEventHandler PanGesture
Event Type
|
PanGestureEventHandler
|
PressAndTapGesture
Occurs when a press-and-tap gesture was sent by a touch input device.
Declaration
public event PressAndTapGestureEventHandler PressAndTapGesture
Event Type
|
PressAndTapGestureEventHandler
|
PropertyChanged
Occurs when a property of an object changes change. Calling the event is developer's responsibility.
Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
|
System.ComponentModel.PropertyChangedEventHandler
|
RotateGesture
Occurs when a rotate gesture was sent by a touch input device.
Declaration
public event RotateGestureEventHandler RotateGesture
Event Type
|
RotateGestureEventHandler
|
ScreenTipNeeded
Occurs prior the ScreenTip of a RadItem instance inside the RadControl is displayed.
Declaration
public virtual event ScreenTipNeededEventHandler ScreenTipNeeded
Event Type
|
ScreenTipNeededEventHandler
|
ThemeNameChanged
Fires when the theme name is changed.
Declaration
public event ThemeNameChangedEventHandler ThemeNameChanged
Event Type
|
ThemeNameChangedEventHandler
|
Implements
ToolTipTextNeeded
Occurs when a RadItem instance inside the RadControl requires ToolTip text.
Declaration
public virtual event ToolTipTextNeededEventHandler ToolTipTextNeeded
Event Type
|
ToolTipTextNeededEventHandler
|
Implements
TwoFingerTapGesture
Occurs when a two-finger-tap gesture was sent by a touch input device.
Declaration
public event GestureEventHandler TwoFingerTapGesture
Event Type
|
GestureEventHandler
|
ZoomGesture
Occurs when a zoom gesture was sent by a touch input device.
Declaration
public event ZoomGestureEventHandler ZoomGesture
Event Type
|
ZoomGestureEventHandler
|
Explicit Interface Implementations
IPCHost.Context
IPCHost.ProcessMessage(ref IPCMessage)
Declaration
void IPCHost.ProcessMessage(ref IPCMessage request)
Parameters
|
IPCMessage
request
|
Implements
IComponentTreeHandler.Behavior
Declaration
ComponentInputBehavior IComponentTreeHandler.Behavior { get; }
Returns
|
ComponentInputBehavior
|
Implements
IComponentTreeHandler.CallOnMouseCaptureChanged(EventArgs)
Declaration
void IComponentTreeHandler.CallOnMouseCaptureChanged(EventArgs e)
Parameters
|
System.EventArgs
e
|
Implements
IComponentTreeHandler.CallOnScreenTipNeeded(Object, ScreenTipNeededEventArgs)
Declaration
void IComponentTreeHandler.CallOnScreenTipNeeded(object sender, ScreenTipNeededEventArgs e)
Parameters
|
System.Object
sender
|
|
ScreenTipNeededEventArgs
e
|
Implements
IComponentTreeHandler.CallOnThemeNameChanged(ThemeNameChangedEventArgs)
Declaration
void IComponentTreeHandler.CallOnThemeNameChanged(ThemeNameChangedEventArgs e)
Parameters
|
ThemeNameChangedEventArgs
e
|
Implements
IComponentTreeHandler.CallOnToolTipTextNeeded(Object, ToolTipTextNeededEventArgs)
Declaration
void IComponentTreeHandler.CallOnToolTipTextNeeded(object sender, ToolTipTextNeededEventArgs e)
Parameters
|
System.Object
sender
|
|
ToolTipTextNeededEventArgs
e
|
Implements
IComponentTreeHandler.ControlThemeChangedCallback()
Declaration
void IComponentTreeHandler.ControlThemeChangedCallback()
Implements
IComponentTreeHandler.CreateChildItems(RadElement)
Declaration
void IComponentTreeHandler.CreateChildItems(RadElement parent)
Parameters
|
RadElement
parent
|
Implements
IComponentTreeHandler.CreateRootElement()
Declaration
RootRadElement IComponentTreeHandler.CreateRootElement()
Returns
|
RootRadElement
|
Implements
IComponentTreeHandler.ElementTree
Declaration
ComponentThemableElementTree IComponentTreeHandler.ElementTree { get; }
Returns
|
ComponentThemableElementTree
|
Implements
IComponentTreeHandler.get_Name()
Declaration
string IComponentTreeHandler.get_Name()
Returns
|
System.String
|
Implements
IComponentTreeHandler.GetAmbientPropertyValue(RadProperty)
Declaration
object IComponentTreeHandler.GetAmbientPropertyValue(RadProperty property)
Parameters
|
RadProperty
property
|
Returns
|
System.Object
|
Implements
IComponentTreeHandler.GetShowFocusCues()
Declaration
bool IComponentTreeHandler.GetShowFocusCues()
Returns
|
System.Boolean
|
Implements
IComponentTreeHandler.InitializeRootElement(RootRadElement)
Declaration
void IComponentTreeHandler.InitializeRootElement(RootRadElement rootElement)
Parameters
|
RootRadElement
rootElement
|
Implements
IComponentTreeHandler.Initializing
Declaration
bool IComponentTreeHandler.Initializing { get; }
Returns
|
System.Boolean
|
Implements
IComponentTreeHandler.InvalidateElement(RadElement)
Declaration
void IComponentTreeHandler.InvalidateElement(RadElement element)
Parameters
|
RadElement
element
|
Implements
IComponentTreeHandler.InvalidateElement(RadElement, Rectangle)
Declaration
void IComponentTreeHandler.InvalidateElement(RadElement element, Rectangle bounds)
Parameters
|
RadElement
element
|
|
System.Drawing.Rectangle
bounds
|
Implements
IComponentTreeHandler.InvalidateIfNotSuspended()
Declaration
void IComponentTreeHandler.InvalidateIfNotSuspended()
Implements
IComponentTreeHandler.IsDesignMode
Declaration
bool IComponentTreeHandler.IsDesignMode { get; }
Returns
|
System.Boolean
|
Implements
IComponentTreeHandler.OnAmbientPropertyChanged(RadProperty)
Declaration
void IComponentTreeHandler.OnAmbientPropertyChanged(RadProperty property)
Parameters
|
RadProperty
property
|
Implements
IComponentTreeHandler.OnCaptureChangeRequested(RadElement, Boolean)
Declaration
bool IComponentTreeHandler.OnCaptureChangeRequested(RadElement element, bool capture)
Parameters
|
RadElement
element
|
|
System.Boolean
capture
|
Returns
|
System.Boolean
|
Implements
IComponentTreeHandler.OnDisplayPropertyChanged(RadPropertyChangedEventArgs)
Declaration
void IComponentTreeHandler.OnDisplayPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
|
RadPropertyChangedEventArgs
e
|
Implements
IComponentTreeHandler.OnFocusRequested(RadElement)
Declaration
bool IComponentTreeHandler.OnFocusRequested(RadElement element)
Parameters
|
RadElement
element
|
Returns
|
System.Boolean
|
Implements
IComponentTreeHandler.set_Name(String)
Declaration
void IComponentTreeHandler.set_Name(string value)
Parameters
|
System.String
value
|
Implements
IComponentTreeHandler.ThemeClassName
Declaration
string IComponentTreeHandler.ThemeClassName { get; set; }
Returns
|
System.String
|