Class RadColorPicker

Represents a color picker control.

Inheritance
System.Object
RadColorPicker
FormattingColorPicker
HighlightColorPicker
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Input.dll

Syntax

[TelerikToolboxCategory("Input")]
[Themable]
public class RadColorPicker : Control, IThemable

Constructors

RadColorPicker()

Initializes a new instance of the RadColorPicker class.

Declaration
public RadColorPicker()
Remarks

Use this constructor to create and initialize a new instance of the RadColorPicker control.

Fields

AdditionalContentProperty

Identifies the AdditionalContent dependency property.

Declaration
public static readonly DependencyProperty AdditionalContentProperty
Field Value
System.Windows.DependencyProperty

AdditionalContentTemplateProperty

Identifies the AdditionalContentTemplate dependency property.

Declaration
public static readonly DependencyProperty AdditionalContentTemplateProperty
Field Value
System.Windows.DependencyProperty

AutomaticColorProperty

Identifies the AutomaticColor dependency property.

Declaration
public static readonly DependencyProperty AutomaticColorProperty
Field Value
System.Windows.DependencyProperty

ClickEvent

Identifies the Click property of the internal SplitButton.

Declaration
public static readonly RoutedEvent ClickEvent
Field Value
System.Windows.RoutedEvent

ColorPropertyPathProperty

Identifies the ColorPropertyPath dependency property.

Declaration
public static readonly DependencyProperty ColorPropertyPathProperty
Field Value
System.Windows.DependencyProperty

ColorSelectorStyleProperty

Identifies the ColorSelectorStyle dependency property.

Declaration
public static readonly DependencyProperty ColorSelectorStyleProperty
Field Value
System.Windows.DependencyProperty

CommandParameterProperty

Identifies the CommandParameter dependency property.

Declaration
public static readonly DependencyProperty CommandParameterProperty
Field Value
System.Windows.DependencyProperty

CommandProperty

Identifies the Command dependency property.

Declaration
public static readonly DependencyProperty CommandProperty
Field Value
System.Windows.DependencyProperty

CommandTargetProperty

Identifies the CommandTarget dependency property.

Declaration
public static readonly DependencyProperty CommandTargetProperty
Field Value
System.Windows.DependencyProperty

ContentProperty

Identifies the Content dependency property.

Declaration
public static readonly DependencyProperty ContentProperty
Field Value
System.Windows.DependencyProperty

ContentTemplateProperty

Identifies the ContentTemplate dependency property.

Declaration
public static readonly DependencyProperty ContentTemplateProperty
Field Value
System.Windows.DependencyProperty

DropDownClosedEvent

Identifies the moment DropDownClosed property of the internal SplitButton.

Declaration
public static readonly RoutedEvent DropDownClosedEvent
Field Value
System.Windows.RoutedEvent

DropDownOpenedEvent

Identifies the DropDownOpened property of the internal SplitButton.

Declaration
public static readonly RoutedEvent DropDownOpenedEvent
Field Value
System.Windows.RoutedEvent

DropDownOpeningEvent

Identifies the DropDownOpening property of the internal SplitButton.

Declaration
public static readonly RoutedEvent DropDownOpeningEvent
Field Value
System.Windows.RoutedEvent

DropDownPlacementProperty

Identifies the DropDownPlacement property.

Declaration
public static readonly DependencyProperty DropDownPlacementProperty
Field Value
System.Windows.DependencyProperty

HeaderPaletteItemsSourceProperty

Identifies the HeaderPaletteItemsSource dependency property.

Declaration
public static readonly DependencyProperty HeaderPaletteItemsSourceProperty
Field Value
System.Windows.DependencyProperty

HeaderPaletteProperty

Identifies the HeaderPalette dependency property.

Declaration
public static readonly DependencyProperty HeaderPaletteProperty
Field Value
System.Windows.DependencyProperty

HeaderPaletteVisibilityProperty

Identifies the HeaderPaletteVisibility dependency property.

Declaration
public static readonly DependencyProperty HeaderPaletteVisibilityProperty
Field Value
System.Windows.DependencyProperty

IsDropDownOpenProperty

Identifies the IsDropDownOpen property.

Declaration
public static readonly DependencyProperty IsDropDownOpenProperty
Field Value
System.Windows.DependencyProperty

