New to Telerik UI for ASP.NET Core? Download free 30-day trial

ColorPickerBuilder

Defines the fluent API for configuring the Kendo UI ColorPicker

Properties

WriteAction - Func

Methods

Palette(System.String[])

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

Parameters

palette - System.String[]

A list of colors.

Example


             <%= Html.Kendo().ColorPicker()
                        .Name("ColorPicker")
                        .Palette(new List<string> { "#ff0000", "#00ff00", "#0000ff" })
            %>

Enable(System.Boolean)

Enables or disables the picker.

Parameters

value - System.Boolean

Whether the picker is enabled

Example


             <%= Html.Kendo().ColorPicker()
                        .Name("ColorPicker")
                        .Enable(false)
            %>

TileSize(System.Int32)

Sets the size of the palette tiles

Parameters

tileSize - System.Int32

The tile size (for square tiles)

Example


             <%= Html.Kendo().ColorPalette()
                        .Name("ColorPalette")
                        .TileSize(32)
            %>

Views(System.String[])

Sets the available views in the ColorPicker.

Parameters

views - System.String[]

Valid values are "gradient" and "palette".

Example


             <%= Html.Kendo().ColorPicker()
                        .Name("ColorPicker")
                        .Views(new string[]{ "gradient", "palette" })
            %>

Formats(System.String[])

Sets the available input formats in the gradient input editor.

Parameters

formats - System.String[]

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

Example


             <%= Html.Kendo().ColorPicker()
                        .Name("ColorPicker")
                        .Formats(new string[]{ "rgb", "hex" })
            %>

Buttons(System.Boolean)

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

Parameters

value - System.Boolean

The value for Buttons

ContrastTool(System.Action)

Enables the contrast tool in the ColorGradient.

Parameters

configurator - System.Action<ColorPickerContrastToolSettingsBuilder>

The configurator for the contrasttool setting.

ContrastTool()

Enables the contrast tool in the ColorGradient.

ContrastTool(System.Boolean)

Enables the contrast tool in the ColorGradient.

Parameters

enabled - System.Boolean

Enables or disables the contrasttool option.

ClearButton(System.Boolean)

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

Parameters

value - System.Boolean

The value for ClearButton

ClearButton()

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

CloseOnSelect(System.Boolean)

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.

Parameters

value - System.Boolean

The value for CloseOnSelect

CloseOnSelect()

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.

Columns(System.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.

Parameters

value - System.Double

The value for Columns

Input(System.Boolean)

Whether to render the input in the ColorGradient component.

Parameters

value - System.Boolean

The value for Input

TileSize(System.Action)

The size of a color cell.

Parameters

configurator - System.Action<ColorPickerTileSizeSettingsBuilder>

The configurator for the tilesize setting.

Messages(System.Action)

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

Parameters

configurator - System.Action<ColorPickerMessagesSettingsBuilder>

The configurator for the messages setting.

Opacity(System.Boolean)

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.

Parameters

value - System.Boolean

The value for Opacity

Opacity()

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.

Preview(System.Boolean)

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.

Parameters

value - System.Boolean

The value for Preview

ToolIcon(System.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:

Parameters

value - System.String

The value for ToolIcon

Value(System.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.

Parameters

value - System.String

The value for Value

Palette(Kendo.Mvc.UI.ColorPickerPalette)

Defines the palettes that can be used in the color picker.

Parameters

value - ColorPickerPalette

The value for Palette

Format(Kendo.Mvc.UI.ColorPickerFormat)

Defines the format of the gradient input editor.

Parameters

value - ColorPickerFormat

The value for Format

View(Kendo.Mvc.UI.ColorPickerView)

Defines the initially selected view in the ColorPicker.

Parameters

value - ColorPickerView

The value for View

Size(Kendo.Mvc.UI.ComponentSize)

Sets the size of the component.

Parameters

value - ComponentSize

The value for Size

Rounded(Kendo.Mvc.UI.Rounded)

Sets a value controlling the border radius.

Parameters

value - Rounded

The value for Rounded

FillMode(Kendo.Mvc.UI.FillMode)

Sets a value controlling how the color is applied.

Parameters

value - FillMode

The value for FillMode

Events(System.Action)

Configures the client-side events.

Parameters

configurator - System.Action<ColorPickerEventBuilder>

The client events action.

Example


            @(Html.Kendo().ColorPicker()
                  .Name("ColorPicker")
                  .Events(events => events
                      .Change("onChange")
                  )
            )

ToComponent()

Returns the internal view component.

Expression(System.String)

Sets the name of the component.

Parameters

modelExpression - System.String

Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)

Sets the name of the component.

Parameters

modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer

Name(System.String)

Sets the name of the component.

Parameters

componentName - System.String

The name.

Deferred(System.Boolean)

Suppress initialization script rendering. Note that this options should be used in conjunction with

Parameters

deferred - System.Boolean

HtmlAttributes(System.Object)

Sets the HTML attributes.

Parameters

attributes - System.Object

The HTML attributes.

HtmlAttributes(System.Collections.Generic.IDictionary)

Sets the HTML attributes.

Parameters

attributes - System.Collections.Generic.IDictionary<String,Object>

The HTML attributes.

Render()

Renders the component in place.

ToHtmlString()

WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)

Parameters

writer - System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder

ToClientTemplate()

In this article
Not finding the help you need?