Class

RadFormControlBase

Initializes a new instance of the RadFormControlBase class.

Declaration

public RadFormControlBase()

Declaration

public bool controlIsInitializingRootComponent

Field Value

The current DPI value.

Declaration

protected int currentDpi

Field Value

Declaration

protected bool isBehaviorPrepared

Field Value

Declaration

protected bool isPainting

Field Value

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

Declaration

protected Rectangle newBounds

Field Value

The old DPI value before a DPI change occurs.

Declaration

protected int oldDpi

Field Value

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

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

Declaration

[Browsable(false)]
public virtual bool AllowTheming { get; set; }

Property Value

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

Overrides Form.BackColor

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

Declaration

[Browsable(false)]
public virtual ComponentInputBehavior Behavior { get; }

Property Value

Gets the command bindings collection for input handling.

Declaration

[TypeConverter(typeof(ExpandableObjectConverter))]
public InputBindingsCollection CommandBindings { get; }

Property Value

Gets or sets the creation parameters for the window.

Declaration

protected override CreateParams CreateParams { get; }

Property Value

Overrides Form.CreateParams

Gets the element tree for this control.

Declaration

public ComponentThemableElementTree ElementTree { get; }

Property Value

Implements IComponentTreeHandler.ElementTree

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

Declaration

[Browsable(true)]
public virtual bool EnableAnalytics { get; set; }

Property Value

Implements IAnalyticsProvider.EnableAnalytics

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

[Browsable(true)]
public bool EnableKeyMap { get; set; }

Property Value

Gets or sets the currently focused element.

Declaration

[Browsable(false)]
public RadElement FocusedElement { get; set; }

Property Value

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

Overrides Control.Font

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

Overrides Control.ForeColor

Gets the behavior associated with this form if any.

Declaration

public FormControlBehavior FormBehavior { get; set; }

Property Value

Gets or sets the FormBorderStyle of the Form.

Declaration

public FormBorderStyle FormBorderStyle { get; set; }

Property Value

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

Declaration

protected virtual bool HasOwnToolbar { get; }

Property Value

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

Declaration

[Browsable(true)]
public ImageList ImageList { get; set; }

Property Value

Implements IComponentTreeHandler.ImageList

Gets or sets the scaling size for images.

Declaration

public Size ImageScalingSize { get; set; }

Property Value

Implements IComponentTreeHandler.ImageScalingSize

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

Declaration

public bool IsDesignMode { get; }

Property Value

Implements IComponentTreeHandler.IsDesignMode

Gets a value indicating whether DPI scaling is suspended.

Declaration

public bool IsDpiScalingSuspended { get; }

Property Value

Gets a value indicating whether the component is initialized.

Declaration

public bool IsInitialized { get; }

Property Value

Implements ISupportInitializeNotification.IsInitialized

Gets a value indicating whether the control is loaded.

Declaration

public bool IsLoaded { get; }

Property Value

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

Declaration

public bool IsPerformingScale { get; }

Property Value

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

Declaration

protected bool IsUpdateSuspended { get; }

Property Value

Gets or sets the maximum size of the control.

Declaration

public override Size MaximumSize { get; set; }

Property Value

Overrides Form.MaximumSize

Gets or sets the minimum size of the control.

Declaration

public override Size MinimumSize { get; set; }

Property Value

Overrides Form.MinimumSize

Gets the RootElement of the control.

Declaration

[Browsable(true)]
[TypeConverter(typeof(ExpandableObjectConverter))]
public RootRadElement RootElement { get; }

Property Value

Implements IComponentTreeHandler.RootElement

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

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

Declaration

public override ISite Site { get; set; }

Property Value

Overrides Control.Site

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

Declaration

[Browsable(true)]
public virtual ImageList SmallImageList { get; set; }

Property Value

Gets or sets the scaling size for small images.

Declaration

public Size SmallImageScalingSize { get; set; }

Property Value

Implements IComponentTreeHandler.SmallImageScalingSize

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

Declaration

public virtual string ThemeClassName { get; set; }

Property Value

Gets or sets the theme name.

Declaration

[Browsable(true)]
public string ThemeName { get; set; }

Property Value

Implements IComponentTreeHandler.ThemeName

Gets or sets the windows related settings.

Declaration

public WindowsSettings WindowsSettings { get; set; }

Property Value

Adds an invalidated rectangle to the control.

Declaration

protected void AddInvalidatedRect(Rectangle rect)

Parameters

Signals the object that initialization is starting.

Declaration

public virtual void BeginInit()

