Main Content

このページの翻訳は最新ではありません。ここをクリックして、英語の最新版を参照してください。

ProgressDialog のプロパティ

進捗ダイアログ ボックスの外観と動作の制御

進捗ダイアログ ボックスは、アニメーション化された進行状況バーの表示によって、操作が進行中であることを示します。関数 uiprogressdlg は進捗ダイアログ ボックスを作成し、表示される前に必要なプロパティを設定します。進捗ダイアログ ボックスのプロパティ値を変更することによって、外観および動作の一部の特性を変更できます。ドット表記を使用して、特定のオブジェクトとプロパティを参照します。

fig = uifigure;
d = uiprogressdlg(fig);
d.Value = .25;

テキストとスタイル

すべて展開する

メッセージ。文字ベクトル、文字ベクトルの cell 配列、または string 配列として指定します。このメッセージは、ダイアログ ボックス内にある進行状況バーの上に表示されます。

複数行のテキストを表示するには、文字ベクトルの cell 配列または string 配列を指定します。配列の各要素は、テキストの行に対応します。各要素のハード ブレイク ('\n' など) はテキストの追加行を作成します。

例: d = uiprogressdlg(uifigure,'Message','Calculating result.');

タイトル。文字ベクトルまたは string スカラーとして指定します。このタイトルはダイアログ ボックスのタイトル バーに表示されます。

例: d = uiprogressdlg(uifigure,'Title','Calculating');

アイコン。事前定義されているアイコンまたはカスタム アイコンとして指定します。

事前定義されているアイコン

次の表は、事前定義されているアイコンを示す値の一覧です。

アイコン
'' (既定)アイコンは表示されません。
'question'

'info'

'success'

'warning'

'error'

カスタム アイコン

カスタム アイコンを次の値のいずれかとして指定します。

  • MATLAB® パス上にある SVG、JPEG、GIF または PNG イメージのファイル名を指定する文字ベクトルまたは string スカラー。あるいは、イメージ ファイルの絶対パスを指定することもできます。

  • トゥルーカラー イメージ配列。詳細については、イメージの種類を参照してください。

進行状況

すべて展開する

完了率。01 の数値として指定します。この値が 1 のとき、進行状況バーは最大長に達しています。コードの複数の箇所で Value を変更すると、実行中のアプリの進行状況を視覚的に表示できます。

データ型: double

パーセンテージの表示。'off' または 'on' もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off'false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

このプロパティを 'on' に設定すると、ダイアログ ボックスで完了率がパーセンテージとして表示されます。

不確定型進行状況。'off' または 'on' もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off'false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

このプロパティを 'on' に設定すると、アニメーション化されたバーが表示されますが、進行状況に関する具体的な情報は表示されません。このアニメーションは、計算にかかる時間がわからない場合に便利です。

不確定型進行状況バーが無期限に表示されないようにするには、計算の完了後に関数 close を呼び出します。

対話機能

すべて展開する

キャンセルの許可。'off' または 'on' もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off'false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

値を 'on' に指定すると、ダイアログ ボックスにキャンセル ボタンが表示されます。CancelText プロパティを指定すると、ボタン ラベルをカスタマイズできます。

キャンセルを許可する場合、CancelRequested プロパティの値を確認して、値が true のときに関数 close を呼び出さなければなりません。それ以外の場合、ダイアログ ボックスは無期限に表示されます。

キャンセル ボタンのテキスト。文字ベクトルまたは string スカラーとして指定します。このプロパティは Cancelable'on' に設定されている場合のみ有効です。

例: d = uiprogressdlg(uifigure,'Cancelable','on','CancelText','Stop')

キャンセル要求。true または false として指定します。このプロパティは、Cancelable'on' のときに、ユーザーがキャンセル ボタンをクリックしたかどうかを把握する場合に使用します。このプロパティはユーザーがキャンセル ボタンをクリックするまでは false で、その後値は true に変わります。

R2018a で導入