Back to all docs
API Reference / Kendo.Mvc.UI.Fluent / CircularProgressBarBuilder
New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

CircularProgressBarBuilder

Class

Defines the fluent API for configuring the Kendo CircularProgressBar for ASP.NET MVC.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:
C#
public class CircularProgressBarBuilder : WidgetBuilderBase<CircularProgressBar, CircularProgressBarBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<CircularProgressBar, CircularProgressBarBuilder>CircularProgressBarBuilder

Implements: IHtmlString

Inherited Members WidgetBuilderBase<CircularProgressBar, CircularProgressBarBuilder>.ToComponent()WidgetBuilderBase<CircularProgressBar, CircularProgressBarBuilder>.Name(string)WidgetBuilderBase<CircularProgressBar, CircularProgressBarBuilder>.Deferred(bool)WidgetBuilderBase<CircularProgressBar, CircularProgressBarBuilder>.ModelMetadata(ModelMetadata)WidgetBuilderBase<CircularProgressBar, CircularProgressBarBuilder>.HtmlAttributes(object)WidgetBuilderBase<CircularProgressBar, CircularProgressBarBuilder>.HtmlAttributes(IDictionary<string, object>)WidgetBuilderBase<CircularProgressBar, CircularProgressBarBuilder>.AsModule(bool)WidgetBuilderBase<CircularProgressBar, CircularProgressBarBuilder>.Render()WidgetBuilderBase<CircularProgressBar, CircularProgressBarBuilder>.ScriptAttributes(object, bool)WidgetBuilderBase<CircularProgressBar, CircularProgressBarBuilder>.ScriptAttributes(IDictionary<string, object>, bool)WidgetBuilderBase<CircularProgressBar, CircularProgressBarBuilder>.ToHtmlString()WidgetBuilderBase<CircularProgressBar, CircularProgressBarBuilder>.ToClientTemplate()WidgetBuilderBase<CircularProgressBar, CircularProgressBarBuilder>.ToString()WidgetBuilderBase<CircularProgressBar, CircularProgressBarBuilder>.Componentobject.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

CircularProgressBarBuilder(CircularProgressBar)

Initializes a new instance of the CircularProgressBar class.

C#
public CircularProgressBarBuilder(CircularProgressBar component)
Parameters:componentCircularProgressBar

The component.

Methods

AriaRole(bool)

If set to true the Circular ProgressBar will have its role attribute set to progressbar. It will also render its aria-valuemin, aria-valuemax, and aria-valuenow attributes.

C#
public CircularProgressBarBuilder AriaRole(bool value)
Parameters:valuebool

The value that configures the ariarole.

Returns:

CircularProgressBarBuilder

Example:
C#
@(Html.Kendo().CircularProgressBar()
.Name("progressbar")
.AriaRole(true)
)

CenterTemplate(string)

The template that will be displayed in the center of the progress bar. Template variables: * value - the value * color - the matching color for the value

C#
public CircularProgressBarBuilder CenterTemplate(string value)
Parameters:valuestring

The value that configures the centertemplate.

Returns:

CircularProgressBarBuilder

Example:
C#
@(Html.Kendo().CircularProgressBar()
.Name("progressbar")
.CenterTemplate("&lt;span style='color: #: color #;'&gt;#= value == 100 ? \"&lt;span class='k-icon k-font-icon k-i-check'&gt;&lt;/span&gt;\" : value + '%' #&lt;/span&gt;")
)

CenterTemplate<TModel>(TemplateBuilder<TModel>)

The template that will be displayed in the center of the progress bar. Template variables: * value - the value * color - the matching color for the value

C#
public CircularProgressBarBuilder CenterTemplate<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the centertemplate.

Returns:

CircularProgressBarBuilder

CenterTemplateHandler(string)

The template that will be displayed in the center of the progress bar. Template variables: * value - the value * color - the matching color for the value

C#
public CircularProgressBarBuilder CenterTemplateHandler(string value)
Parameters:valuestring

The value that configures the centertemplate.

Returns:

CircularProgressBarBuilder

Example:
C#
@(Html.Kendo().CircularProgressBar()
.Name("progressbar")
.CenterTemplateHandler("CenterTemplateHandler")
)

CenterTemplateId(string)

The template that will be displayed in the center of the progress bar. Template variables: * value - the value * color - the matching color for the value

C#
public CircularProgressBarBuilder CenterTemplateId(string value)
Parameters:valuestring

The value that configures the centertemplate.

Returns:

CircularProgressBarBuilder

Example:
C#
@(Html.Kendo().CircularProgressBar()
.Name("progressbar")
.CenterTemplateId("CenterTemplateId")
)

CenterTemplateView(MvcHtmlString)

The template that will be displayed in the center of the progress bar. Template variables: * value - the value * color - the matching color for the value