IsRecentColorsActiveProperty

Registers the IsRecentColorsActive dependency property.

Declaration
public static readonly DependencyProperty IsRecentColorsActiveProperty
Field Value
System.Windows.DependencyProperty

MainPaletteColumnsCountProperty

Identifies the PaletteColumnsCount dependency property.

Declaration
public static readonly DependencyProperty MainPaletteColumnsCountProperty
Field Value
System.Windows.DependencyProperty

MainPaletteHeaderTextProperty

Identifies the MainPalette dependency property.

Declaration
public static readonly DependencyProperty MainPaletteHeaderTextProperty
Field Value
System.Windows.DependencyProperty

MainPaletteItemsSourceProperty

Identifies the MainPaletteItemsSource dependency property.

Declaration
public static readonly DependencyProperty MainPaletteItemsSourceProperty
Field Value
System.Windows.DependencyProperty

MainPaletteItemsStyleProperty

Identifies the StandardPaletteItemsSource dependency property.

Declaration
public static readonly DependencyProperty MainPaletteItemsStyleProperty
Field Value
System.Windows.DependencyProperty

MainPaletteOrientationProperty

Identifies the PaletteOrientation dependency property.

Declaration
public static readonly DependencyProperty MainPaletteOrientationProperty
Field Value
System.Windows.DependencyProperty

MainPalettePanelProperty

Identifies the PalettePanelProperty property.

Declaration
public static readonly DependencyProperty MainPalettePanelProperty
Field Value
System.Windows.DependencyProperty

MainPaletteProperty

Identifies the MainPalette dependency property.

Declaration
public static readonly DependencyProperty MainPaletteProperty
Field Value
System.Windows.DependencyProperty

NoColorTextProperty

Identifies the NoColor dependency property.

Declaration
public static readonly DependencyProperty NoColorTextProperty
Field Value
System.Windows.DependencyProperty

NoColorVisibilityProperty

Identifies the NoColorVisibility dependency property.

Declaration
public static readonly DependencyProperty NoColorVisibilityProperty
Field Value
System.Windows.DependencyProperty

PaletteItemsTemplateProperty

Identifies the PaletteItemsTemplate property.

Declaration
public static readonly DependencyProperty PaletteItemsTemplateProperty
Field Value
System.Windows.DependencyProperty

RecentColorsHeaderTextProperty

Registers the RecentColorsHeaderText dependency property.

Declaration
public static readonly DependencyProperty RecentColorsHeaderTextProperty
Field Value
System.Windows.DependencyProperty

RecentColorsItemsSourceProperty

Registers the RecentColorsItemsSource dependency property.

Declaration
public static readonly DependencyProperty RecentColorsItemsSourceProperty
Field Value
System.Windows.DependencyProperty

RecentColorsVisibilityProperty

Registers the RecentColorsHeaderText dependency property.

Declaration
[Obsolete("This property is obsolete. Use the IsRecentColorsActive property.")]
public static readonly DependencyProperty RecentColorsVisibilityProperty
Field Value
System.Windows.DependencyProperty

SelectedColorProperty

Identifies the SelectedColor dependency property.

Declaration
public static readonly DependencyProperty SelectedColorProperty
Field Value
System.Windows.DependencyProperty

SelectedItemProperty

Identifies the SelectedItem dependency property.

Declaration
public static readonly DependencyProperty SelectedItemProperty
Field Value
System.Windows.DependencyProperty

SplitButtonStyleProperty

Style for the SplitButton.

Declaration
public static readonly DependencyProperty SplitButtonStyleProperty
Field Value
System.Windows.DependencyProperty

StandardPaletteHeaderTextProperty

Identifies the StandardPalette dependency property.

Declaration
public static readonly DependencyProperty StandardPaletteHeaderTextProperty
Field Value
System.Windows.DependencyProperty

StandardPaletteItemsSourceProperty

Identifies the StandardPaletteItemsSource dependency property.

Declaration
public static readonly DependencyProperty StandardPaletteItemsSourceProperty
Field Value
System.Windows.DependencyProperty

StandardPaletteProperty

Identifies the StandardPalette dependency property.

Declaration
public static readonly DependencyProperty StandardPaletteProperty
Field Value
System.Windows.DependencyProperty

