Back to all docs
API Reference / Kendo.Mvc.UI.Fluent / ColorPickerBuilder
New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

ColorPickerBuilder

Class

Defines the fluent interface for configuring the DatePickerBase component.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:
C#
public class ColorPickerBuilder : WidgetBuilderBase<ColorPicker, ColorPickerBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<ColorPicker, ColorPickerBuilder>ColorPickerBuilder

Implements: IHtmlString

Inherited Members WidgetBuilderBase<ColorPicker, ColorPickerBuilder>.ToComponent()WidgetBuilderBase<ColorPicker, ColorPickerBuilder>.Name(string)WidgetBuilderBase<ColorPicker, ColorPickerBuilder>.Deferred(bool)WidgetBuilderBase<ColorPicker, ColorPickerBuilder>.ModelMetadata(ModelMetadata)WidgetBuilderBase<ColorPicker, ColorPickerBuilder>.HtmlAttributes(object)WidgetBuilderBase<ColorPicker, ColorPickerBuilder>.HtmlAttributes(IDictionary<string, object>)WidgetBuilderBase<ColorPicker, ColorPickerBuilder>.AsModule(bool)WidgetBuilderBase<ColorPicker, ColorPickerBuilder>.Render()WidgetBuilderBase<ColorPicker, ColorPickerBuilder>.ScriptAttributes(object, bool)WidgetBuilderBase<ColorPicker, ColorPickerBuilder>.ScriptAttributes(IDictionary<string, object>, bool)WidgetBuilderBase<ColorPicker, ColorPickerBuilder>.ToHtmlString()WidgetBuilderBase<ColorPicker, ColorPickerBuilder>.ToClientTemplate()WidgetBuilderBase<ColorPicker, ColorPickerBuilder>.ToString()WidgetBuilderBase<ColorPicker, ColorPickerBuilder>.Componentobject.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

ColorPickerBuilder(ColorPicker)

Initializes a new instance of the ColorPickerBuilder class.

C#
public ColorPickerBuilder(ColorPicker component)
Parameters:componentColorPicker

The component.

Methods

AdaptiveMode(AdaptiveMode)

Specifies the adaptive rendering of the component. The supported values are: none (default), auto.

C#
public ColorPickerBuilder AdaptiveMode(AdaptiveMode value)
Parameters:valueAdaptiveMode

The value that configures the adaptivemode.

Returns:

ColorPickerBuilder

AdaptiveSubtitle(string)

Allows customization of the subtitle's text in the adaptive view of the component.

C#
public ColorPickerBuilder AdaptiveSubtitle(string value)
Parameters:valuestring

The value that configures the adaptivesubtitle.

Returns:

ColorPickerBuilder

AdaptiveTitle(string)

Allows customization of the title's text in the adaptive view of the component.

C#
public ColorPickerBuilder AdaptiveTitle(string value)
Parameters:valuestring

The value that configures the adaptivetitle.

Returns:

ColorPickerBuilder

Buttons(bool)

Specifies whether the widget should display the Apply / Cancel buttons.

C#
public ColorPickerBuilder Buttons(bool value)
Parameters:valuebool

The value that configures the buttons.

Returns:

ColorPickerBuilder

Example:
C#
@(Html.Kendo().ColorPicker()
.Name("palette")
.Views(new string[] { "palette"})
.Buttons(false)
)

ButtonsTemplate(string)

Specifies the template which is used for rendering the action buttons.

C#
public ColorPickerBuilder ButtonsTemplate(string value)
Parameters:valuestring

The value that configures the buttonstemplate.

Returns:

ColorPickerBuilder

ButtonsTemplate<TModel>(TemplateBuilder<TModel>)

Specifies the template which is used for rendering the action buttons.

C#
public ColorPickerBuilder ButtonsTemplate<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the buttonstemplate.

Returns:

ColorPickerBuilder

ButtonsTemplateHandler(string)

Specifies the template which is used for rendering the action buttons.

C#
public ColorPickerBuilder ButtonsTemplateHandler(string value)
Parameters:valuestring

The value that configures the buttonstemplate.

Returns:

