Documentation for: ASP.NET Ajax Version 1.0

This documentation is for a previous version. For the current released version, see the ASP.NET Ajax documentation on MSDN.

 

 

 

 

 

 

 

UpdateProgress Class

Provides visual feedback on the browser when the contents of one or more UpdatePanel controls are updated.

Syntax

CSharp

[PersistChildrenAttribute(false)]
[ParseChildrenAttribute(true)]
[DefaultPropertyAttribute("AssociatedUpdatePanelID")]
[DesignerAttribute("System.Web.UI.Design.UpdateProgressDesigner, System.Web.Extensions.Design, Version=1.0.61025.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35")]
[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
public class UpdateProgress : Control, IScriptControl

VisualBasic

<PersistChildrenAttribute(False)> _
<ParseChildrenAttribute(True)> _
<DefaultPropertyAttribute("AssociatedUpdatePanelID")> _
<DesignerAttribute("System.Web.UI.Design.UpdateProgressDesigner, System.Web.Extensions.Design, Version=1.0.61025.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35")> _
<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
Public Class UpdateProgress _
	Inherits Control _
	Implements IScriptControl

ManagedCPlusPlus

[PersistChildrenAttribute(false)]
[ParseChildrenAttribute(true)]
[DefaultPropertyAttribute(L"AssociatedUpdatePanelID")]
[DesignerAttribute(L"System.Web.UI.Design.UpdateProgressDesigner, System.Web.Extensions.Design, Version=1.0.61025.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35")]
[AspNetHostingPermissionAttribute(SecurityAction::LinkDemand, Level = AspNetHostingPermissionLevel::Minimal)]
[AspNetHostingPermissionAttribute(SecurityAction::InheritanceDemand, Level = AspNetHostingPermissionLevel::Minimal)]
public ref class UpdateProgress : public Control, IScriptControl

JSharp

/** @attribute PersistChildrenAttribute(false) */
/** @attribute ParseChildrenAttribute(true) */
/** @attribute DefaultPropertyAttribute("AssociatedUpdatePanelID") */
/** @attribute DesignerAttribute("System.Web.UI.Design.UpdateProgressDesigner, System.Web.Extensions.Design, Version=1.0.61025.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35") */
/** @attribute AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal) */
/** @attribute AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal) */
public class UpdateProgress extends Control implements IScriptControl

Members

IconMemberDescription
UpdateProgressNew()Initializes a new instance of the UpdateProgress class.
AdapterGets the browser-specific adapter for the control. (Inherited from Control.)
AddedControl(Control, Int32)Called after a child control is added to the Controls collection of the Control object. (Inherited from Control.)
AddParsedSubObject(Object)Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object. (Inherited from Control.)
ApplyStyleSheetSkin(Page)Applies the style properties defined in the page style sheet to the control. (Inherited from Control.)
AppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.)
AssociatedUpdatePanelIDGets or sets the ID of the UpdatePanel control that the UpdateProgress control displays status for.
BindingContainerGets the control that contains this control's data binding. (Inherited from Control.)
BuildProfileTree(String, Boolean)Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control.)
ChildControlsCreatedGets a value that indicates whether the server control's child controls have been created. (Inherited from Control.)
ClearChildControlState()Deletes the control-state information for the server control's child controls. (Inherited from Control.)
ClearChildState()Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.)
ClearChildViewState()Deletes the view-state information for all the server control's child controls. (Inherited from Control.)
ClientIDGets the server control identifier generated by ASP.NET. (Inherited from Control.)
ClientIDSeparatorGets a character value representing the separator character used in the ClientID property. (Inherited from Control.)
ContextGets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.)
ControlsGets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from Control.)
CreateChildControls()Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering. (Inherited from Control.)
CreateControlCollection()Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control.)
DataBind()Binds a data source to the invoked server control and all its child controls. (Inherited from Control.)
DataBind(Boolean)Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control.)
DataBindChildren()Binds a data source to the server control's child controls. (Inherited from Control.)
DataBindingOccurs when the server control binds to a data source. (Inherited from Control.)
DesignModeGets a value indicating whether a control is being used on a design surface. (Inherited from Control.)
DisplayAfterGets or sets the value in milliseconds before the UpdateProgress control is displayed.
Dispose()Enables a server control to perform final clean up before it is released from memory. (Inherited from Control.)
DisposedOccurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from Control.)
DynamicLayoutGets or sets a value that determines whether the progress template is rendered dynamically.
EnableThemingGets or sets a value indicating whether themes apply to this control. (Inherited from Control.)
EnableViewStateGets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from Control.)
EnsureChildControls()Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.)
EnsureID()Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control.)
Equals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
EventsGets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.)
Finalize()Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
FindControl(String)Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.)
FindControl(String, Int32)Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the method. (Inherited from Control.)
Focus()Sets input focus to a control. (Inherited from Control.)
GetDesignModeState()Gets design-time data for a control. (Inherited from Control.)
GetHashCode()Serves as a hash function for a particular type. (Inherited from Object.)
GetScriptDescriptors()Returns a list of components, behaviors, and client controls that are required for the UpdateProgress control's client functionality.
GetScriptReferences()Returns a list of client script library dependencies for the UpdateProgress control.
GetType()Gets the Type of the current instance. (Inherited from Object.)
HasChildViewStateGets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.)
HasControls()Determines if the server control contains any child controls. (Inherited from Control.)
HasEvents()Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.)
IDGets or sets the programmatic identifier assigned to the server control. (Inherited from Control.)
IdSeparatorGets the character used to separate control identifiers. (Inherited from Control.)
InitOccurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.)
IsChildControlStateClearedGets a value indicating whether controls contained within this control have control state. (Inherited from Control.)
IsLiteralContent()Determines if the server control holds only literal content. (Inherited from Control.)
IsTrackingViewStateGets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.)
IsViewStateEnabledGets a value indicating whether view state is enabled for this control. (Inherited from Control.)
LoadOccurs when the server control is loaded into the Page object. (Inherited from Control.)
LoadControlState(Object)Restores control-state information from a previous page request that was saved by the SaveControlState() method. (Inherited from Control.)
LoadViewState(Object)Restores view-state information from a previous page request that was saved by the SaveViewState() method. (Inherited from Control.)
LoadViewStateByIDGets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.)
MapPathSecure(String)Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.)
MemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
NamingContainerGets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. (Inherited from Control.)
OnBubbleEvent(Object, EventArgs)Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.)
OnDataBinding(EventArgs)Raises the DataBinding event. (Inherited from Control.)
OnInit(EventArgs)Raises the Init event. (Inherited from Control.)
OnLoad(EventArgs)Raises the Load event. (Inherited from Control.)
OnPreRender(EventArgs)Raises the PreRender event. (Overrides Control.OnPreRender(EventArgs).)
OnUnload(EventArgs)Raises the Unload event. (Inherited from Control.)
OpenFile(String)Gets a Stream used to read a file. (Inherited from Control.)
PageGets a reference to the Page instance that contains the server control. (Inherited from Control.)
ParentGets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.)
PreRenderOccurs after the Control object is loaded but prior to rendering. (Inherited from Control.)
ProgressTemplateGets or sets the template that defines the content of the UpdateProgress control.
RaiseBubbleEvent(Object, EventArgs)Assigns any sources of the event and its information to the control's parent. (Inherited from Control.)
RemovedControl(Control)Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control.)
Render(HtmlTextWriter)Raises the Render(HtmlTextWriter) event. (Overrides Control.Render(HtmlTextWriter).)
RenderChildren(HtmlTextWriter)Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control.)
RenderControl(HtmlTextWriter)Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control.)
RenderControl(HtmlTextWriter, ControlAdapter)Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.)
ResolveAdapter()Gets the control adapter responsible for rendering the specified control. (Inherited from Control.)
ResolveClientUrl(String)Gets a URL that can be used by the browser. (Inherited from Control.)
ResolveUrl(String)Converts a URL into one that is usable on the requesting client. (Inherited from Control.)
SaveControlState()Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.)
SaveViewState()Saves any server control view-state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.)
SetDesignModeState(IDictionary)Sets design-time data for a control. (Inherited from Control.)
SetRenderMethodDelegate(RenderMethod)Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.)
SiteGets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.)
SkinIDGets or sets the skin to apply to the control. (Inherited from Control.)
TemplateControlGets or sets a reference to the template that contains this control. (Inherited from Control.)
TemplateSourceDirectoryGets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.)
ToString()Returns a String that represents the current Object. (Inherited from Object.)
TrackViewState()Causes tracking of view-state changes to the server control so they can be stored in the server control's StateBag object. This object is accessible through the ViewState property. (Inherited from Control.)
UniqueIDGets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.)
UnloadOccurs when the server control is unloaded from memory. (Inherited from Control.)
ViewStateGets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from Control.)
ViewStateIgnoresCaseGets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.)
VisibleGets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.)

