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

RadProgressBar

Class

A control that shows a progress of a task or process in percent, absolute value or discrete steps. Its value can be set on the server, or on the client.

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

[RequiredScript(typeof(jQueryPlugins))]
[RequiredScript(typeof(AnimationFramework))]
[ClientScriptResource("Telerik.Web.UI.RadProgressBar", "Telerik.Web.UI.ProgressBar.RadProgressBarScripts.js")]
[EmbeddedSkin("ProgressBar", typeof(RadProgressBar))]
[EmbeddedSkin("ProgressBar", "Default", typeof(RadProgressBar))]
[ToolboxBitmap(typeof(RadProgressBar), "Toolbox.Icons.ProgressBar.png")]
[TelerikToolboxCategory("Visualization")]
public class RadProgressBar : RadWebControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl

Inheritance: objectControlWebControlRadWebControlRadProgressBar

Implements: IAttributeAccessorIComponentIControlIControlBuilderAccessorIControlDesignerAccessorIControlResolverIDataBindingsAccessorIDisposableIExpressionsAccessorIParserAccessorIPostBackDataHandlerIScriptControlISkinnableControlIUrlResolutionService...

Inherited Members WebControl.AddAttributesToRender(HtmlTextWriter)WebControl.ApplyStyle(Style)WebControl.CopyBaseAttributes(WebControl)WebControl.CreateControlStyle()WebControl.MergeStyle(Style)WebControl.Render(HtmlTextWriter)WebControl.RenderBeginTag(HtmlTextWriter)WebControl.RenderEndTag(HtmlTextWriter)WebControl.AccessKeyWebControl.AttributesWebControl.BackColorWebControl.BorderColorWebControl.BorderWidthWebControl.BorderStyleWebControl.ControlStyleWebControl.ControlStyleCreatedWebControl.CssClassWebControl.DisabledCssClassWebControl.StyleWebControl.EnabledWebControl.EnableThemingWebControl.FontWebControl.ForeColorWebControl.HasAttributesWebControl.HeightWebControl.IsEnabledWebControl.SupportsDisabledAttributeWebControl.SkinIDWebControl.TabIndexWebControl.TagNameWebControl.ToolTipWebControl.WidthControl.ResolveAdapter()Control.HasEvents()Control.GetRouteUrl(object)Control.GetRouteUrl(string, object)Control.GetRouteUrl(RouteValueDictionary)Control.GetRouteUrl(string, RouteValueDictionary)Control.GetUniqueIDRelativeTo(Control)Control.ApplyStyleSheetSkin(Page)Control.OnDataBinding(EventArgs)Control.DataBind()Control.DataBind(bool)Control.DataBindChildren()Control.AddParsedSubObject(object)Control.EnsureID()Control.OnInit(EventArgs)Control.ClearChildState()Control.ClearChildControlState()Control.ClearChildViewState()Control.ClearEffectiveClientIDMode()Control.ClearCachedClientID()Control.Focus()Control.LoadControlState(object)Control.MapPathSecure(string)Control.OpenFile(string)Control.OnLoad(EventArgs)Control.OnPreRender(EventArgs)Control.BuildProfileTree(string, bool)Control.SaveControlState()Control.RenderChildren(HtmlTextWriter)Control.RenderControl(HtmlTextWriter)Control.RenderControl(HtmlTextWriter, ControlAdapter)Control.OnUnload(EventArgs)Control.Dispose()Control.RaiseBubbleEvent(object, EventArgs)Control.OnBubbleEvent(object, EventArgs)Control.AddedControl(Control, int)Control.CreateControlCollection()Control.CreateChildControls()Control.ResolveUrl(string)Control.ResolveClientUrl(string)Control.FindControl(string)Control.FindControl(string, int)Control.GetDesignModeState()Control.HasControls()Control.IsLiteralContent()Control.EnsureChildControls()Control.RemovedControl(Control)Control.SetDesignModeState(IDictionary)Control.SetRenderMethodDelegate(RenderMethod)Control.ClientIDModeControl.ClientIDControl.ClientIDSeparatorControl.ContextControl.AdapterControl.DesignModeControl.EventsControl.IDControl.IsChildControlStateClearedControl.EnableViewStateControl.ViewStateModeControl.IsViewStateEnabledControl.NamingContainerControl.IdSeparatorControl.LoadViewStateByIDControl.PageControl.RenderingCompatibilityControl.TemplateControlControl.ParentControl.TemplateSourceDirectoryControl.AppRelativeTemplateSourceDirectoryControl.SiteControl.VisibleControl.UniqueIDControl.HasChildViewStateControl.ControlsControl.ValidateRequestModeControl.ViewStateControl.ViewStateIgnoresCaseControl.ChildControlsCreatedControl.IsTrackingViewStateControl.DisposedControl.DataBindingControl.InitControl.LoadControl.PreRenderControl.Unloadobject.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()object.GetType()object.MemberwiseClone()...

