RadProgressArea for ASP.NET AJAX

RadControls for ASP.NET AJAX

The following table lists the important methods of the RadProgressArea client object:

 

Name

Parameters

Return Type

Description

cancelRequest

none

none

Cancels the current request by refreshing the page.

Note

method works only when the page is being submitted.

CopyJavaScript
 
    $find("<%= RadProgressArea1.ClientID %>").cancelRequest();

 

show

none

none

Displays the RadProgressArea dialog.

CopyASPX
<telerik:radprogressarea runat="server" id="RadProgressArea1" />
<input type="button" value="Show" onclick="myShow()" /><script type="text/javascript">                                                               function myShow() { $find("<%= RadProgressArea1.ClientID %>").show(); }</script>
 

hide

none

none

Hides the RadProgressArea dialog.

CopyASPX
<telerik:radprogressarea runat="server" id="RadProgressArea1" />
<input type="button" value="Hide" onclick="hideDialog()" /><script type="text/javascript">                                                                   function hideDialog() { $find("<%= RadProgressArea1.ClientID %>").hide(); }</script>
 

update

progressData

none

Updates the RadProgressArea with the specified information and causes the OnClientProgressUpdating event to fire. If the RadProgressArea is hidden, this method shows it by calling the show() method.

CopyJavaScript
 

function myUpdate() { 
    var progressData =   {     
        PrimaryPercent : 10,    
        PrimaryTotal : '50kB',   
        PrimaryValue : '5kB',  
        SecondaryPercent : 50,   
        SecondaryTotal : '20kB',  
        SecondaryValue : '10kB',   
        CurrentOperationText : 'c:\\test.jpg',  
        TimeElapsed : '5seconds',   
        TimeEstimated : '10seconds',   
        TransferSpeed : '100kB/second' 
    }
    find("<%= RadProgressArea1.ClientID %>").update(progressData);
}        
 

updateVerticalProgressBar

HTML element, integer

none

Updates the height of the progress bar element passed as the first parameter to represent the percentage specified by the second parameter. This method is intended for implementing an OnClientProgressBarUpdating event handler.

CopyJavaScript
function clientProgressBarUpdating(radProgressArea, args) {  
    var bar = args.get_progressBarElement();  
    radProgressArea.updateVerticalProgressBar(bar, args.get_progressValue());  
    // skip the default progress bar updating  
    args.set_cancel(true);
} 

 

updateHorizontalProgressBar

HTML element, integer

none

Updates the width of the progress bar element passed as the first parameter to represent the percentage specified by the second parameter. This method is intended for implementing an OnClientProgressBarUpdating event handler.

CopyJavaScript
function clientProgressBarUpdating(radProgressArea, args) {  
    var bar = args.get_progressBarElement();  
    radProgressArea.updateHorizontalProgressBar(bar, args.get_progressValue());
    // skip the default progress bar updating  args.set_cancel(true);
} 

 

updateTextIndicator

HTML element, string

none

Updates the text value of the HTML element passed as the first parameter to the value passed as the second parameter. This method is intended for updating custom elements in a progress template from an OnClientProgressUpdating event handler.

CopyJavaScript
function clientProgressUpdating(progressArea, args) {
    var myControl = $get("myTemplatePrimaryValue");
    var data = args.get_progressData();
    progressArea.updateTextIndicator(myControl, progressData.PrimaryValue);
    args.set_cancel(true);
}

 

get_element

none

HTML Element

Returns the DOM element for the RadProgressArea control.

See Also