ColorPickerBuilder

ButtonsTemplateId(string)

Specifies the template which is used for rendering the action buttons.

C#
public ColorPickerBuilder ButtonsTemplateId(string value)
Parameters:valuestring

The value that configures the buttonstemplate.

Returns:

ColorPickerBuilder

ButtonsTemplateView(MvcHtmlString)

Specifies the template which is used for rendering the action buttons.

C#
public ColorPickerBuilder ButtonsTemplateView(MvcHtmlString value)
Parameters:valueMvcHtmlString

The value that configures the buttonstemplate.

Returns:

ColorPickerBuilder

ClearButton(bool)

Specifies whether the widget should display the 'Clear color' button.

C#
public ColorPickerBuilder ClearButton(bool value)
Parameters:valuebool

The value that configures the clearbutton.

Returns:

ColorPickerBuilder

Example:
C#
@(Html.Kendo().ColorPicker()
.Name("palette")
.Views(new string[] { "palette"})
.ClearButton(true)
)

CloseOnSelect(bool)

Specifies whether selection of a color in the palette view closes the popup. Applied only when buttons are set to false and the currently selected view is palette.

C#
public ColorPickerBuilder CloseOnSelect(bool value)
Parameters:valuebool

The value that configures the closeonselect.

Returns:

ColorPickerBuilder

Example:
C#
@(Html.Kendo().ColorPicker()
.Name("palette")
.Views(new string[] { "palette"})
.CloseOnSelect(true)
)

Columns(double)

The number of columns to show in the color dropdown when a pallete is specified. This is automatically initialized for the "basic" and "websafe" palettes. If you use a custom palette then you can set this to some value that makes sense for your colors.

C#
public ColorPickerBuilder Columns(double value)
Parameters:valuedouble

The value that configures the columns.

Returns:

ColorPickerBuilder

Example:
C#
@(Html.Kendo().ColorPicker()
.Name("palette")
.Views(new string[] { "palette"})
.Columns(3)
)

ContrastTool()

Enables the contrast tool in the ColorGradient.

C#
public ColorPickerBuilder ContrastTool()
Returns:

ColorPickerBuilder

ContrastTool(Action<ColorPickerContrastToolSettingsBuilder>)

Enables the contrast tool in the ColorGradient.

C#
public ColorPickerBuilder ContrastTool(Action<ColorPickerContrastToolSettingsBuilder> configurator)
Parameters:configuratorAction<ColorPickerContrastToolSettingsBuilder>

The action that configures the contrasttool.

Returns:

ColorPickerBuilder

Example:
C#
@(Html.Kendo().ColorPicker()
.Name("palette")
.Views(new string[] { "palette"})
.ContrastTool(tool=&gt;tool
.BackgroundColor("#ffffff")
)
)

ContrastTool(bool)

Enables the contrast tool in the ColorGradient.

C#
public ColorPickerBuilder ContrastTool(bool enabled)
Parameters:enabledbool

Enables or disables the contrasttool option.

Returns:

ColorPickerBuilder

Example:
C#
@(Html.Kendo().ColorPicker()
.Name("palette")
.Views(new string[] { "palette"})
.ContrastTool(false)
)

Enable(bool)

Enables or disables the picker.

C#
public ColorPickerBuilder Enable(bool value)
Parameters:valuebool

Whether the picker is enabled

Returns:

ColorPickerBuilder

Example:
C#
@( Html.Kendo().ColorPicker()
.Name("ColorPicker")
.Enable(false)
)

Events(Action<ColorPickerEventBuilder>)

Configures the client-side events.

C#
public ColorPickerBuilder Events(Action<ColorPickerEventBuilder> clientEventsAction)
Parameters:clientEventsActionAction<ColorPickerEventBuilder>

The client events action.

Returns:

ColorPickerBuilder

Example:
C#
@( Html.Kendo().ColorPicker()
.Name("ColorPicker")
.Events(events =&gt;
events.Select("select").Change("change")
)
)

FillMode(FillMode)

Sets a value controlling how the color is applied.

C#
public ColorPickerBuilder FillMode(FillMode value)
Parameters:valueFillMode