Constructors

RadProgressBar()

public RadProgressBar()

Properties

AnimationSettings

ProgressBarAnimationSettings

Configures the progress animation settings.

[PersistenceMode(PersistenceMode.InnerProperty)]
public ProgressBarAnimationSettings AnimationSettings { get; }

BarType

ProgressBarType

Specifies the type of RadProgressBar. The supported types are Value, Percent and Chunk.

[ClientControlProperty]
public ProgressBarType BarType { get; set; }

ChunksCount

int

Specifies the number of chunks. Default is 5. This property is applicable only when the type of the ProgressBar is set to chunk.

[ClientControlProperty]
public int ChunksCount { get; set; }

ClientEvents

ProgressBarClientEvents

Defines the client events handlers.

[PersistenceMode(PersistenceMode.InnerProperty)]
public ProgressBarClientEvents ClientEvents { get; }

CssClassFormatString

string

The CssClass property will now be used instead of the former Skin and will be modified in AddAttributesToRender()

protected override string CssClassFormatString { get; }

Overrides: RadWebControl.CssClassFormatString

Example:

protected override string CssClassFormatString
{
       get
       {
           return "RadDock RadDock_{0} rdWTitle rdWFooter";
       }
}

Indeterminate

bool

Specifies if the progress state is Indeterminate.

public bool Indeterminate { get; set; }

Label

string

Specifies if the progress label will be shown.

public string Label { get; set; }

MaxValue

double

Specifies the maximum value of the ProgressBar.

[ClientControlProperty]
public double MaxValue { get; set; }

MinValue

double

Specifies the minimum value of the ProgressBar.

[ClientControlProperty]
public double MinValue { get; set; }

Orientation

ProgressBarOrientation

The orientation of the ProgressBar. Possible values are horizontal and vertical.

[ClientControlProperty]
public ProgressBarOrientation Orientation { get; set; }

ProgressProperty

HtmlTextWriterStyle

protected HtmlTextWriterStyle ProgressProperty { get; }

Reversed

bool

Specifies if the progress direction will be reversed.

[ClientControlProperty]
public bool Reversed { get; set; }

ShowLabel

bool

Specifies if the progress label will be shown.

[ClientControlProperty]
public bool ShowLabel { get; set; }

SupportsRenderingMode

bool

protected override bool SupportsRenderingMode { get; }

Overrides: RadWebControl.SupportsRenderingMode

TagKey

HtmlTextWriterTag

protected override HtmlTextWriterTag TagKey { get; }

Overrides: WebControl.TagKey

Value

double

Specifies the underlying value of the ProgressBar.

public double Value { get; set; }

Methods

LoadPostData(string, NameValueCollection)

Executed when post data is loaded from the request

protected override bool LoadPostData(string postDataKey, NameValueCollection postCollection)

Parameters:postDataKeystringpostCollectionNameValueCollectionReturns:

bool

Overrides: RadWebControl.LoadPostData(string, NameValueCollection)

LoadViewState(object)

protected override void LoadViewState(object state)

Parameters:stateobject

Overrides: WebControl.LoadViewState(object)

RenderContents(HtmlTextWriter)

protected override void RenderContents(HtmlTextWriter writer)

Parameters:writerHtmlTextWriter

Overrides: RadWebControl.RenderContents(HtmlTextWriter)

SaveViewState()

protected override object SaveViewState()

Returns:

object

Overrides: WebControl.SaveViewState()

TrackViewState()

protected override void TrackViewState()

Overrides: WebControl.TrackViewState()