ProgressBar

Object Hierarchy | 関連する C++クラス:ProgressBar

導入

v3.0

詳細

プログレスバーは、処理時間が長い場合に横長の矩形内にカラーバーを表示して、その進捗状況を示すコントロールです。バー全体の長さに対するプログレスバーの長さは、完了した操作の比率に対応します。プログレスバーにはXSIUIToolkit.ProgressBarプロパティを使用してアクセスします。デフォルトの最小値と最大値は 1 のステップでそれぞれ0および100です。

警告:JScriptからProgressBar を使用する場合は、スクリプトの処理の完了後に、Visible プロパティを明示的に False に設定する必要があります。他の言語では、ProgressBar オブジェクトを参照しているすべてのローカル変数がスコープから外れるとすぐに、画面から自動的に ProgressBar自体が削除されます。

注:プログレスバーの更新頻度は、1秒あたり数回までにしてください。それ以上頻繁になると、スクリプトの実行速度が遅くなる可能性があります。たとえば、アルゴリズムスキャニングの 1,000,000ベクトルは、各ベクトルでプログレスバーが更新される場合は、かなり遅くなります。

メソッド

Increment      
       

プロパティ

CancelEnabled CancelPressed Caption Maximum
Minimum StatusText Step Value
Visible      
       

1. JScript の例

/*
        Demonstrates how to properly finish with the progress bar. 
*/
var oProgressBar = XSIUIToolkit.ProgressBar ;
oProgressBar.Maximum = 100 ;
oProgressBar.Step = 1;
oProgressBar.Caption = "Creating Nulls";
oProgressBar.CancelEnabled = true ;
oProgressBar.Visible = true;
while( oProgressBar.Value < oProgressBar.Maximum )
{
        Application.ActiveSceneRoot.AddNull() ;
        if ( oProgressBar.CancelPressed )
                break ;
        oProgressBar.Increment() ;
}
// Make sure the progress bar disappears
oProgressBar.Visible = false ;

2. VBScript の例

'
' Demonstrates the use of the progress bar in displaying percentage complete. 
'
dim oProgressBar
set oProgressBar = XSIUIToolkit.ProgressBar
oProgressBar.Maximum = 65535
oProgressBar.Step = 10
oProgressBar.CancelEnabled = true
oProgressBar.Caption = "Processing"
oProgressBar.Visible= true
Do While oProgressBar.CancelPressed<>True And oProgressBar.Value < oProgressBar.Maximum
        oProgressBar.Increment
Loop

3. VBScript の例

'
' Demonstrates the use of the progress bar in displaying progress per frame. 
'
dim oProgressBar
set oProgressBar = XSIUIToolkit.ProgressBar
oProgressBar.Maximum = 65535
oProgressBar.Visible= true
Do While oProgressBar.CancelPressed<>True And oProgressBar.Value < oProgressBar.Maximum
        i = oProgressBar.Increment
        oProgressBar.StatusText = "Frame " & i
Loop

関連項目

XSIUIToolkit.ProgressBar