The value that configures the fillmode.

Returns:

ColorPickerBuilder

Example:
C#
@(Html.Kendo().ColorPicker()
.Name("palette")
.Views(new string[] { "palette"})
.FillMode(FillMode.Solid)
)

Format(ColorPickerFormat)

Defines the format of the gradient input editor

C#
public ColorPickerBuilder Format(ColorPickerFormat value)
Parameters:valueColorPickerFormat

The value that configures the format.

Returns:

ColorPickerBuilder

Example:
C#
@(Html.Kendo().ColorPicker()
.Name("palette")
.Views(new string[] { "palette"})
.Format(ColorPickerFormat.Hex)
)

Formats(params string[])

Sets the available input formats in the gradient input editor.

C#
public ColorPickerBuilder Formats(params string[] formats)
Parameters:formatsstring[]

Only "hex" and "rgb" are valid values.

Returns:

ColorPickerBuilder

Example:
C#
@( Html.Kendo().ColorPicker()
.Name("ColorPicker")
.Formats(new string[]{ "rgb", "hex" })
)

Input(bool)

Whether to render the input in the ColorGradient component.

C#
public ColorPickerBuilder Input(bool value)
Parameters:valuebool

The value that configures the input.

Returns:

ColorPickerBuilder

Example:
C#
@(Html.Kendo().ColorPicker()
.Name("palette")
.Views(new string[] { "palette"})
.Input(true)
)

Messages(Action<ColorPickerMessagesSettingsBuilder>)

Allows localization of the strings that are used in the widget.

C#
public ColorPickerBuilder Messages(Action<ColorPickerMessagesSettingsBuilder> configurator)
Parameters:configuratorAction<ColorPickerMessagesSettingsBuilder>

The action that configures the messages.

Returns:

ColorPickerBuilder

Example:
C#
@(Html.Kendo().ColorPicker()
.Name("palette")
.Views(new string[] { "palette"})
.Messages(m =&gt; m.Apply("Update").Cancel("Discard"))
)

Opacity(bool)

Only for the HSV selector. If true, the widget will display the opacity slider. Note that currently in HTML5 the <input type="color"> does not support opacity.

C#
public ColorPickerBuilder Opacity(bool value)
Parameters:valuebool

The value that configures the opacity.

Returns:

ColorPickerBuilder

Example:
C#
@(Html.Kendo().ColorPicker()
.Name("palette")
.Views(new string[] { "palette"})
.Opacity(true)
)

Palette(ColorPickerPalette)

Sets the range of colors that the user can pick from.

C#
public ColorPickerBuilder Palette(ColorPickerPalette palette)
Parameters:paletteColorPickerPalette

One of the preset palettes of colors

Returns:

ColorPickerBuilder

Example:
C#
@( Html.Kendo().ColorPicker()
.Name("ColorPicker")
.Palette(ColorPickerPalette.WebSafe)
)

Palette(IEnumerable<string>)

Sets the range of colors that the user can pick from.

C#
public ColorPickerBuilder Palette(IEnumerable<string> palette)
Parameters:paletteIEnumerable<string>

A list of colors.

Returns:

ColorPickerBuilder

Example:
C#
@( Html.Kendo().ColorPicker()
.Name("ColorPicker")
.Palette(new List&lt;string&gt; { "#ff0000", "#00ff00", "#0000ff" })
)

Preview(bool)

Displays the color preview element and the previously selected color for comparison. With buttons set to false, both elements will update at the same time.

C#
public ColorPickerBuilder Preview(bool value)
Parameters:valuebool

The value that configures the preview.

Returns:

ColorPickerBuilder

Example:
C#
@(Html.Kendo().ColorPicker()
.Name("palette")
.Views(new string[] { "palette"})
.Preview(true)
)

Rounded(Rounded)

Sets a value controlling the border radius.

C#
public ColorPickerBuilder Rounded(Rounded value)
Parameters:valueRounded

The value that configures the rounded.

Returns:

ColorPickerBuilder