Remarks

The UpdateProgress control enables you to provide feedback on the progress of partial-page rendering. For postbacks or initial page rendering, UpdateProgress control content is not displayed. There can be many UpdateProgress controls on a page, each associated with a different UpdatePanel control. Alternatively, you can use one UpdateProgress control and associate it with all the UpdatePanel controls on the page. The UpdateProgress control renders a <div> element that is displayed or hidden depending on where a postback originates and whether the AssociatedUpdatePanelID property of the UpdateProgress is set.

Associating an UpdateProgress with an UpdatePanel

You associate UpdateProgress controls with an UpdatePanel control by setting the AssociatedUpdatePanelID property of the UpdateProgress control. When a postback event originates from inside an UpdatePanel control, any associated UpdateProgress controls are displayed. If you do not set the AssociatedUpdatePanelID property, the UpdateProgress control displays progress for any asynchronous postback that originates from inside any UpdatePanel or for controls that are triggers for panels.

The AssociatedUpdatePanelID property has the following effect on UpdateProgress control behavior:

  • When the AssociatedUpdatePanelID property is not set, the UpdateProgress is displayed for the following postbacks:

    • Postbacks that originate from inside any UpdatePanel control.

    • Postbacks that originate from controls that are asynchronous triggers for any UpdatePanel control.

  • When the AssociatedUpdatePanelID property is set to an UpdatePanel control ID, the UpdateProgress control is displayed for postbacks that originate from inside the associated UpdatePanel control.