C#
public CircularProgressBarBuilder CenterTemplateView(MvcHtmlString value)
Parameters:valueMvcHtmlString

The value that configures the centertemplate.

Returns:

CircularProgressBarBuilder

Color(string)

The color of the value pointer. Accepts a valid CSS color string, including hex and rgb.

C#
public CircularProgressBarBuilder Color(string value)
Parameters:valuestring

The value that configures the color.

Returns:

CircularProgressBarBuilder

Example:
C#
@(Html.Kendo().CircularProgressBar()
.Name("progressbar")
.Color("green")
)

Colors(Action<CircularProgressBarColorFactory>)

The color ranges of the value pointer. The pointer color will be set to the color from the range that contains the current value.

C#
public CircularProgressBarBuilder Colors(Action<CircularProgressBarColorFactory> configurator)
Parameters:configuratorAction<CircularProgressBarColorFactory>

The action that configures the colors.

Returns:

CircularProgressBarBuilder

Indeterminate(bool)

A value indicating whether endloess loading is enabled

C#
public CircularProgressBarBuilder Indeterminate(bool value)
Parameters:valuebool

The value that configures the indeterminate.

Returns:

CircularProgressBarBuilder

Example:
C#
@(Html.Kendo().CircularProgressBar()
.Name("progressbar")
.Indeterminate(20)
)

Label(string)

The label that would be used as a aria-label for the Circular ProgressBar element. Will be applied only if ariaRole is set to true.

C#
public CircularProgressBarBuilder Label(string value)
Parameters:valuestring

The value that configures the label.

Returns:

CircularProgressBarBuilder

Example:
C#
@(Html.Kendo().CircularProgressBar()
.Name("progressbar")
.Label("label")
)

LabelId(string)

The ID of the element that will be used as a label of the Circular ProgressBar. Will be used as a value of the aria-labelledby attribute. Will be applied only if ariaRole is set to true.

C#
public CircularProgressBarBuilder LabelId(string value)
Parameters:valuestring

The value that configures the labelid.

Returns:

CircularProgressBarBuilder

Example:
C#
@(Html.Kendo().CircularProgressBar()
.Name("progressbar")
.LabelId("LabelId")
)

Opacity(double)

The opacity of the value pointer.

C#
public CircularProgressBarBuilder Opacity(double value)
Parameters:valuedouble

The value that configures the opacity.

Returns:

CircularProgressBarBuilder

Example:
C#
@(Html.Kendo().CircularProgressBar()
.Name("progressbar")
.Opacity(20)
)

PointerWidth(double)

A value indicating how wide will the pointer be

C#
public CircularProgressBarBuilder PointerWidth(double value)
Parameters:valuedouble

The value that configures the pointerwidth.

Returns:

CircularProgressBarBuilder

Example:
C#
@(Html.Kendo().CircularProgressBar()
.Name("progressbar")
.PointerWidth(20)
)

Theme(string)

The gauge theme. This can be either a built-in theme or "sass". When set to "sass" the gauge will read the variables from the Sass-based themes.The supported values are: "sass" - special value, see notes; "black"; "blueopal"; "bootstrap"; "default"; "highcontrast"; "metro"; "metroblack"; "moonlight"; "silver" or "uniform".

C#
public CircularProgressBarBuilder Theme(string value)
Parameters:valuestring

The value that configures the theme.

Returns:

CircularProgressBarBuilder

Example:
C#
@(Html.Kendo().CircularProgressBar()
.Name("progressbar")
.Theme("sylver")
)

Transitions(bool)

A value indicating if transition animations should be played.

C#
public CircularProgressBarBuilder Transitions(bool value)
Parameters:valuebool

The value that configures the transitions.

Returns:

CircularProgressBarBuilder

Example:
C#
@(Html.Kendo().CircularProgressBar()
.Name("progressbar")
.Transitions(20)
)

Value(double)

The component value.

C#
public CircularProgressBarBuilder Value(double value)
Parameters:valuedouble

The value that configures the value.

Returns:

CircularProgressBarBuilder

Example:
C#
@(Html.Kendo().CircularProgressBar()
.Name("progressbar")
.Value(20)
)
In this article
DefinitionConstructorsCircularProgressBarBuilder(CircularProgressBar)MethodsAriaRole(bool)CenterTemplate(string)CenterTemplate<TModel>(TemplateBuilder<TModel>)CenterTemplateHandler(string)CenterTemplateId(string)CenterTemplateView(MvcHtmlString)Color(string)Colors(Action<CircularProgressBarColorFactory>)Indeterminate(bool)Label(string)LabelId(string)Opacity(double)PointerWidth(double)Theme(string)Transitions(bool)Value(double)
Not finding the help you need?
Contact Support