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

ProgressBar

Class

Definition

Namespace:Kendo.Mvc.UI

Assembly:Kendo.Mvc.dll

Syntax:

public class ProgressBar : WidgetBase, IWidget, IHtmlAttributesContainer, IScriptableComponent

Inheritance: objectWidgetBaseProgressBar

Implements: IHtmlAttributesContainerIScriptableComponentIWidget

Inherited Members WidgetBase.Render()WidgetBase.VerifySettings()WidgetBase.ToHtmlString()WidgetBase.GetHtml(bool)WidgetBase.GetInitializator()WidgetBase.WriteLicensingScript(TextWriter)WidgetBase.SerializeSettings()WidgetBase.WriteDeferredStyles(TextWriter)WidgetBase.DeferStyles()WidgetBase.ToClientTemplate()WidgetBase.WriteTrialMessage(HtmlTextWriter)WidgetBase.InitializerWidgetBase.EventsWidgetBase.NameWidgetBase.IdWidgetBase.ShouldSanitezeIdWidgetBase.ModelMetadataWidgetBase.HtmlAttributesWidgetBase.ScriptAttributesWidgetBase.ViewContextWidgetBase.ViewDataWidgetBase.IsSelfInitializedWidgetBase.IsInClientTemplateWidgetBase.HasDeferredInitializationWidgetBase.SelectorWidgetBase.HasClientComponentobject.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

ProgressBar(ViewContext, IJavaScriptInitializer)

Initializes a new instance of the ProgressBar class.

public ProgressBar(ViewContext viewContext, IJavaScriptInitializer initializer)

Parameters:viewContextViewContext

The view context.

initializerIJavaScriptInitializer

The javascript initializer.

Properties

Animation

ProgressBarAnimation

Defines the ProgressBar animation

public ProgressBarAnimation Animation { get; }

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 bool? AriaRole { get; set; }

ChunkCount

int?

Gets or sets the number of chunks when the type of the Progressbar is set to "chunk"

public int? ChunkCount { get; set; }

Enable

bool

Gets or sets a value indicating whether the component is enabled

public bool Enable { get; set; }

Property Value:

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

Label

string

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

public string Label { get; set; }

LabelId

string

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

public string LabelId { get; set; }

Max

double?

Gets or sets the maximum value of the ProgressBar

public double? Max { get; set; }

Min

double?

Gets or sets the minimum value of the ProgressBar

public double? Min { get; set; }

Orientation

ProgressBarOrientation?

Gets or sets the orientation of the ProgressBar

public ProgressBarOrientation? Orientation { get; set; }

Reverse

bool

Specifies if the progress direction should be reversed

public bool Reverse { get; set; }

ShowStatus

bool

Specifies if the progress status should be displayed

public bool ShowStatus { get; set; }

Type

ProgressBarType?

Gets or sets the type of the ProgressBar

public ProgressBarType? Type { get; set; }

Value

object

Gets or sets the current value of the ProgressBar

public object Value { get; set; }

Methods

Serialize()

public override IDictionary<string, object> Serialize()

Returns:

IDictionary<string, object>

Overrides: WidgetBase.Serialize()

WriteHtml(HtmlTextWriter)

Writes the ProgressBar HTML.

protected override void WriteHtml(HtmlTextWriter writer)

Parameters:writerHtmlTextWriter

The writer object.

Overrides: WidgetBase.WriteHtml(HtmlTextWriter)

WriteInitializationScript(TextWriter)

Writes the initialization script

public override void WriteInitializationScript(TextWriter writer)

Parameters:writerTextWriter

The writer object.

Overrides: WidgetBase.WriteInitializationScript(TextWriter)