FlatColorPickerBuilder
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 FlatColorPickerBuilder instance.
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. Only "hex" and "rgb" are valid values.
Parameters
formats - System.String[]
A list of formats.
RETURNS
Returns the current FlatColorPickerBuilder instance.
Example
@( Html.Kendo().FlatColorPicker()
.Name("FlatColorPicker")
.Formats(new string[]{ "rgb", "hex" })
)
Views(System.String[])
Sets the available views in the FlatColorPicker. The valid values are "gradient" and "palette".
Parameters
views - System.String[]
A list of the views.
RETURNS
Returns the current FlatColorPickerBuilder instance.
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
RETURNS
Returns the current FlatColorPickerBuilder instance.
Opacity()
Specifies whether we should display the opacity slider to allow selection of transparency.
RETURNS
Returns the current FlatColorPickerBuilder 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 FlatColorPickerBuilder instance.
Buttons()
Specifies whether the widget should display the Apply / Cancel buttons.
RETURNS
Returns the current FlatColorPickerBuilder instance.
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
RETURNS
Returns the current FlatColorPickerBuilder instance.
ContrastTool(System.Action)
Enables the contrast tool in the ColorGradient.
Parameters
configurator - System.Action<FlatColorPickerContrastToolSettingsBuilder>
The configurator for the contrasttool setting.
RETURNS
Returns the current instance of FlatColorPickerBuilder .
ContrastTool()
Enables the contrast tool in the ColorGradient.
RETURNS
Returns the current instance of FlatColorPickerBuilder .
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 FlatColorPickerContrastToolSettingsBuilder .
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 FlatColorPickerBuilder instance.
ClearButton()
Specifies whether the widget should display the 'Clear color' button.
RETURNS
Returns the current FlatColorPickerBuilder instance.
Input(System.Boolean)
Whether to render the input in ColorGradient component.
Parameters
value - System.Boolean
The value for Input
RETURNS
Returns the current FlatColorPickerBuilder instance.
Value(System.String)
Specifies the initially selected color.
Parameters
value - System.String
The value for Value
RETURNS
Returns the current FlatColorPickerBuilder instance.
View(System.String)
The initially selected view in the FlatColorPicker.
Parameters
value - System.String
The value for View
RETURNS
Returns the current FlatColorPickerBuilder instance.
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
RETURNS
Returns the current FlatColorPickerBuilder instance.
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
RETURNS
Returns the current FlatColorPickerBuilder instance.
Messages(System.Action)
Allows customization of "Apply" / "Cancel" labels.
Parameters
configurator - System.Action<FlatColorPickerMessagesSettingsBuilder>
The configurator for the messages setting.
RETURNS
Returns the current instance of FlatColorPickerBuilder .
Size(Kendo.Mvc.UI.ComponentSize)
Sets the size of the component.
Parameters
value - ComponentSize
The value for Size
RETURNS
Returns the current FlatColorPickerBuilder 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 FlatColorPickerBuilder 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 FlatColorPickerBuilder instance.
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<FlatColorPickerEventBuilder>
The client events action.
RETURNS
Returns the current FlatColorPickerBuilder instance.
Example
@(Html.Kendo().FlatColorPicker()
.Name("FlatColorPicker")
.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.