New to Telerik UI for WinForms? Start a free 30-day trial

RadColorBox

Class

Represents a color editor box. The RadColorBox class is a simple wrapper for the RadColorBoxElement class. The RadColorBox acts to transfer events to and from its corresponding RadColorBoxElement. The RadColorBoxElement which is essentially the RadColorBox control may be nested in other telerik controls.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

[TelerikToolboxCategory("Editors")]
[DefaultBindingProperty("Value")]
public class RadColorBox : RadEditorControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider

Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadEditorControlRadColorBox...

Implements: IAnalyticsProviderIBindableComponentIComponentIComponentTreeHandlerIDisposableIDropTargetILayoutHandlerINotifyPropertyChangedISupportInitializeISupportInitializeNotificationISynchronizeInvokeIWin32Window...

Constructors

RadColorBox()

Initializes a new instance of the RadColorBox class.

public RadColorBox()

Properties

AutoSize

bool

Gets or sets whether the edit control is auto-sized.

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

Overrides: RadControl.AutoSize

ColorBoxElement

RadColorBoxElement

Gets the RadColorBoxElement of this control.

[Browsable(false)]
public RadColorBoxElement ColorBoxElement { get; }

ColorDialog

RadColorDialog

Gets the RadColorDialog of this control.

[Browsable(false)]
public RadColorDialog ColorDialog { get; }

DefaultSize

Size

Gets the default size for the RadColorBox control.

protected override Size DefaultSize { get; }

Property Value:

A Size structure representing the default dimensions of the control.

Overrides: Control.DefaultSize

ReadOnly

bool

Gets or sets a value indicating whether users can input text directly into the text field.

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

Value

Color

Gets or sets the color value of the editor.

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

Methods

CreateChildItems(RadElement)

Creates the child elements for the RadColorBox control.

protected override void CreateChildItems(RadElement parent)

Parameters:parentRadElement

The parent element to which child elements will be added.

Overrides: RadControl.CreateChildItems(RadElement)

CreateColorBoxElement()

Creates the RadColorBoxElement that will be used by this control.

protected virtual RadColorBoxElement CreateColorBoxElement()

Returns:

RadColorBoxElement

A new instance of RadColorBoxElement.

Dispose(bool)

Releases the unmanaged resources used by the RadColorBox and optionally releases the managed resources.

protected override void Dispose(bool disposing)

Parameters:disposingbool

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

Overrides: RadControl.Dispose(bool)

IsInputKey(Keys)

Determines whether the specified key is an input key that should be processed by the control.

protected override bool IsInputKey(Keys keyData)

Parameters:keyDataKeys

One of the Keys values that specifies the key to test.

Returns:

bool

true if the specified key is an input key; otherwise, false.

Overrides: RadControl.IsInputKey(Keys)

ProcessAutoSizeChanged(bool)

Processes changes to the AutoSize property and adjusts the element stretching behavior accordingly.

protected override void ProcessAutoSizeChanged(bool value)

Parameters:valuebool

true if AutoSize is enabled; otherwise, false.

Overrides: RadControl.ProcessAutoSizeChanged(bool)

ProcessDialogKey(Keys)

Processes a dialog key such as Enter or Escape.

protected override bool ProcessDialogKey(Keys keyData)

Parameters:keyDataKeys

One of the Keys values that represents the key to process.

Returns:

bool

true if the key was processed by the control; otherwise, false.

Overrides: Control.ProcessDialogKey(Keys)

ResetBackColorThemeOverrides()

Resets the BackColor theme overrides for the ColorBoxElement and applies the default theme values.

protected override void ResetBackColorThemeOverrides()

Overrides: RadControl.ResetBackColorThemeOverrides()

ResetForeColorThemeOverrides()

Resets the ForeColor theme overrides for the ColorBoxElement and applies the default theme values.

protected override void ResetForeColorThemeOverrides()

Overrides: RadControl.ResetForeColorThemeOverrides()

SetBackColorThemeOverrides()

Sets the BackColor theme overrides for all relevant visual states of the ColorBoxElement.

protected override void SetBackColorThemeOverrides()

Overrides: RadControl.SetBackColorThemeOverrides()

SetForeColorThemeOverrides()

Sets the ForeColor theme overrides for all relevant visual states of the ColorBoxElement.

protected override void SetForeColorThemeOverrides()

Overrides: RadControl.SetForeColorThemeOverrides()

UnwireEvents()

Unwires the events between the RadColorBox control and its underlying RadColorBoxElement.

protected virtual void UnwireEvents()

WireEvents()

Wires the events between the RadColorBox control and its underlying RadColorBoxElement.

protected virtual void WireEvents()

Events

DialogClosed

DialogClosedEventHandler

Occurs after the color dialog is closed.

public event DialogClosedEventHandler DialogClosed

ValueChanged

EventHandler

Occurs after the editor value is changed.

public event EventHandler ValueChanged

ValueChanging

ValueChangingEventHandler

Occurs right before the value is changed. This is a cancelable event.

public event ValueChangingEventHandler ValueChanging