Introduction
Knowledge Base
API Reference / Server-side / Telerik.Web.UI / RadProgressArea
New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

RadProgressArea

Class

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:
C#
[EmbeddedSkin("ProgressArea", typeof(RadProgressArea))]
[EmbeddedSkin("ProgressArea", "Default", typeof(RadProgressArea))]
[RequiredCss("Telerik.Web.UI.Skins.Common.MaterialRipple.css", RenderMode.Lightweight, typeof(RadButton))]
[RequiredScript(typeof(jQueryPlugins))]
[RequiredScript(typeof(MaterialRipple))]
[TelerikToolboxCategory("Upload")]
[ToolboxBitmap(typeof(RadProgressArea), "Toolbox.Icons.ProgressArea.png")]
[ClientScriptResource("Telerik.Web.UI.RadProgressArea", "Telerik.Web.UI.Upload.RadProgressArea.js")]
[RequiredScript(typeof(PopupBehavior))]
public class RadProgressArea : RadWebControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl, INamingContainer

Inheritance: objectControlWebControlRadWebControlRadProgressArea

Implements: IAttributeAccessorIComponentIControlIControlBuilderAccessorIControlDesignerAccessorIControlResolverIDataBindingsAccessorIDisposableIExpressionsAccessorINamingContainerIParserAccessorIPostBackDataHandlerIScriptControlISkinnableControlIUrlResolutionService...

Inherited Members WebControl.AddAttributesToRender(HtmlTextWriter)WebControl.ApplyStyle(Style)WebControl.CopyBaseAttributes(WebControl)WebControl.CreateControlStyle()WebControl.LoadViewState(object)WebControl.TrackViewState()WebControl.MergeStyle(Style)WebControl.RenderBeginTag(HtmlTextWriter)WebControl.RenderEndTag(HtmlTextWriter)WebControl.SaveViewState()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(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.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

RadProgressArea()

C#
public RadProgressArea()

Fields

CancelButtonName

C#
public static readonly string CancelButtonName

CurrentOperationName

C#
public static readonly string CurrentOperationName

PrimaryPercentName

C#
public static readonly string PrimaryPercentName

PrimaryProgressBarElement

C#
public static readonly string PrimaryProgressBarElement

PrimaryProgressElement

C#
public static readonly string PrimaryProgressElement

PrimaryTotalName

C#
public static readonly string PrimaryTotalName

PrimaryValueName

C#
public static readonly string PrimaryValueName

ProgressAreaHeader

C#
public static readonly string ProgressAreaHeader

SecondaryPercentName

C#
public static readonly string SecondaryPercentName

SecondaryProgressBarElement

C#
public static readonly string SecondaryProgressBarElement

SecondaryProgressElement

C#
public static readonly string SecondaryProgressElement

SecondaryTotalName

C#
public static readonly string SecondaryTotalName

SecondaryValueName

C#
public static readonly string SecondaryValueName

SpeedName

C#
public static readonly string SpeedName

TimeElapsedName

C#
public static readonly string TimeElapsedName

TimeEstimatedName

C#
public static readonly string TimeEstimatedName

Properties

CssClassFormatString

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

C#
protected override string CssClassFormatString { get; }

Overrides: RadWebControl.CssClassFormatString

Example:
C#
protected override string CssClassFormatString
{
       get
       {
           return "RadDock RadDock_{0} rdWTitle rdWFooter";
       }
}

Culture

Gets or sets the selected culture. Localization strings will be loaded based on this value.

C#
public CultureInfo Culture { get; set; }
Property Value:

The culture.

DisplayCancelButton

Gets or sets the value indicating whether the Cancel button should be visible.

C#
[Bindable(true)]
public bool DisplayCancelButton { get; set; }
Property Value:

The display cancel button.

HeaderText

Specifies the Text that is displayed in the header area of RadProgressArea.

C#
public string HeaderText { get; set; }
Property Value:

The header text.

isInDesignMode

C#
protected bool isInDesignMode { get; }

Language

Specifies the localization of the RadProgressArea (the language which will be used).

C#
[Browsable(true)]
[Bindable(true)]
[Obsolete("Use the Culture property")]
public string Language { get; set; }
Property Value:

The default value is en-US.

Example:
cs-api-definition
<radU:RadUpload Language="es-Es" ... />

Localization

Gets the localization.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public ProgressAreaStrings Localization { get; }
Property Value:

The localization.

LocalizationPath

Gets or sets a value indicating where RadProgressArea will look for its .resx localization files.

C#
public string LocalizationPath { get; set; }
Property Value:

The localization path.

OnClientProgressBarUpdating

Specifies the client-side function to be executed when a progress bar is about to be updated.

C#
[PersistenceMode(PersistenceMode.Attribute)]
[Bindable(true)]
[ClientControlEvent]
[ClientPropertyName("progressBarUpdating")]
public string OnClientProgressBarUpdating { get; set; }
Property Value:

The default value is string.Empty.

OnClientProgressUpdating

Specifies the client-side function to be executed when the Progress Area status is about to be updated.

C#
[PersistenceMode(PersistenceMode.Attribute)]
[Bindable(true)]
[ClientControlEvent]
[ClientPropertyName("progressUpdating")]
public string OnClientProgressUpdating { get; set; }
Property Value:

The default value is string.Empty.

Example:
cs-api-definition
<radU:RadProgressArea OnClientProgressUpdating="myOnClientProgressUpdating" ... />
...
<script>
function myOnClientProgressUpdating()
{
alert("The progress will be updated");
}
</script>

ProgressIndicators

Gets or sets the progress indicators.

C#
[Bindable(true)]
public ProgressIndicators ProgressIndicators { get; set; }
Property Value:

The progress indicators.

ProgressTemplate

Gets or sets the progress template.

C#
[Browsable(false)]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TemplateContainer(typeof(ProgressPanel))]
public ITemplate ProgressTemplate { get; set; }
Property Value:

