ProgressDialog のプロパティ

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

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

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

テキストとスタイル

すべて展開する

`Message` — メッセージ
`''` (既定値) | 文字ベクトル | 文字ベクトルの cell 配列 | string 配列

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

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

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

`Title` — タイトル
`''` (既定値) | 文字ベクトル | string スカラー

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

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

`Icon` — 事前定義されているアイコンまたはカスタムアイコン
`''` (既定値) | 文字ベクトル | string スカラー | トゥルーカラーイメージ配列

事前定義されているアイコンまたはカスタムアイコン。文字ベクトル、string スカラー、またはトゥルーカラーイメージ配列として指定します。

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

次の表に、事前定義されているアイコンを指定するための値を一覧します。

値	アイコン
`''` (既定)	アイコンは追加されません。
`'question'`
`'info'`
`'success'`
`'warning'`
`'error'`

カスタムアイコン

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

MATLAB^® パス上にある SVG、JPEG、GIF または PNG イメージのファイル名を指定する文字ベクトルまたは string スカラー。あるいは、イメージファイルの絶対パスを指定することもできます。
トゥルーカラーイメージ配列。詳細については、イメージの種類を参照してください。

`Interpreter` — ダイアログテキストのインタープリター
`'none'` (既定値) | `'tex'` | `'latex'` | `'html'`

ダイアログテキストのインタープリター。次のいずれかとして指定します。

'none' — リテラル文字を表示します。
'tex' — TeX マークアップのサブセットを使用してテキストを解釈します。
'latex' — LaTeX マークアップのサブセットを使用してテキストを解釈します。
'html' — HTML マークアップのサブセットを使用してテキストを解釈します。

TeX マークアップ

TeX マークアップを使用して、上付き文字や下付き文字の追加、テキストへの特殊文字の挿入を行うことができます。

修飾子の効果はテキストの末尾まで適用されます。上付き文字と下付き文字は例外であり、次の 1 文字または中かっこで囲まれた文字にのみ適用されます。インタープリターを 'tex' に設定した場合にサポートされる修飾子は次のとおりです。

修飾子	説明	例
`^{ }`	上付き文字	`'text^{superscript}'`
`_{ }`	下付き文字	`'text_{subscript}'`
`\bf`	太字フォント	`'\bf text'`
`\it`	イタリックフォント	`'\it text'`
`\sl`	斜体フォント (通常はイタリックフォントと同じ)	`'\sl text'`
`\rm`	標準フォント	`'\rm text'`
`\fontname{specifier}`	フォント名 — `specifier` をフォントファミリの名前に置き換えます。これは他の修飾子と組み合わせて使用できます。	`'\fontname{Courier} text'`
`\fontsize{specifier}`	フォントサイズ — `specifier` をポイント単位の数値スカラーに置き換えます。	`'\fontsize{15} text'`
`\color{specifier}`	フォントの色 — `specifier` を、`red`、`green`、`yellow`、`magenta`、`blue`、`black`、`white`、`gray`、`darkGreen`、`orange`、`lightBlue` の色のいずれかに置き換えます。	`'\color{magenta} text'`
`\color[rgb]{specifier}`	フォントのカスタムの色 — `specifier` を RGB 3 成分に置き換えます。	`'\color[rgb]{0,0.5,0.5} text'`

次の表に、'tex' インタープリターでサポートされる特殊文字を示します。