If the AssociatedUpdatePanelID property is set to a control that does not exist, the UpdateProgress will never be shown.

If the ChildrenAsTriggers property of the UpdatePanel is set to false and a postback originates from inside an UpdatePanel, any associated UpdateProgress controls will still be displayed.

Specifying the Content of the UpdateProgress Control

Use the ProgressTemplate property to specify the message that is displayed by an UpdateProgress control. If the ProgressTemplate property is empty, nothing will be shown when the UpdateProgress control is displayed.

The template can contain HTML and markup. For example, you could show an animated image that notifies the user that the postback is processing and a button that the user can click to stop the partial-page update. Additionally, you might want to prevent all other postbacks while one is in progress. The following example shows client script you can use to accomplish these tasks.

CS

var prm = Sys.WebForms.PageRequestManager.getInstance();
prm.add_initializeRequest(InitializeRequest);
function InitializeRequest(sender, args) {
  if (prm.get_isInAsyncPostBack())
   {
      args.set_cancel(true);
   }
}
function AbortPostBack() {
  if (prm.get_isInAsyncPostBack()) {
       prm.abortPostBack();
  }        
}

VB

var prm = Sys.WebForms.PageRequestManager.getInstance();
prm.add_initializeRequest(InitializeRequest);
function InitializeRequest(sender, args) {
  if (prm.get_isInAsyncPostBack())
   {
      args.set_cancel(true);
   }
}
function AbortPostBack() {
  if (prm.get_isInAsyncPostBack()) {
       prm.abortPostBack();
  }        
}

You can use the example code by setting the onClick attribute of an HtmlButton control to "AbortPostBack()". For more information, see the abortPostBack method and the isInAsyncPostBack property of the PageRequestManager class.

Placing UpdateProgress Controls on the Page

UpdateProgress controls can be either inside or outside other UpdatePanel controls. The display of the UpdateProgress control's template does not depend on where the UpdateProgress control is located. In a nested UpdatePanel control where a child panel is inside a parent panel, a postback that originates from inside the child panel will cause all UpdateProgress controls associated with the child panel and the parent panel to be displayed. If a postback originates from an immediate child control of the parent panel, only the UpdateProgress controls associated with the parent panel are displayed.

Customizing When UpdateProgress Controls Are Displayed

If you need finer control over when an UpdateProgress control is displayed, you must provide client script for the beginRequest and endRequest events of the PageRequestManager class. In the beginRequest event handler, display the DOM element that represents the UpdateProgress control, and in the endRequest event handler, hide it.

In the following example scenarios, you must provide client script to show an UpdateProgress control when a target UpdatePanel is updated:

  • When a postback from a control is registered as an asynchronous postback trigger for the panel, and there is an UpdateProgress control on the page but its AssociatedUpdatePanelID property is not set to the panel's ID.

  • When postbacks from controls are registered as asynchronous postback controls by using the RegisterAsyncPostBackControl(Control) method of the ScriptManager control.

Examples

The following examples demonstrate different ways of using the UpdateProgress control to show progress during asynchronous postbacks.

The following example demonstrates one UpdateProgress control that shows progress status for two UpdatePanel controls.

This following example demonstrates two UpdateProgress controls. Each control shows progress status for an associated UpdatePanel control.

The following example demonstrates how to let the user stop an asynchronous postback when using an UpdateProgress control.

Permissions

  • AspNetHostingPermission

    for operating in a hosted environment. Demand value: LinkDemand. Permission value: Minimal.

  • AspNetHostingPermission

    for operating in a hosted environment. Demand value: InheritanceDemand. Permission value: Minimal.

Inheritance Hierarchy

Object

Assembly: System.Web.Extensions (Module: System.Web.Extensions)