New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

ColorGradientBuilder

Class

Defines the fluent API for configuring the Telerik UI for ASP.NET MVC ColorGradient.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class ColorGradientBuilder : WidgetBuilderBase<ColorGradient, ColorGradientBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<ColorGradient, ColorGradientBuilder>ColorGradientBuilder

Implements: IHtmlString

Constructors

ColorGradientBuilder(ColorGradient)

Initializes a new instance of the ColorGradient class.

public ColorGradientBuilder(ColorGradient component)

Parameters:componentColorGradient

The component.

Methods

ContrastTool()

Enables the contrast tool of the ColorGradient.

public ColorGradientBuilder ContrastTool()

Returns:

ColorGradientBuilder

ContrastTool(Action<ColorGradientContrastToolSettingsBuilder>)

Defines the contrast tool options.

public ColorGradientBuilder ContrastTool(Action<ColorGradientContrastToolSettingsBuilder> configurator)

Parameters:configuratorAction<ColorGradientContrastToolSettingsBuilder>

The action that configures the contrast tool settings.

Returns:

ColorGradientBuilder

Example:

@(Html.Kendo().ColorGradient()
.Name("colorGradient")
.ContrastTool(ct =&gt; ct.BackgroundColor("#ff0000"))
)

ContrastTool(bool)

Enables the contrast tool of the ColorGradient.

public ColorGradientBuilder ContrastTool(bool enabled)

Parameters:enabledbool

The value that configures the visibility of the contrast tool.

Returns:

ColorGradientBuilder

Example:

@(Html.Kendo().ColorGradient()
.Name("colorGradient")
.ContrastTool(true)
)

Events(Action<ColorGradientEventBuilder>)

Configures the handled client-side events of the ColorGradient.

public ColorGradientBuilder Events(Action<ColorGradientEventBuilder> configurator)

Parameters:configuratorAction<ColorGradientEventBuilder>

The action that configures the available events.

Returns:

ColorGradientBuilder

Example:

@( Html.Kendo().ColorGradient()
.Name("ColorGradient")
.Events(events =&gt; events
.Change("onChange")
)
)

Format(ColorGradientFormat)

Defines the default input format in the gradient input editor.

public ColorGradientBuilder Format(ColorGradientFormat value)

Parameters:valueColorGradientFormat

The value that configures the format.

Returns:

ColorGradientBuilder

Example:

@(Html.Kendo().ColorGradient()
.Name("colorGradient")
.Format(ColorGradientFormat.Rgb)
)

Formats(params string[])

Sets the available input formats in the gradient input editor.

public ColorGradientBuilder Formats(params string[] formats)

Parameters:formatsstring[]

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

Returns:

ColorGradientBuilder

Example:

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

Input(bool)

Toggles the visibility of the input.

public ColorGradientBuilder Input(bool value)

Parameters:valuebool

The value that configures the visibility of the input.

Returns:

ColorGradientBuilder

Example:

@(Html.Kendo().ColorGradient()
.Name("colorGradient")
.Input(false)
)

Messages(Action<ColorGradientMessagesSettingsBuilder>)

Defines the localization of the texts that are used in the ColorGradient.

public ColorGradientBuilder Messages(Action<ColorGradientMessagesSettingsBuilder> configurator)

Parameters:configuratorAction<ColorGradientMessagesSettingsBuilder>

The action that configures the message settings.

Returns:

ColorGradientBuilder

Example:

@(Html.Kendo().ColorGradient()
.Name("colorGradient")
.Messages(msg =&gt; msg.ToggleFormat("Change format"))
)

Opacity(bool)

Specifies whether the opacity slider must be shown to allow transparency selection.

public ColorGradientBuilder Opacity(bool value)

Parameters:valuebool

The value that configures the visibility of the opacity slider.

Returns:

ColorGradientBuilder

Example:

@(Html.Kendo().ColorGradient()
.Name("colorGradient")
.Opacity(true)
)

Size(ComponentSize)

Sets a value controlling the size of the component.

public ColorGradientBuilder Size(ComponentSize value)

Parameters:valueComponentSize

The value that configures the size.

Returns:

ColorGradientBuilder

Value(string)

Specifies the initially selected color.

public ColorGradientBuilder Value(string value)

Parameters:valuestring

The value that configures the initial color.

Returns:

ColorGradientBuilder

Example:

@(Html.Kendo().ColorGradient()
.Name("colorGradient")
.Value("#000")
)