ColorGradientBuilder
Properties
WriteAction - Func
Methods
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 ColorGradientBuilder for method chaining.
Example
@( Html.Kendo().ColorGradient()
.Name("ColorGradient")
.Formats(new string[]{ "rgb", "hex" })
)
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 ColorGradientBuilder instance.
Opacity()
Specifies whether we should display the opacity slider to allow selection of transparency.
RETURNS
Returns the current ColorGradientBuilder instance.
ContrastTool(System.Action)
Enables the contrast tool in the ColorGradient.
Parameters
configurator - System.Action<ColorGradientContrastToolSettingsBuilder>
The configurator for the contrasttool setting.
RETURNS
Returns the current instance of ColorGradientBuilder .
ContrastTool()
Enables the contrast tool in the ColorGradient.
RETURNS
Returns the current instance of ColorGradientBuilder .
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 ColorGradientContrastToolSettingsBuilder .
Input(System.Boolean)
Whether to render the input.
Parameters
value - System.Boolean
The value for Input
RETURNS
Returns the current ColorGradientBuilder instance.
Value(System.String)
Specifies the initially selected color.
Parameters
value - System.String
The value for Value
RETURNS
Returns the current ColorGradientBuilder instance.
Messages(System.Action)
Allows customization labels and messages in the ColorGradient.
Parameters
configurator - System.Action<ColorGradientMessagesSettingsBuilder>
The configurator for the messages setting.
RETURNS
Returns the current instance of ColorGradientBuilder .
Size(Kendo.Mvc.UI.ComponentSize)
Sets the size of the component.
Parameters
value - ComponentSize
The value for Size
RETURNS
Returns the current ColorGradientBuilder instance.
Format(Kendo.Mvc.UI.ColorGradientFormat)
Defines the format of the gradient input editor.
Parameters
value - ColorGradientFormat
The value for Format
RETURNS
Returns the current ColorGradientBuilder instance.
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<ColorGradientEventBuilder>
The client events action.
RETURNS
Returns the current ColorGradientBuilder instance.
Example
@(Html.Kendo().ColorGradient()
.Name("ColorGradient")
.Events(events => events
.Change("onChange")
)
)
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.