文字列	記号	文字列	記号	文字列	記号
`\alpha`	α	`\upsilon`	υ	`\sim`	~
`\angle`	∠	`\phi`	ϕ	`\leq`	≤
`\ast`	`*`	`\chi`	χ	`\infty`	∞
`\beta`	β	`\psi`	ψ	`\clubsuit`	♣
`\gamma`	γ	`\omega`	ω	`\diamondsuit`	♦
`\delta`	δ	`\Gamma`	Γ	`\heartsuit`	♥
`\epsilon`	ϵ	`\Delta`	Δ	`\spadesuit`	♠
`\zeta`	ζ	`\Theta`	Θ	`\leftrightarrow`	↔
`\eta`	η	`\Lambda`	Λ	`\leftarrow`	←
`\theta`	θ	`\Xi`	Ξ	`\Leftarrow`	⇐
`\vartheta`	ϑ	`\Pi`	Π	`\uparrow`	↑
`\iota`	ι	`\Sigma`	Σ	`\rightarrow`	→
`\kappa`	κ	`\Upsilon`	ϒ	`\Rightarrow`	⇒
`\lambda`	λ	`\Phi`	Φ	`\downarrow`	↓
`\mu`	µ	`\Psi`	Ψ	`\circ`	º
`\nu`	ν	`\Omega`	Ω	`\pm`	±
`\xi`	ξ	`\forall`	∀	`\geq`	≥
`\pi`	π	`\exists`	∃	`\propto`	∝
`\rho`	ρ	`\ni`	∍	`\partial`	∂
`\sigma`	σ	`\cong`	≅	`\bullet`	•
`\varsigma`	ς	`\approx`	≈	`\div`	÷
`\tau`	τ	`\Re`	ℜ	`\neq`	≠
`\equiv`	≡	`\oplus`	⊕	`\aleph`	ℵ
`\Im`	ℑ	`\cup`	∪	`\wp`	℘
`\otimes`	⊗	`\subseteq`	⊆	`\oslash`	∅
`\cap`	∩	`\in`	∈	`\supseteq`	⊇
`\supset`	⊃	`\lceil`	⌈	`\subset`	⊂
`\int`	∫	`\cdot`	·	`\o`	ο
`\rfloor`	⌋	`\neg`	¬	`\nabla`	∇
`\lfloor`	⌊	`\times`	x	`\ldots`	...
`\perp`	⊥	`\surd`	√	`\prime`	´
`\wedge`	∧	`\varpi`	ϖ	`\0`	∅
`\rceil`	⌉	`\rangle`	〉	`\mid`	\|
`\vee`	∨	`\langle`	〈	`\copyright`	©

LaTeX マークアップ

LaTeX マークアップを使用して、数式、方程式、特殊文字を書式設定して表示します。ドル記号を使用してマークアップテキストを囲みます。たとえば、インラインモードでは '$\int_1^{20} x^2 dx$'、表示モードでは '$$\int_1^{20} x^2 dx$$' を使用します。

テキストは LaTeX の既定のフォントスタイルで表示され、フォントスタイルは LaTeX マークアップを使用して変更できます。

MATLAB では、大半の標準の LaTeX 数式モードコマンドがサポートされています。詳細については、サポートされる LaTeX コマンドを参照してください。

HTML マークアップ

HTML マークアップは、リンクの表示やフォントスタイルのカスタマイズに使用します。

インタープリターは HTML マークアップのサブセットをサポートします。一般的なガイドラインとして、インタープリターはテキスト関連のタグとスタイルをサポートします。サポートされないタグとスタイルは無視されます。

次の表に、サポートされる要素と要素の属性を一覧します。

