Object Model: ProgressBar.CancelEnabled

ProgressBar.CancelEnabled

Description

Returns or sets a Boolean value indicating whether a cancel button is available on the progress bar. By default this property is set to true, but it should be set to false if the operation cannot be stopped during its execution. To have any affect this property must be set before ProgressBar.Visible is called.

C# Syntax

// get accessor
Boolean rtn = ProgressBar.CancelEnabled;
// set accessor
ProgressBar.CancelEnabled = Boolean;

Examples

JScript Example

/*
        Demonstrate a progress bar that cannot be cancelled
*/
var oProgressBar = XSIUIToolkit.ProgressBar ;
oProgressBar.Maximum = 65535 ;
oProgressBar.Step = 1;
oProgressBar.CancelEnabled = false;
oProgressBar.Caption = "There is no stopping me";
oProgressBar.Visible = true;
while( oProgressBar.Value < oProgressBar.Maximum )
{
        oProgressBar.Increment() ;
}
// Make sure to close properly
oProgressBar.Visible = false ;