StandardPaletteVisibilityProperty

Identifies the StandardPaletteVisibility dependency property.

Declaration
public static readonly DependencyProperty StandardPaletteVisibilityProperty
Field Value
System.Windows.DependencyProperty

Properties

AdditionalContent

Gets or sets the additional content placed under the RadColorSelector.

Declaration
public object AdditionalContent { get; set; }
Property Value
System.Object

AdditionalContentTemplate

Gets or sets the additional content template.

Declaration
public DataTemplate AdditionalContentTemplate { get; set; }
Property Value
System.Windows.DataTemplate

AutomaticColor

Gets or sets the automatic color.

Declaration
public Color AutomaticColor { get; set; }
Property Value
System.Windows.Media.Color

The automatic color.

ColorPropertyPath

Gets or sets the ColorPropertyPath property.

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

ColorSelectorStyle

Gets or sets the color selector style.

Declaration
public Style ColorSelectorStyle { get; set; }
Property Value
System.Windows.Style

Command

Gets or sets the command that will be executed when the command source is invoked.

Declaration
public ICommand Command { get; set; }
Property Value
System.Windows.Input.ICommand

CommandParameter

Represents a user defined data value that can be passed to the command when it is executed.

Declaration
public object CommandParameter { get; set; }
Property Value
System.Object

CommandTarget

The object that the command is being executed on.

Declaration
public UIElement CommandTarget { get; set; }
Property Value
System.Windows.UIElement

Content

Gets or sets the content.

Declaration
public object Content { get; set; }
Property Value
System.Object

ContentTemplate

Gets or sets the content template.

Declaration
public DataTemplate ContentTemplate { get; set; }
Property Value
System.Windows.DataTemplate

DropDownPlacement

Gets or sets the drop down position.

Declaration
public PlacementMode DropDownPlacement { get; set; }
Property Value
PlacementMode

The drop down position.

HeaderPalette

Gets or sets the header palette. This is a dependency property.

Declaration
public ColorPreset HeaderPalette { get; set; }
Property Value
ColorPreset

The header palette.that is represent by ColorPreset object.
Remarks

Use this property only if HeaderPaletteVisibility is set to true.

HeaderPaletteItemsSource

Gets or sets the header palette items source. This is a dependency property.

Declaration
public IEnumerable HeaderPaletteItemsSource { get; set; }
Property Value
System.Collections.IEnumerable

The header palette items source.
Remarks

Use this property only if HeaderPaletteVisibility is set to true.

HeaderPaletteVisibility

Gets or sets a value indicating whether the HeaderPalette is visible or not. This is a dependency property.

Declaration
public Visibility HeaderPaletteVisibility { get; set; }
Property Value
System.Windows.Visibility

True if [header palette visibility]; otherwise, false.

IsDropDownOpen

Gets or sets whether the Selector DropDown is open. This is a dependency property.

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

True if this instance is drop down open; otherwise, false.

IsRecentColorsActive

Gets or sets the IsRecentColorsActive property.

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

MainPalette

Gets or sets the main palette source of a RadColorPicker. This is a dependency property.

Declaration
public ColorPreset MainPalette { get; set; }
Property Value
ColorPreset

The main palette that is represent by ColorPreset object.

MainPaletteColumnsCount

Gets or sets the palette columns count.

Declaration
public int MainPaletteColumnsCount { get; set; }
Property Value
System.Int32

The palette columns count.

MainPaletteHeaderText

Gets or sets the main palette header text. This is a dependency property.

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

The main palette header text.

MainPaletteItemsSource

Gets or sets the main palette items source. This is a dependency property.

Declaration
public IEnumerable MainPaletteItemsSource { get; set; }
Property Value
System.Collections.IEnumerable

The main palette items source.

MainPaletteItemsStyle

Gets or sets the main palette orientation.

Declaration
public Style MainPaletteItemsStyle { get; set; }
Property Value
System.Windows.Style

The main palette orientation.

MainPaletteOrientation

Gets or sets the palette orientation.

Declaration
public Orientation MainPaletteOrientation { get; set; }
Property Value
System.Windows.Controls.Orientation

The palette orientation.

MainPalettePanel

Gets or sets the main palette panel.