Implements ISupportInitialize.BeginInit()

Calls the base WndProc method.

Declaration

protected virtual void CallBaseWndProc(ref Message m)

Parameters

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

Declaration

protected virtual void Construct()

Called when the control theme has changed.

Declaration

public void ControlThemeChangedCallback()

Implements IComponentTreeHandler.ControlThemeChangedCallback()

Creates the child items for the specified parent element.

Declaration

protected virtual void CreateChildItems(RadElement parent)

Parameters

Creates the handle for the control.

Declaration

protected override void CreateHandle()

Overrides Form.CreateHandle()

Creates the root element for the form.

Declaration

protected virtual RootRadElement CreateRootElement()

Returns

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

Declaration

protected override void Dispose(bool disposing)

Parameters

Overrides Form.Dispose(bool)

Signals the object that initialization is complete.

Declaration

public virtual void EndInit()

Implements ISupportInitialize.EndInit()

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

Declaration

public override Size GetPreferredSize(Size proposedSize)

Parameters

Returns

Overrides Control.GetPreferredSize(Size)

Handles DPI change operations.

Declaration

protected virtual void HandleDpiChanged()

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

Declaration

protected abstract FormControlBehavior InitializeFormBehavior()

Returns

Invalidates the specified element.

Declaration

public void InvalidateElement(RadElement element)

Parameters

Implements IComponentTreeHandler.InvalidateElement(RadElement)

Invalidates the specified element within the given bounds.

Declaration

public void InvalidateElement(RadElement element, Rectangle bounds)

Parameters

Implements IComponentTreeHandler.InvalidateElement(RadElement, Rectangle)

Invalidates the control if not suspended.

Declaration

public void InvalidateIfNotSuspended()

Implements IComponentTreeHandler.InvalidateIfNotSuspended()

Invokes a layout callback.

Declaration

public void InvokeLayoutCallback(LayoutCallback callback)

Parameters

Implements ILayoutHandler.InvokeLayoutCallback(LayoutCallback)

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 IComponentTreeHandler.LoadElementTree()

Loads the element tree using the specified desired size.

Declaration

public virtual void LoadElementTree(Size desiredSize)

Parameters

Implements IComponentTreeHandler.LoadElementTree(Size)

Raises the AutoSizeChanged event.

Declaration

protected override void OnAutoSizeChanged(EventArgs e)

Parameters

Overrides Control.OnAutoSizeChanged(EventArgs)

Raises the BackColorChanged event.

Declaration

protected override void OnBackColorChanged(EventArgs e)

Parameters

Overrides Control.OnBackColorChanged(EventArgs)

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

Declaration

protected override void OnCreateControl()

Overrides Form.OnCreateControl()

Called when a display property has changed.

Declaration

protected virtual void OnDisplayPropertyChanged(RadPropertyChangedEventArgs e)

Parameters

Raises the FontChanged event.

Declaration

protected override void OnFontChanged(EventArgs e)

Parameters

Overrides Form.OnFontChanged(EventArgs)

Raises the ForeColorChanged event.

Declaration

protected override void OnForeColorChanged(EventArgs e)

Parameters

Overrides Control.OnForeColorChanged(EventArgs)

Raises the HandleCreated event.

Declaration

protected override void OnHandleCreated(EventArgs e)

Parameters

Overrides Form.OnHandleCreated(EventArgs)

Raises the Layout event.

Declaration

protected override void OnLayout(LayoutEventArgs levent)

Parameters

Overrides Form.OnLayout(LayoutEventArgs)

In this override we set the initial dpi scaling.

Declaration

protected override void OnLoad(EventArgs e)

Parameters

Overrides Form.OnLoad(EventArgs)

Notifies that the control is about to be visualized.

Declaration

protected virtual void OnLoad(Size desiredSize)

Parameters

Raises the property changed notification with the specified event arguments.

Declaration

protected virtual void OnNotifyPropertyChanged(PropertyChangedEventArgs e)

Parameters

Raises the property changed notification for the specified property name.

Declaration

protected virtual void OnNotifyPropertyChanged(string propertyName)

Parameters

Raises the Paint event and delegates to the form behavior if present.

Declaration

protected override void OnPaint(PaintEventArgs e)

Parameters

Overrides Form.OnPaint(PaintEventArgs)

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

Declaration

protected override void OnPaintBackground(PaintEventArgs e)

Parameters

Overrides ScrollableControl.OnPaintBackground(PaintEventArgs)

Raises the ParentChanged event.

Declaration

protected override void OnParentChanged(EventArgs e)