HTML 要素	属性	説明
`a`	`style`, `target`, `href`, `title`	ハイパーリンク
`abbr`	`style`, `title`	略語または頭字語
`address`	`style`	連絡先情報
`article`	`style`	自己完結した単独のコンテンツ
`aside`	`style`	主な内容に間接的に関連するコンテンツ
`b`	`style`	太字フォント
`bdi`	`style`, `dir`	周囲のテキストとは異なる方向で書式設定されるコンテンツ
`bdo`	`style`, `dir`	周囲のテキストとは異なる方向で書式設定されるコンテンツ
`big`	`style`	周囲のテキストよりフォントサイズが 1 レベル大きいテキスト (HTML5 では旧式)
`blockquote`	`style`, `cite`	拡張された引用
`br`	N/A	改行
`caption`	`style`	テーブルのキャプションまたはタイトル
`center`	`style`	水平方向に中央揃えされたコンテンツ
`cite`	`style`	参照先のタイトル
`code`	`style`	コードのフラグメント
`col`	`style`, `align`, `valign`, `span`, `width`	テーブル内の列
`colgroup`	`style`, `align`, `valign`, `span`, `width`	テーブル内の列のグループ
`dd`	`style`	説明リストの用語または値
`del`	`style`, `datetime`	ドキュメントから削除されたテキスト
`details`	`style`, `open`	'開いた' 状態に切り替えた場合にのみテキストが表示される対話型ウィジェット
`dl`	`style`	説明リスト
`dt`	`style`	説明リストの用語または値
`em`	`style`	強調表示されるテキスト (通常、イタリックで表示)
`font`	`style`, `color`, `size`, `face`	指定したフォントプロパティのテキスト (HTML5 では旧式)
`footer`	`style`	フッター
`h1`. `h2`, `h3`, `h4`, `h5`, `h6`	`style`	セクション見出し — `<h1>` が見出しの最上位、`<h6>` が最下位
`header`	`style`	導入コンテンツ
`hr`	`style`	主題の区切り
`i`	`style`	周囲のコンテンツからのテキストオフセット — 既定の設定ではイタリックとしてレンダリングされる
`ins`	`style`, `datetime`	ドキュメントに挿入されたテキスト
`li`	`style`	リスト内の項目
`mark`	`style`	マークアップテキストまたは強調表示されたテキスト
`ol`	`style`	順序付きリスト
`p`	`style`	段落
`pre`	`style`	書式設定済みテキスト
`s`	`style`	取り消し線付きのテキスト
`strike`	`style`	取り消し線付きのテキスト (HTML5 では旧式)
`section`	`style`	独立したセクション
`small`	`style`	周囲のテキストよりフォントサイズが 1 レベル小さいテキスト (HTML5 では旧式)
`sub`	`style`	下付き文字
`sup`	`style`	上付き文字
`strong`	`style`	重要度が高いテキスト
`table`	`style`, `width`, `border`, `align`, `valign`	テーブル
`tbody`	`style`, `align`, `valign`	テーブル本体
`td`	`style`, `width`, `rowspan`, `colspan`, `align`, `valign`	テーブルデータセル
`tfoot`	`style`, `align`, `valign`	テーブル列をまとめる一連のテーブル行
`th`	`style`, `width`, `rowspan`, `colspan`, `align`, `valign`	セルのグループのヘッダーとして指定されたテーブルデータセル
`thead`	`style`, `align`, `valign`	列見出しを指定する一連のテーブル行
`tr`	`style`, `rowspan`, `align`, `valign`	テーブルセルの行
`tt`	`style`	固定幅テキスト (HTML5 では旧式)
`u`	`style`	非言語的注釈を使用するテキスト — 既定の設定では下線としてレンダリングされる
`ul`	`style`	順序なしリスト

これらの要素の詳細については、https://developer.mozilla.org/en-US/docs/Web/HTML/Elementを参照してください。

MATLAB コードを実行するハイパーリンクを作成するために HTML マークアップを使用するには、関数を実行するハイパーリンクの作成を参照してください。

HTML スタイル属性を使用して HTML コンテンツを書式設定できます。スタイル属性は CSS 属性とその値の文字列です。

以下の CSS 属性がサポートされています。

background-color
border-bottom
border-bottom-color
border-bottom-left-radius
border-bottom-right-radius
border-bottom-style
border-bottom-width
border-left
border-left-color
border-left-style
border-left-width
border-radius
border-right
border-right-color
border-right-style
border-right-width
border-spacing
border-style
border-top
border-top-color
border-top-left-radius
border-top-right-radius
border-top-style
border-top-width
border-width
color
direction
font-family
font-size
font-style
font-weight
height
hidden
line-height
margin
margin-bottom
margin-left
margin-right
margin-top
max-height
max-width
min-height
min-width
overflow
overflow-wrap
overflow-x
overflow-y
padding
padding-bottom
padding-left
padding-right
padding-top
text-align
text-anchor
text-decoration
text-indent
text-overflow
text-shadow
text-transform
title
translate
white-space
width

