FlatColorPickerBuilder

Defines the fluent API for configuring the Kendo UI FlatColorPicker

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().FlatColorPicker()
                        .Name("FlatColorPicker")
                        .Palette(new List<string> { "#ff0000", "#00ff00", "#0000ff" })
            )

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().FlatColorPicker()
                        .Name("FlatColorPicker")
                        .Formats(new string[]{ "rgb", "hex" })
            )

Views(System.String[])

Sets the available views in the ColorPicker.

Parameters

views - System.String[]

Valid values are "gradient" and "palette".

Example

             @( Html.Kendo().FlatColorPicker()
                        .Name("FlatColorPicker")
                        .Views(new string[]{ "gradient", "palette" })
            )

Opacity(System.Boolean)

Specifies whether we should display the opacity slider to allow selection of transparency.

Parameters

value - System.Boolean

The value for Opacity

Opacity()

Specifies whether we should display the opacity slider to allow selection of transparency.

Buttons(System.Boolean)

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

Parameters

value - System.Boolean

The value for Buttons

Buttons()

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

Columns(System.Double)

The number of columns to show in the palette. Also defines the width of the FlatColorPicker.

Parameters

value - System.Double

The value for Columns

ContrastTool(System.Action)

Enables the contrast tool in the ColorGradient.

Parameters

configurator - System.Action<FlatColorPickerContrastToolSettingsBuilder>

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.

Input(System.Boolean)

Whether to render the input in ColorGradient component.

Parameters

value - System.Boolean

The value for Input

Value(System.String)

Specifies the initially selected color.

Parameters

value - System.String

The value for Value

View(System.String)

The initially selected view in the FlatColorPicker.

Parameters

value - System.String

The value for View

Preview(System.Boolean)

Specifies whether a selected and previous color are displayed for color comparison. with autoupdate set to true both selected and previous colors will be updated.

Parameters

value - System.Boolean

The value for Preview

Autoupdate(System.Boolean)

Specifies whether the UI should be updated while the user is typing in the input field, whenever a valid color can be parsed. If you passfalse for this, the widget will update only when ENTER is pressed.

Parameters

value - System.Boolean

The value for Autoupdate

Messages(System.Action)

Allows customization of "Apply" / "Cancel" labels.

Parameters

configurator - System.Action<FlatColorPickerMessagesSettingsBuilder>

The configurator for the messages setting.

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

Events(System.Action)

Configures the client-side events.

Parameters

configurator - System.Action<FlatColorPickerEventBuilder>

The client events action.

Example

            @(Html.Kendo().FlatColorPicker()
                  .Name("FlatColorPicker")
                  .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()

AsChildComponent()

Configures the widget as a child component.