ColorPickerBuilder

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.

RETURNS

Returns the current instance of ColorPickerBuilder for method chaining.

Example

Razor
 
             @( 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

RETURNS

Returns the current instance of ColorPickerBuilder for method chaining.

Example

Razor
 
             @( 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)

RETURNS

Returns the current instance of ColorPickerBuilder for method chaining.

Example

Razor
 
             @( 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".

RETURNS

Returns the current instance of ColorPickerBuilder for method chaining.

Example

Razor
 
             @( 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.

RETURNS

Returns the current instance of ColorPickerBuilder for method chaining.

Example

Razor
 
             @( Html.Kendo().ColorPicker()
                        .Name("ColorPicker")
                        .Formats(new string[]{ "rgb", "hex" })
            )
             

AdaptiveTitle(System.String)

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

Parameters

value - System.String

The value for AdaptiveTitle

RETURNS

Returns the current ColorPickerBuilder instance.

AdaptiveSubtitle(System.String)

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

Parameters

value - System.String

The value for AdaptiveSubtitle

RETURNS

Returns the current ColorPickerBuilder instance.

Buttons(System.Boolean)

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

Parameters

value - System.Boolean

The value for Buttons

RETURNS

Returns the current ColorPickerBuilder instance.

ContrastTool(System.Action)

Enables the contrast tool in the ColorGradient.

Parameters

configurator - System.Action<ColorPickerContrastToolSettingsBuilder>

The configurator for the contrasttool setting.

RETURNS

Returns the current instance of ColorPickerBuilder .

ContrastTool()

Enables the contrast tool in the ColorGradient.

RETURNS

Returns the current instance of ColorPickerBuilder .

ContrastTool(System.Boolean)

Enables the contrast tool in the ColorGradient.

Parameters

enabled - System.Boolean

Enables or disables the contrasttool option.

RETURNS

Returns the current instance of ColorPickerContrastToolSettingsBuilder .

ClearButton(System.Boolean)

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

Parameters

value - System.Boolean

The value for ClearButton

RETURNS

Returns the current ColorPickerBuilder instance.

ClearButton()

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

RETURNS

Returns the current ColorPickerBuilder instance.

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

RETURNS

Returns the current ColorPickerBuilder instance.

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.

RETURNS

Returns the current ColorPickerBuilder instance.

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

RETURNS

Returns the current ColorPickerBuilder instance.

Input(System.Boolean)

Whether to render the input in the ColorGradient component.

Parameters

value - System.Boolean

The value for Input

RETURNS

Returns the current ColorPickerBuilder instance.

TileSize(System.Action)

The size of a color cell.

Parameters

configurator - System.Action<ColorPickerTileSizeSettingsBuilder>

The configurator for the tilesize setting.

RETURNS

Returns the current instance of ColorPickerBuilder .

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.

RETURNS

Returns the current instance of ColorPickerBuilder .

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

RETURNS

Returns the current ColorPickerBuilder instance.

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.

RETURNS

Returns the current ColorPickerBuilder instance.

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

RETURNS

Returns the current ColorPickerBuilder instance.

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

RETURNS

Returns the current ColorPickerBuilder instance.

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

RETURNS

Returns the current ColorPickerBuilder instance.

Palette(Kendo.Mvc.UI.ColorPickerPalette)

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

Parameters

value - ColorPickerPalette

The value for Palette

RETURNS

Returns the current ColorPickerBuilder instance.

Format(Kendo.Mvc.UI.ColorPickerFormat)

Defines the format of the gradient input editor.

Parameters

value - ColorPickerFormat

The value for Format

RETURNS

Returns the current ColorPickerBuilder instance.

View(Kendo.Mvc.UI.ColorPickerView)

Defines the initially selected view in the ColorPicker.

Parameters

value - ColorPickerView

The value for View

RETURNS

Returns the current ColorPickerBuilder instance.

Size(Kendo.Mvc.UI.ComponentSize)

Sets the size of the component.

Parameters

value - ComponentSize

The value for Size

RETURNS

Returns the current ColorPickerBuilder instance.

Rounded(Kendo.Mvc.UI.Rounded)

Sets a value controlling the border radius.

Parameters

value - Rounded

The value for Rounded

RETURNS

Returns the current ColorPickerBuilder instance.

FillMode(Kendo.Mvc.UI.FillMode)

Sets a value controlling how the color is applied.

Parameters

value - FillMode

The value for FillMode

RETURNS

Returns the current ColorPickerBuilder instance.

AdaptiveMode(Kendo.Mvc.UI.AdaptiveMode)

Specifies the adaptive rendering of the component.

Parameters

value - AdaptiveMode

The value for AdaptiveMode

RETURNS

Returns the current ColorPickerBuilder instance.

Events(System.Action)

Configures the client-side events.

Parameters

configurator - System.Action<ColorPickerEventBuilder>

The client events action.

RETURNS

Returns the current ColorPickerBuilder instance.

Example

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

UseMvvmInitialization(System.Boolean)

Specifies if the component should be initialized through MVVM on the client.

Parameters

value - System.Boolean

The value.

RETURNS

Returns the current instance.

UseMvvmInitialization()

Specifies if the component should be initialized through MVVM on the client.

RETURNS

Returns the current instance.

ToComponent()

Returns the internal view component.

RETURNS

The instance that represents the component.

Expression(System.String)

Sets the name of the component.

Parameters

modelExpression - System.String

RETURNS

Returns the current instance.

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

Sets the name of the component.

Parameters

modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer

RETURNS

Returns the current instance.

Name(System.String)

Sets the name of the component.

Parameters

componentName - System.String

The name.

RETURNS

Returns the current instance.

Deferred(System.Boolean)

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

Parameters

deferred - System.Boolean

RETURNS

Returns a DeferredWidgetBuilder instance.

HtmlAttributes(System.Object)

Sets the HTML attributes.

Parameters

attributes - System.Object

The HTML attributes.

RETURNS

Returns the current instance.

HtmlAttributes(System.Collections.Generic.IDictionary)

Sets the HTML attributes.

Parameters

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

The HTML attributes.

RETURNS

Returns the current instance.

ScriptAttributes(System.Object,System.Boolean)

Sets the JavaScript attributes to the initialization script.

Parameters

attributes - System.Object

The JavaScript attributes.

overrideAttributes - System.Boolean

Argument which determines whether attributes should be overriden.

RETURNS

Returns the current instance.

ScriptAttributes(System.Collections.Generic.IDictionary,System.Boolean)

Sets the JavaScript attributes to the initialization script.

Parameters

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

The JavaScript attributes.

overrideAttributes - System.Boolean

Argument which determines whether attributes should be overriden.

RETURNS

Returns the current instance.

Render()

Renders the component in place.

ToHtmlString()

Returns the HTML representation of the component.

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

Parameters

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

ToClientTemplate()

Returns the client template for the component.

AsModule(System.Boolean)

Specifies whether the initialization script of the component will be rendered as a JavaScript module.

Parameters

value - System.Boolean

RETURNS

Returns the current instance.