これらの属性の詳細については、https://developer.mozilla.org/en-US/docs/Web/CSS/Referenceを参照してください。

進行状況

すべて展開する

`Value` — 完了率
`0` (既定値) | `0` ～ `1` の数値

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

データ型: double

`ShowPercentage` — パーセンテージの表示
`'off'` (既定値) | on/off logical 値

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

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

`Indeterminate` — 不確定型進行状況
`'off'` (既定値) | on/off logical 値

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

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

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

対話機能

すべて展開する

`Cancelable` — キャンセルの許可
`'off'` (既定値) | on/off logical 値

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

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

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

`CancelText` — キャンセルボタンのテキスト
`'Cancel'` (既定値) | 文字ベクトル | string スカラー

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

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

`CancelRequested` — キャンセル要求
`true` | `false`

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

バージョン履歴

R2018a で導入

すべて展開する

R2021b: テキストのスタイル設定および方程式の表示

Interpreter プロパティを使用して、ダイアログボックスのテキストのマークアップを有効にします。インタープリターを 'html'、'latex'、'tex'、または 'none' として指定します。

参考

uiprogressdlg

ProgressDialog のプロパティ

テキストとスタイル

Message — メッセージ '' (既定値) | 文字ベクトル | 文字ベクトルの cell 配列 | string 配列

Title — タイトル '' (既定値) | 文字ベクトル | string スカラー

Icon — 事前定義されているアイコンまたはカスタム アイコン '' (既定値) | 文字ベクトル | string スカラー | トゥルーカラー イメージ配列

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

カスタム アイコン

Interpreter — ダイアログ テキストのインタープリター 'none' (既定値) | 'tex' | 'latex' | 'html'

TeX マークアップ

LaTeX マークアップ

HTML マークアップ

進行状況

Value — 完了率 0 (既定値) | 0 ～ 1 の数値

ShowPercentage — パーセンテージの表示 'off' (既定値) | on/off logical 値

Indeterminate — 不確定型進行状況 'off' (既定値) | on/off logical 値

対話機能

Cancelable — キャンセルの許可 'off' (既定値) | on/off logical 値

CancelText — キャンセル ボタンのテキスト 'Cancel' (既定値) | 文字ベクトル | string スカラー

CancelRequested — キャンセル要求 true | false

バージョン履歴

R2021b: テキストのスタイル設定および方程式の表示

参考

`Message` — メッセージ
`''` (既定値) | 文字ベクトル | 文字ベクトルの cell 配列 | string 配列

`Title` — タイトル
`''` (既定値) | 文字ベクトル | string スカラー

`Icon` — 事前定義されているアイコンまたはカスタムアイコン
`''` (既定値) | 文字ベクトル | string スカラー | トゥルーカラーイメージ配列

カスタムアイコン

`Interpreter` — ダイアログテキストのインタープリター
`'none'` (既定値) | `'tex'` | `'latex'` | `'html'`

`Value` — 完了率
`0` (既定値) | `0` ～ `1` の数値

`ShowPercentage` — パーセンテージの表示
`'off'` (既定値) | on/off logical 値

`Indeterminate` — 不確定型進行状況
`'off'` (既定値) | on/off logical 値

`Cancelable` — キャンセルの許可
`'off'` (既定値) | on/off logical 値

`CancelText` — キャンセルボタンのテキスト
`'Cancel'` (既定値) | 文字ベクトル | string スカラー

`CancelRequested` — キャンセル要求
`true` | `false`