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

ProgressBarBuilder

Class

Define the fluent interface for configuring the ProgressBar component.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class ProgressBarBuilder : WidgetBuilderBase<ProgressBar, ProgressBarBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<ProgressBar, ProgressBarBuilder>ProgressBarBuilder

Implements: IHtmlString

Constructors

ProgressBarBuilder(ProgressBar)

Initializes a new instance of the ProgressBarBuilder class.

public ProgressBarBuilder(ProgressBar component)

Parameters:componentProgressBar

The component.

Example:

@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Animation(false)
)

Methods

Animation(Action<ProgressBarAnimationBuilder>)

Configures the animation effects.

public ProgressBarBuilder Animation(Action<ProgressBarAnimationBuilder> animationAction)

Parameters:animationActionAction<ProgressBarAnimationBuilder>

The action which configures the animation effects.

Returns:

ProgressBarBuilder

Example:

@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Animation(a =&gt; a.Duration(200))
)

Animation(bool)

Use to enable or disable the animation.

public ProgressBarBuilder Animation(bool enable)

Parameters:enablebool

The boolean value.

Returns:

ProgressBarBuilder

Example:

@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Animation(false)
)

AriaRole()

If the options is added, the ProgressBar will have its "role" attribute set to "progressbar". It will also render its "aria-valuemin", "aria-valuemax", and "aria-valuenow" attributes.

public ProgressBarBuilder AriaRole()

Returns:

ProgressBarBuilder

Example:

@( Html.Kendo().ProgressBar()
.Name("progressBar")
.AriaRole()
)

AriaRole(bool)

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

public ProgressBarBuilder AriaRole(bool value)

Parameters:valuebool

The value for AriaRole

Returns:

ProgressBarBuilder

Example:

@( Html.Kendo().ProgressBar()
.Name("progressBar")
.AriaRole(false)
)

ChunkCount(int)

Sets the number of chunks to which the ProgressBar will be divided (applies only when type is "chunk")

public ProgressBarBuilder ChunkCount(int count)

Parameters:countint

The number of chunks

Returns:

ProgressBarBuilder

Example:

@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Type(ProgressBarType.Chunk)
.ChunkCount(10)
)

Enable(bool)

Enables or disables the component

public ProgressBarBuilder Enable(bool value)

Parameters:valuebool

true if the component should be enabled, false otherwise; the default is true.

Returns:

ProgressBarBuilder

Example:

@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Enable(false)
)

Events(Action<ProgressBarEventBuilder>)

Configures the client-side events

public ProgressBarBuilder Events(Action<ProgressBarEventBuilder> configurator)

Parameters:configuratorAction<ProgressBarEventBuilder>

The client events configuration action.

Returns:

ProgressBarBuilder

Example:

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

Label(string)

The label that must be used as an "aria-label" for the ProgressBar element. It will be applied only if the AriaRole() option is enabled.

public ProgressBarBuilder Label(string value)

Parameters:valuestring

The value of the label.

Returns:

ProgressBarBuilder

Example:

@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Label("value")
.AriaRole()
)

LabelId(string)

The ID of the element that will be used as a label of the ProgressBar. It will be used as a value of the "aria-labelledby" attribute and will be applied only if the AriaRole() option is enabled.

public ProgressBarBuilder LabelId(string value)

Parameters:valuestring

The value for the LabelId option.

Returns:

ProgressBarBuilder

Example:

@( Html.Kendo().ProgressBar()
.Name("progressBar")
.LabelId("value")
.AriaRole()
)

Max(double)

Sets the maximum value of the ProgressBar

public ProgressBarBuilder Max(double value)

Parameters:valuedouble

Number specifying the maximum value

Returns:

ProgressBarBuilder

Example:

@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Max(200)
)

Min(double)

Sets the minimum value of the ProgressBar

public ProgressBarBuilder Min(double value)

Parameters:valuedouble

Number specifying the minimum value

Returns:

ProgressBarBuilder

Example:

@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Min(50)
)

Orientation(ProgressBarOrientation)

Sets the orientation of the ProgressBar

public ProgressBarBuilder Orientation(ProgressBarOrientation orientation)

Parameters:orientationProgressBarOrientation

ProgressBarOrientation enumeration specifying the orientation

Returns:

ProgressBarBuilder

Example:

@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Orientation(ProgressBarOrientation.Vertical)
)

Reverse(bool)

Specifies if the ProgressBar direction will be reversed

public ProgressBarBuilder Reverse(bool value)

Parameters:valuebool

The boolean value

Returns:

ProgressBarBuilder

Example:

@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Reverse(true)
)

ShowStatus(bool)

Specifies if the Progress status will be displayed

public ProgressBarBuilder ShowStatus(bool value)

Parameters:valuebool

The boolean value

Returns:

ProgressBarBuilder

Example:

@( Html.Kendo().ProgressBar()
.Name("progressBar")
.ShowStatus(false)
)

Type(ProgressBarType)

Specifies the type of the ProgressBar

public ProgressBarBuilder Type(ProgressBarType type)

Parameters:typeProgressBarType

ProgressBarType enumeration specifying the type

Returns:

ProgressBarBuilder

Example:

@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Type(ProgressBarType.Percent)
)

Value(bool)

Sets the initial value of the ProgressBar

public ProgressBarBuilder Value(bool value)

Parameters:valuebool

Pass false to set indeterminate value

Returns:

ProgressBarBuilder

Example:

@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Min(100)
.Max(200)
.Value(false)
)

Value(double)

Sets the initial value of the ProgressBar

public ProgressBarBuilder Value(double value)

Parameters:valuedouble

Number specifying the value

Returns:

ProgressBarBuilder

Example:

@( Html.Kendo().ProgressBar()
.Name("progressBar")
.Min(100)
.Max(200)
.Value(100)
)