Class
TelerikColorGradient

The class for the Telerik ColorGradient Component.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

cs-api-definition
public class TelerikColorGradient : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable, IColorGradientSettings

Inheritance: objectComponentBaseBaseComponentTelerikColorGradient

Implements: IColorGradientSettingsIComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members BaseComponent.ShouldRender()BaseComponent.OnInitializedAsync()BaseComponent.Dispose()BaseComponent.InitLocalizer()BaseComponent.ThrowIfParameterIsNull(object, string)BaseComponent.HaveOptionsChanged(IDictionary<string, object>, IDictionary<string, object>)BaseComponent.GetClassString(params string[])BaseComponent.InvokeAsync<T>(string, params object[])BaseComponent.InvokeAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidAsync(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidComponentMethodAsync(string, params object[])BaseComponent.InvokeComponentVoidMethodAsync(string, object)BaseComponent.InvokeDisposeAsync()BaseComponent.StateHasChanged()BaseComponent.RootComponentBaseComponent.ClassComponentBase.OnInitialized()ComponentBase.OnParametersSet()ComponentBase.OnAfterRender(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)

Constructors

TelerikColorGradient()

Declaration

cs-api-definition
public TelerikColorGradient()

Properties

AriaLabel

Describe the aria-label attribute for the component.

Declaration

cs-api-definition
[Parameter]
public string AriaLabel { get; set; }

Property Value

string

Enabled

Specifies if the ColorGradient is in an enabled or disabled state. The default value is true and the component accepts user interaction.

Declaration

cs-api-definition
[Parameter]
public bool Enabled { get; set; }

Property Value

bool

Format

Specifies the value format, which users see initially. Supports Rgb and Hex formats. The default value is Rgb.

Declaration

cs-api-definition
[Parameter]
public ColorFormat Format { get; set; }

Property Value

ColorFormat

Implements IColorGradientSettings.Format

FormatChanged

Fires when the user clicks on the toggle button, which changes the input format.

Declaration

cs-api-definition
[Parameter]
public EventCallback<ColorFormat> FormatChanged { get; set; }

Property Value

EventCallback<ColorFormat>

Formats

Defines the available color formats, which the user can see or use to select a color. The default list contains Rgb and Hex formats.

Declaration

cs-api-definition
[Parameter]
public IEnumerable<ColorFormat> Formats { get; set; }

Property Value

IEnumerable<ColorFormat>

Implements IColorGradientSettings.Formats

ShowOpacityEditor

Defines the visibility of the opacity slider. Default value is true. When opacity is disabled, the ColorPicker Value will not include an alpha part.

Declaration

cs-api-definition
[Parameter]
public bool ShowOpacityEditor { get; set; }

Property Value

bool

Implements IColorGradientSettings.ShowOpacityEditor

TabIndex

Declaration

cs-api-definition
[Parameter]
public int? TabIndex { get; set; }

Property Value

int?

Value

Specifies the color value of the component in a valid css format - hexadecimal (ex: #fff, #ffffff, #ffffff70) and rgb (ex: rgb(0, 0, 0), rgba(0,0,0, 0.6).

Declaration

cs-api-definition
[Parameter]
public string Value { get; set; }

Property Value

string

ValueChanged

The event fires when the value of the ColorGradient changes.

Declaration

cs-api-definition
[Parameter]
public EventCallback<string> ValueChanged { get; set; }

Property Value

EventCallback<string>

ValueFormat

Defines the color format, which the component will return in the application code. Supports Rgb and Hex formats. The default value is Rgb.

Declaration

cs-api-definition
[Parameter]
public ColorFormat ValueFormat { get; set; }

Property Value

ColorFormat

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

cs-api-definition
protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

OnAfterRenderAsync(bool)

Declaration

cs-api-definition
protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender

bool

Returns

Task

Overrides BaseComponent.OnAfterRenderAsync(bool)

OnParametersSetAsync()

Declaration

cs-api-definition
protected override Task OnParametersSetAsync()

Returns

Task

Overrides ComponentBase.OnParametersSetAsync()

SetParametersAsync(ParameterView)

Declaration

cs-api-definition
public override Task SetParametersAsync(ParameterView parameters)

Parameters

parameters

ParameterView

Returns

Task

Overrides ComponentBase.SetParametersAsync(ParameterView)