The progress template.

SupportsRenderingMode

C#
protected override bool SupportsRenderingMode { get; }

Overrides: RadWebControl.SupportsRenderingMode

TagKey

Provides access to the localization strings of the control.

C#
protected override HtmlTextWriterTag TagKey { get; }
Property Value:

Localization name/value collection.

Overrides: WebControl.TagKey

This property is intended to be used when there is a need to access the localization strings of the control from the code behind.

Example:
cs-api-definition
RadProgressArea1.Localization["CancelButton"] = "Cancel";
RadProgressArea1.Localization["ElapsedTime"] = "Elapsed time: ";
RadProgressArea1.Localization["EstimatedTime"] = "Estimated time: ";
RadProgressArea1.Localization["TransferSpeed"] = "Speed: ";
RadProgressArea1.Localization["CurrentFileName"] = "Uploading file: ";
RadProgressArea1.Localization["Uploaded"] = "Uploaded ";
RadProgressArea1.Localization["UploadedFiles"] = "Uploaded files: ";
RadProgressArea1.Localization["Total"] = "Total ";
RadProgressArea1.Localization["TotalFiles"] = "Total files: ";

Methods

CreateChildControls()

C#
protected override void CreateChildControls()

Overrides: Control.CreateChildControls()

DataBind()

Binds a data source to the invoked server control and all its child controls.

C#
public override void DataBind()

Overrides: Control.DataBind()

DescribeClientEvents(IScriptDescriptor)

C#
protected override void DescribeClientEvents(IScriptDescriptor descriptor)
Parameters:descriptorIScriptDescriptor

Overrides: RadWebControl.DescribeClientEvents(IScriptDescriptor)

DescribeClientProperties(IScriptDescriptor)

C#
protected override void DescribeClientProperties(IScriptDescriptor descriptor)
Parameters:descriptorIScriptDescriptor

Overrides: RadWebControl.DescribeClientProperties(IScriptDescriptor)

DescribeComponent(IScriptDescriptor)

C#
protected override void DescribeComponent(IScriptDescriptor descriptor)
Parameters:descriptorIScriptDescriptor

Overrides: RadWebControl.DescribeComponent(IScriptDescriptor)

Render(HtmlTextWriter)

C#
protected override void Render(HtmlTextWriter writer)
Parameters:writerHtmlTextWriter

Overrides: RadWebControl.Render(HtmlTextWriter)

RenderContents(HtmlTextWriter)

C#
protected override void RenderContents(HtmlTextWriter writer)
Parameters:writerHtmlTextWriter

Overrides: RadWebControl.RenderContents(HtmlTextWriter)

In this article
DefinitionConstructorsRadProgressArea()FieldsCancelButtonNameCurrentOperationNamePrimaryPercentNamePrimaryProgressBarElementPrimaryProgressElementPrimaryTotalNamePrimaryValueNameProgressAreaHeaderSecondaryPercentNameSecondaryProgressBarElementSecondaryProgressElementSecondaryTotalNameSecondaryValueNameSpeedNameTimeElapsedNameTimeEstimatedNamePropertiesCssClassFormatStringCultureDisplayCancelButtonHeaderTextisInDesignModeLanguageLocalizationLocalizationPathOnClientProgressBarUpdatingOnClientProgressUpdatingProgressIndicatorsProgressTemplateSupportsRenderingModeTagKeyMethodsCreateChildControls()DataBind()DescribeClientEvents(IScriptDescriptor)DescribeClientProperties(IScriptDescriptor)DescribeComponent(IScriptDescriptor)Render(HtmlTextWriter)RenderContents(HtmlTextWriter)
Not finding the help you need?
Contact Support