Class RadFormControlBase

Represents a RadFormControl. RadFormControlBase is an abstract class and is base class for all telerik windows forms.

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()

Declaration
public RadFormControlBase()

Fields

controlIsInitializingRootComponent

Declaration
public bool controlIsInitializingRootComponent
Field Value
System.Boolean

currentDpi

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

Declaration
protected int oldDpi
Field Value
System.Int32

Properties

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

AllowTheming

Gets or sets a boolean value indicating whether the Form customizes its NC area when under Vista with Composition enabled.

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

AnalyticsName

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

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

CommandBindings

Declaration
public InputBindingsCollection CommandBindings { get; }
Property Value
InputBindingsCollection

CreateParams

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

ElementTree

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 whether Key Map (Office 2007 like accelerator keys map) is used for this speciffic control. Currently this option is implemented for the RadRibbonBar control only.

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

FocusedElement

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

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

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

Implements

IsDesignMode

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

Implements

IsDpiScalingSuspended

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

IsInitialized

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

IsLoaded

Gets a boolean value which determines whether the control is loaded.

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

IsPerformingScale

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

IsUpdateSuspended

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

LayoutManager

Declaration
public ILayoutManager LayoutManager { get; }
Property Value
ILayoutManager

Implements

MaximumSize

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

MinimumSize

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

RootElement

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

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

SmallImageScalingSize

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

Implements

ThemeClassName

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

ThemeName

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

Implements

WindowsSettings

Gets or sets the windows related setting.

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

Methods

AddInvalidatedRect(Rectangle)

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

BeginInit()

Declaration
public virtual void BeginInit()

CallBaseWndProc(ref Message)

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

Construct()

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 not set any theme to the element to avoid duplicatingthe style settings of the element.

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

Returns
System.Boolean

Implements

ControlThemeChangedCallback()

Declaration
public void ControlThemeChangedCallback()
Implements

CreateChildItems(RadElement)

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

CreateHandle()

Declaration
protected override void CreateHandle()

CreateRootElement()

Declaration
protected virtual RootRadElement CreateRootElement()
Returns
RootRadElement

Dispose(Boolean)

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

EndInit()

Declaration
public virtual void EndInit()

GetPreferredSize(Size)

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

Returns
System.Drawing.Size

GetUseNewLayout()

Determines whether the control and all its child elements should use the new layout system.

Declaration
protected virtual bool GetUseNewLayout()
Returns
System.Boolean

HandleDpiChanged()

Declaration
protected virtual void HandleDpiChanged()

InitializeFormBehavior()

Called to initialize the behavior of the form.

Declaration
protected abstract FormControlBehavior InitializeFormBehavior()
Returns
FormControlBehavior

InvalidateElement(RadElement)

Declaration
public void InvalidateElement(RadElement element)
Parameters
RadElement element

Implements

InvalidateElement(RadElement, Rectangle)

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

System.Drawing.Rectangle bounds

Implements

InvalidateIfNotSuspended()

Declaration
public void InvalidateIfNotSuspended()
Implements

InvokeLayoutCallback(LayoutCallback)

Declaration
public void InvokeLayoutCallback(LayoutCallback callback)
Parameters
LayoutCallback callback

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)

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

OnBackColorChanged(EventArgs)

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

OnCreateControl()

Declaration
protected override void OnCreateControl()

OnDisplayPropertyChanged(RadPropertyChangedEventArgs)

Declaration
protected virtual void OnDisplayPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs 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

OnHandleCreated(EventArgs)

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

OnLayout(LayoutEventArgs)

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

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)

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

OnNotifyPropertyChanged(String)

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

OnPaint(PaintEventArgs)

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

OnPaintBackground(PaintEventArgs)

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

OnParentChanged(EventArgs)

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

OnScreenTipNeeded(Object, ScreenTipNeededEventArgs)

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

ScreenTipNeededEventArgs e

OnShown(EventArgs)

Declaration
protected override void OnShown(EventArgs e)
Parameters
System.EventArgs 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

OnVisibleChanged(EventArgs)

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

OnWm_SettingChange(Message)

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

PerformDesignModeLocationCorrection(ref Message)

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

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.

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, false otherwise.

RegisterHostedControl(RadHostItem)

Declaration
public void RegisterHostedControl(RadHostItem hostElement)
Parameters
RadHostItem hostElement

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

Determines whether the InitializeFormBehavior method will be called after the p

ResumeDpiScaling()

Declaration
public void ResumeDpiScaling()

ResumeUpdate()

Declaration
public void ResumeUpdate()
Implements

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

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

SetClientSizeCore(Int32, Int32)

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

System.Int32 y

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

ShouldSerializeFont()

Determines whether the ForeColor property should be serialized.

Declaration
public 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

Returns
System.Boolean

SuspendDpiScaling()

Declaration
public void SuspendDpiScaling()

SuspendUpdate()

Declaration
public void SuspendUpdate()
Implements

UnregisterHostedControl(RadHostItem, Boolean)

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

System.Boolean removeControl

Implements

UpdateDefaultButton()

Updates which button is the default button.

Declaration
protected override void UpdateDefaultButton()

WndProc(ref Message)

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

Events

Initialized

Declaration
public event EventHandler Initialized
Event Type
System.EventHandler

PropertyChanged

Occurs when 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

ScreenTipNeeded

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

Declaration
public event ScreenTipNeededEventHandler ScreenTipNeeded
Event Type
ScreenTipNeededEventHandler

ThemeNameChanged

Declaration
public event ThemeNameChangedEventHandler ThemeNameChanged
Event Type
ThemeNameChangedEventHandler

Implements

ToolTipTextNeeded

Occurs when a RadItem instance iside 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

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.CreateChildItems(RadElement)

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

Implements

IComponentTreeHandler.CreateRootElement()

Declaration
RootRadElement IComponentTreeHandler.CreateRootElement()
Returns
RootRadElement

Implements

IComponentTreeHandler.get_Name()

Declaration
string IComponentTreeHandler.get_Name()
Returns
System.String

Implements
Telerik.WinControls.IComponentTreeHandler.get_Name()

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.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
Telerik.WinControls.IComponentTreeHandler.set_Name(System.String)

IComponentTreeHandler.SmallImageList

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

Implements

IComponentTreeHandler.ThemeClassName

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

Implements

Extension Methods