Example:
C#
@(Html.Kendo().ColorPicker()
.Name("palette")
.Views(new string[] { "palette"})
.Rounded(Rounded.Full)
)

Size(ComponentSize)

Sets the size of the component.

C#
public ColorPickerBuilder Size(ComponentSize value)
Parameters:valueComponentSize

The value that configures the size.

Returns:

ColorPickerBuilder

Example:
C#
@(Html.Kendo().ColorPicker()
.Name("palette")
.Views(new string[] { "palette"})
.Size(ComponentSize.Medium)
)

TileSize(Action<PaletteSizeBuilder>)

Sets the size of the palette tiles

C#
public ColorPickerBuilder TileSize(Action<PaletteSizeBuilder> sizeAction)
Parameters:sizeActionAction<PaletteSizeBuilder>

The tile size (for square tiles)

Returns:

ColorPickerBuilder

Example:
C#
@( Html.Kendo().ColorPalette()
.Name("ColorPalette")
.TileSize(s =&gt; s.Width(20).Height(10))
)

TileSize(int)

Sets the size of the palette tiles

C#
public ColorPickerBuilder TileSize(int tileSize)
Parameters:tileSizeint

The tile size (for square tiles)

Returns:

ColorPickerBuilder

Example:
C#
@( Html.Kendo().ColorPalette()
.Name("ColorPalette")
.TileSize(32)
)

ToolIcon(string)

A CSS class name to display an icon in the color picker button. If specified, the HTML for the element will look like this:

C#
public ColorPickerBuilder ToolIcon(string value)
Parameters:valuestring

The value that configures the toolicon.

Returns:

ColorPickerBuilder

Example:
C#
@(Html.Kendo().ColorPicker()
.Name("palette")
.Views(new string[] { "palette"})
.ToolIcon("gear")
)

Value(string)

The initially selected color. Note that when initializing the widget from an <input> element, the initial color will be decided by the field instead.

C#
public ColorPickerBuilder Value(string value)
Parameters:valuestring

The value that configures the value.

Returns:

ColorPickerBuilder

Example:
C#
@(Html.Kendo().ColorPicker()
.Name("palette")
.Views(new string[] { "palette"})
.Value("#b72bba")
)

View(ColorPickerView)

Defines the initially selected view in the ColorPicker.

C#
public ColorPickerBuilder View(ColorPickerView value)
Parameters:valueColorPickerView

The value that configures the view.

Returns:

ColorPickerBuilder

Example:
C#
@(Html.Kendo().ColorPicker()
.Name("palette")
.Views(new string[] { "palette"})
.View(ColorPickerView.Palette)
)

Views(params string[])

Sets the views of the component.

C#
public ColorPickerBuilder Views(params string[] views)
Parameters:viewsstring[]

The array value that configures the views.

Returns:

ColorPickerBuilder

Example:
C#
@(Html.Kendo().ColorPicker()
.Name("palette")
.Views(new string[] { "palette"})
)
In this article
DefinitionConstructorsColorPickerBuilder(ColorPicker)MethodsAdaptiveMode(AdaptiveMode)AdaptiveSubtitle(string)AdaptiveTitle(string)Buttons(bool)ButtonsTemplate(string)ButtonsTemplate<TModel>(TemplateBuilder<TModel>)ButtonsTemplateHandler(string)ButtonsTemplateId(string)ButtonsTemplateView(MvcHtmlString)ClearButton(bool)CloseOnSelect(bool)Columns(double)ContrastTool()ContrastTool(Action<ColorPickerContrastToolSettingsBuilder>)ContrastTool(bool)Enable(bool)Events(Action<ColorPickerEventBuilder>)FillMode(FillMode)Format(ColorPickerFormat)Formats(params string[])Input(bool)Messages(Action<ColorPickerMessagesSettingsBuilder>)Opacity(bool)Palette(ColorPickerPalette)Palette(IEnumerable<string>)Preview(bool)Rounded(Rounded)Size(ComponentSize)TileSize(Action<PaletteSizeBuilder>)TileSize(int)ToolIcon(string)Value(string)View(ColorPickerView)Views(params string[])
Not finding the help you need?
Contact Support