Declaration
public ItemsPanelTemplate MainPalettePanel { get; set; }
Property Value
System.Windows.Controls.ItemsPanelTemplate

The main palette panel.

NoColorText

Gets or sets the no color text. This is a dependency property.

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

The no color text.
Remarks

Use this property only if ShowEmptyColor is set to true.

NoColorVisibility

Gets or sets a value indicating whether or not the empty color to be visible. This is a dependency property.

Declaration
public Visibility NoColorVisibility { get; set; }
Property Value
System.Windows.Visibility

True if [show empty color]; otherwise, false.

PaletteItemsTemplate

Gets or sets the PaletteItemsTemplate.

Declaration
public DataTemplate PaletteItemsTemplate { get; set; }
Property Value
System.Windows.DataTemplate

RecentColorsHeaderText

Gets or sets the recent colors header text.

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

RecentColorsItemsSource

Gets or sets the recent colors items source.

Declaration
public IEnumerable RecentColorsItemsSource { get; set; }
Property Value
System.Collections.IEnumerable

The recent colors items source.

RecentColorsVisibility

Gets or sets the recent colors visibility.

Declaration
[Obsolete("This property is obsolete. Use the IsRecentColorsActive property.")]
public Visibility RecentColorsVisibility { get; set; }
Property Value
System.Windows.Visibility

SelectedColor

Gets or sets the selected color.

Declaration
public Color SelectedColor { get; set; }
Property Value
System.Windows.Media.Color

The selected color.

SelectedItem

Gets or sets the SelectedItem.

Declaration
public object SelectedItem { get; set; }
Property Value
System.Object

SplitButtonStyle

Gets or sets the split button style.

Declaration
public Style SplitButtonStyle { get; set; }
Property Value
System.Windows.Style

StandardPalette

Gets or sets the standard palette. This is a dependency property.

Declaration
public ColorPreset StandardPalette { get; set; }
Property Value
ColorPreset

The standard palette.that is represent by ColorPreset object.
Remarks

Use this property only if StandardPaletteVisibility is set to true.

StandardPaletteHeaderText

Gets or sets the standard palette header text. This is a dependency property.

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

The standard palette header text.
Remarks

You can use this property only if the StandardPaletteVisibility is set to true.

StandardPaletteItemsSource

Gets or sets the standard palette items source. This is a dependency property.

Declaration
public IEnumerable StandardPaletteItemsSource { get; set; }
Property Value
System.Collections.IEnumerable

The standard palette items source.
Remarks

Use this property only if StandardPaletteVisibility is set to true.

StandardPaletteVisibility

Gets or sets a value indicating whether the StandardPalette is visible or not.. This is a dependency property.

Declaration
public Visibility StandardPaletteVisibility { get; set; }
Property Value
System.Windows.Visibility

True if [standard palette visibility]; otherwise, false.

Methods

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call System.Windows.Controls.Control.ApplyTemplate.

Declaration
public override void OnApplyTemplate()

OnCreateAutomationPeer()

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

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

The System.Windows.RoutedEventArgs that contains the event data.

OnMouseWheel(MouseWheelEventArgs)

Declaration
protected override void OnMouseWheel(MouseWheelEventArgs e)
Parameters
System.Windows.Input.MouseWheelEventArgs e

OnSelectedColorChanged()

Called when color selection happens..

Declaration
protected virtual void OnSelectedColorChanged()

ResetTheme()

Resets the theme.

Declaration
public void ResetTheme()

Events

Click

Occurs when the action button of the split button is clicked.

Declaration
public event RoutedEventHandler Click
Event Type
System.Windows.RoutedEventHandler

DropDownClosed

Occurs when the SplitButton closed.

Declaration
public event RadRoutedEventHandler DropDownClosed
Event Type
RadRoutedEventHandler

DropDownOpened

Occurs when the SplitButton opened.

Declaration
public event RadRoutedEventHandler DropDownOpened
Event Type
RadRoutedEventHandler

DropDownOpening

Occurs when the SplitButton will be opened. Set True for the Handled property and the SplitButton won't open.

Declaration
public event RadRoutedEventHandler DropDownOpening
Event Type
RadRoutedEventHandler

SelectedColorChanged

Occurs when selected color changed.

Declaration
public event EventHandler SelectedColorChanged
Event Type
System.EventHandler

Extension Methods