Parameters

Overrides ContainerControl.OnParentChanged(EventArgs)

Raises the ScreenTipNeeded event.

Declaration

protected virtual void OnScreenTipNeeded(object sender, ScreenTipNeededEventArgs e)

Parameters

Declaration

protected override void OnShown(EventArgs e)

Parameters

Overrides Form.OnShown(EventArgs)

Called when the theme has changed.

Declaration

protected virtual void OnThemeChanged()

Raises the ThemeNameChanged event.

Declaration

protected virtual void OnThemeNameChanged(ThemeNameChangedEventArgs e)

Parameters

Raises the ToolTipTextNeeded event.

Declaration

protected virtual void OnToolTipTextNeeded(object sender, ToolTipTextNeededEventArgs e)

Parameters

Raises the VisibleChanged event.

Declaration

protected override void OnVisibleChanged(EventArgs e)

Parameters

Overrides Form.OnVisibleChanged(EventArgs)

Handles the WM_SETTINGCHANGE message to detect Windows theme changes.

Declaration

protected virtual void OnWm_SettingChange(Message m)

Parameters

Performs design mode location correction for the form.

Declaration

protected virtual void PerformDesignModeLocationCorrection(ref Message msg)

Parameters

Processes a capture request from the specified element.

Declaration

protected virtual bool ProcessCaptureChangeRequested(RadElement element, bool capture)

Parameters

Returns

Processes a dialog box key.

Declaration

protected override bool ProcessDialogKey(Keys keyData)

Parameters

Returns

Overrides Form.ProcessDialogKey(Keys)

Processes a focus request from the specified element.

Declaration

protected virtual bool ProcessFocusRequested(RadElement element)

Parameters

Returns

Registers a hosted control with this form.

Declaration

public void RegisterHostedControl(RadHostItem hostElement)

Parameters

Implements IComponentTreeHandler.RegisterHostedControl(RadHostItem)

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

Declaration

public void ResetFormBehavior(bool callInitialize)

Parameters

Resumes DPI scaling operations.

Declaration

public void ResumeDpiScaling()

Resumes the painting of the control.

Declaration

public void ResumeUpdate()

Implements IComponentTreeHandler.ResumeUpdate()

Resumes the painting of the control.

Declaration

public void ResumeUpdate(bool invalidate)

Parameters

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

Declaration

protected override void ScaleControl(SizeF factor, BoundsSpecified specified)

Parameters

Overrides Form.ScaleControl(SizeF, 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

Overrides Form.SetBoundsCore(int, int, int, int, BoundsSpecified)

Sets the size of the client area of the form.

Declaration

protected override void SetClientSizeCore(int x, int y)

Parameters

Overrides Form.SetClientSizeCore(int, int)

Declaration

protected abstract void SetIconPrimitiveVisibility(bool visible)

Parameters

Determines whether the specified RadProperty should be serialized.

Declaration

protected virtual bool ShouldSerializeProperty(RadProperty property)

Parameters

Returns

Suspends DPI scaling operations.

Declaration

public void SuspendDpiScaling()

Suspends the painting of the control.

Declaration

public void SuspendUpdate()

Implements IComponentTreeHandler.SuspendUpdate()

Unregisters a hosted control from this form.

Declaration

public void UnregisterHostedControl(RadHostItem hostElement, bool removeControl)

Parameters

Implements IComponentTreeHandler.UnregisterHostedControl(RadHostItem, bool)

Updates which button is the default button.

Declaration

protected override void UpdateDefaultButton()

Overrides Form.UpdateDefaultButton()

Processes Windows messages.

Declaration

protected override void WndProc(ref Message m)

Parameters

Overrides Form.WndProc(ref Message)

Occurs when the component's initialization is complete.

Declaration

public event EventHandler Initialized

Event Value

Implements ISupportInitializeNotification.Initialized

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

Declaration

[Browsable(false)]
public event PropertyChangedEventHandler PropertyChanged

Event Value

Implements INotifyPropertyChanged.PropertyChanged

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

Declaration

public event ScreenTipNeededEventHandler ScreenTipNeeded

Event Value

Occurs when the theme name has changed.

Declaration

public event ThemeNameChangedEventHandler ThemeNameChanged

Event Value

Implements IComponentTreeHandler.ThemeNameChanged

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

Declaration

public event ToolTipTextNeededEventHandler ToolTipTextNeeded

Event Value

Implements IComponentTreeHandler.ToolTipTextNeeded

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

Declaration

public event WindowsThemeEventHandler WindowsThemeChanged

Event Value