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

RadProgressManager control

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

C#
[TelerikToolboxCategory("Upload")]
[ToolboxBitmap(typeof(RadProgressManager), "Toolbox.Icons.Upload.png")]
[ClientScriptResource("Telerik.Web.UI.RadProgressManager", "Telerik.Web.UI.Upload.RadProgressManager.js")]
[EmbeddedSkin("Upload", typeof(RadUpload))]
[EmbeddedSkin("Upload", "Default", typeof(RadUpload))]
public class RadProgressManager : RadWebControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl

Inheritance: objectControlWebControlRadWebControlRadProgressManager

Implements: IAttributeAccessorIComponentIControlIControlBuilderAccessorIControlDesignerAccessorIControlResolverIDataBindingsAccessorIDisposableIExpressionsAccessorIParserAccessorIPostBackDataHandlerIScriptControlISkinnableControlIUrlResolutionService...

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

C#
public RadProgressManager()

Properties

Gets or sets the URL which the AJAX calls will be made to. Check the help for more information.

C#
[PersistenceMode(PersistenceMode.Attribute)]
[Bindable(true)]
public string AjaxUrl { get; set; }
Property Value:

The ajax URL.

Gets or sets the value, indicating whether to render the link to the embedded base stylesheet of the control or not.

C#
[Browsable(false)]
public override bool EnableEmbeddedBaseStylesheet { get; }

Overrides: RadWebControl.EnableEmbeddedBaseStylesheet

If EnableEmbeddedBaseStylesheet is set to false you will have to register the needed control base CSS file by hand.

Gets or sets the value, indicating whether to render links to the embedded skins or not.

C#
[Browsable(false)]
public override bool EnableEmbeddedSkins { get; }

Overrides: RadWebControl.EnableEmbeddedSkins

If EnableEmbeddedSkins is set to false you will have to register the needed CSS files by hand.

Deprecated. Memory optimization is implemented as part of the .NET Framework and is no longer a feature of RadUpload.

C#
[Bindable(true)]
[Obsolete("Memory optimization is implemented as part of the .NET Framework and is no longer a feature of RadUpload", false)]
public bool EnableMemoryOptimization { get; set; }

RadProgressManager's FormId property is not used anymore. Please, remove any assignments.

C#
[Obsolete("RadProgressManager's FormId property is not used anymore. Please, remove any assignments.", false)]
public string FormId { get; }

Gets or sets the OnClientProgressStarted event value in the ViewState.

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

The on client progress started.

Gets or sets the OnClientProgressUpdating event value in the ViewState.

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

The on client progress updating.

Gets or sets the OnClientSubmitting event value in the ViewState.

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

The on client submitting.

Gets or sets the period (in milliseconds) of the progress data refresh.

C#
[ClientControlProperty]
[PersistenceMode(PersistenceMode.Attribute)]
[Bindable(true)]
public int RefreshPeriod { get; set; }
Property Value:

The period of the progress data refresh in milliseconds. The default value is 500.

The refresh period might not be exactly the same as the value specified if the AJAX request has not been completed before the upload. The minimum value is 50 ms.

Note: If the value is very low (50ms) both the client CPU and server CPU load would increase because of the increased number of AJAX requests performed.

Gets or sets the register for submit.

C#
[PersistenceMode(PersistenceMode.Attribute)]
[Bindable(true)]
[ClientControlProperty]
[ClientPropertyName("shouldRegisterForSubmit")]
public bool RegisterForSubmit { get; set; }
Property Value:

The register for submit.

Gets or sets a value indicating whether an error message will be displayed when the RadUploadHttpModule is not registered.

C#
[PersistenceMode(PersistenceMode.Attribute)]
[Bindable(true)]
[ClientControlProperty]
[ClientPropertyName("suppressMissingHttpModuleError")]
public bool SuppressMissingHttpModuleError { get; set; }

Methods

Adds RadUrid=[GUID] parameter to the supplied URL.

C#
public string ApplyUniquePageIdentifier(string url)
Parameters:urlstringReturns:

string

Use this method to generate proper URL for cross page postbacks which will enable RadMemoryOptimization and RadProgressArea.

Example:
cs-api-definition
Button1.PostBackUrl = RadProgressManager1.ApplyUniquePageIdentifier(Request.Url.PathAndQuery)
C#
protected override void DescribeClientEvents(IScriptDescriptor descriptor)
Parameters:descriptorIScriptDescriptor

Overrides: RadWebControl.DescribeClientEvents(IScriptDescriptor)

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

Overrides: RadWebControl.DescribeClientProperties(IScriptDescriptor)

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

Overrides: RadWebControl.DescribeComponent(IScriptDescriptor)

C#
protected override void OnPreRender(EventArgs e)
Parameters:eEventArgs

Overrides: RadWebControl.OnPreRender(EventArgs)