Class

RadColorBoxElement

Initializes a new instance of the RadColorBoxElement class.

Declaration

public RadColorBoxElement()

Gets the ColorEditorColorBox that displays the currently selected color in the editor.

Declaration

public ColorEditorColorBox ColorBox { get; }

Property Value

Gets or sets the RadColorDialog that is displayed when the color picker button is clicked.

Declaration

public RadColorDialog ColorDialog { get; set; }

Property Value

Gets the ColorPickerButtonElement that opens the RadColorDialog when clicked.

Declaration

public ColorPickerButtonElement ColorPickerButton { get; }

Property Value

Gets or sets a value indicating whether the user is allowed to type directly in the text field. When true, only color selection through the dialog is permitted.

Declaration

public bool ReadOnly { get; set; }

Property Value

Gets or sets the color value of the editor. When setting a value, the change can be canceled through the ValueChanging event.

Declaration

public virtual Color Value { get; set; }

Property Value

Creates the child elements that compose the color box including the stack layout, color display box, color dialog, and color picker button.

Declaration

protected override void CreateChildElements()

Overrides RadTextBoxElement.CreateChildElements()

Creates the color display box element that shows the currently selected color.

Declaration

protected virtual ColorEditorColorBox CreateColorBoxElement()

Returns

Creates the color dialog that will be displayed when the color picker button is clicked.

Declaration

protected virtual RadColorDialog CreateColorDialog()

Returns

Creates the color picker button element that opens the color dialog when clicked.

Declaration

protected virtual ColorPickerButtonElement CreateColorPickerButtonElement()

Returns

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

Declaration

protected override void DisposeManagedResources()

Overrides RadTextBoxElement.DisposeManagedResources()

Gets the current color value by parsing the text input. If parsing fails, returns the last successfully parsed value.

Declaration

public virtual Color GetColorValue()

Returns

Initializes the default field values and behavior settings for the color box element.

Declaration

protected override void InitializeFields()

Overrides RadTextBoxElement.InitializeFields()

Handles the color picker button click event by opening the color dialog and processing the selected color.

Declaration

protected virtual void OnDialogButtonClick(EventArgs e)

Parameters

Raises the DialogClosed event after the color dialog is closed.

Declaration

protected virtual void OnDialogClosed(DialogClosedEventArgs e)

Parameters

Handles key down events with special processing for Enter and Escape keys to commit or revert color changes.

Declaration

protected override void OnKeyDown(KeyEventArgs e)

Parameters

Overrides RadItem.OnKeyDown(KeyEventArgs)

Handles property changed events and forwards them to the base class. Additionally handles right-to-left property changes by updating the shape orientations.

Declaration

protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)

Parameters

Overrides RadItem.OnPropertyChanged(RadPropertyChangedEventArgs)

Handles property changing events and forwards them to the base class only when not in the middle of a value changing operation and the property is not the Text property.

Declaration

protected override void OnPropertyChanging(RadPropertyChangingEventArgs args)

Parameters

Overrides RadItem.OnPropertyChanging(RadPropertyChangingEventArgs)

Handles the text changed event and forwards it to the base class only when not in the middle of a value changing operation.

Declaration

protected override void OnTextChanged(EventArgs e)

Parameters

Overrides RadItem.OnTextChanged(EventArgs)

Handles the text changing event and cancels it if the control is in read-only mode.

Declaration

protected override void OnTextChanging(TextChangingEventArgs e)

Parameters

Overrides RadItem.OnTextChanging(TextChangingEventArgs)

Raises the ValueChanged event after the editor color value has been successfully changed.

Declaration

protected virtual void OnValueChanged(EventArgs e)

Parameters

Raises the ValueChanging event before the editor color value is changed, allowing the change to be canceled.

Declaration

protected virtual void OnValueChanging(ValueChangingEventArgs e)

Parameters

Sets the color value of the editor with validation and change notification. If the control is read-only, the operation is ignored.

Declaration

public virtual void SetColorValue(Color newValue)

Parameters

Unwires the event handlers for the color picker button and other child elements.

Declaration

protected virtual void UnwireEvents()

Validates the current text input by attempting to convert it to a valid color value.

Declaration

public virtual bool Validate()

Returns

Wires the necessary event handlers for the color picker button and other child elements.

Declaration

protected virtual void WireEvents()

Occurs when the color dialog window is closed, regardless of whether a color was selected.

Declaration

public event DialogClosedEventHandler DialogClosed

Event Value

Occurs after the editor has successfully changed the color value during the editing process.

Declaration

public event EventHandler ValueChanged

Event Value

Occurs when the color value is being changed and allows the change to be canceled.

Declaration

public event ValueChangingEventHandler ValueChanging

Event Value