uialert

警告ダイアログ ボックスの表示

構文

uialert(fig,message,title)

uialert(___,Name,Value)

説明

uialert(fig,message,title) は、指定された Figure ウィンドウの前面にモーダル ダイアログ ボックスを表示します。この Figure は関数 uifigure で作成されていなければなりません。このダイアログ ボックスには指定されたメッセージが表示され、タイトル バーと指定のタイトルがあります。既定では、ダイアログ ボックスにはエラー アイコンと [OK] ボタンも含まれます。

uialert(___,Name,Value) は、1 つ以上の Name,Value の引数で指定されたプロパティをもつダイアログ ボックスを表示します。

例

アプリ ユーザーにエラーを警告

モーダル警告ダイアログ ボックスを作成します。そのダイアログ ボックスを閉じるまで、後ろ側にある Figure にはアクセスできません。

fig = uifigure;
uialert(fig,'File not found','Invalid File');

警告アイコンをもつ複数行のモーダル警告ダイアログ ボックスを作成

fig = uifigure;
message = {'Fire hazard!','Consider reducing temperature.'};
uialert(fig,message,'Warning',...
'Icon','warning');

書式設定された MATLAB エラーの表示

Figure および異なるサイズの 2 つの行列を作成します。

fig = uifigure; 
A = rand(3);
B = ones(5);

これらの行列を垂直方向に連結してみます。エラー テキストを取得して Figure 内に警告ダイアログ ボックスを作成することにより発生したすべてのエラーを処理し、エラー テキストをダイアログ メッセージとして指定します。多くの場合、MATLAB^® エラー テキストには HTML 書式設定が含まれるため、ダイアログ インタープリターとして 'html' を指定します。エラーが関数 vertcat のドキュメンテーションへのリンクと共に表示されます。

try 
    C = vertcat(A,B);
catch ME 
    report = getReport(ME);
    uialert(fig,report,'Error Message','Interpreter','html');
end

入力引数

fig — ターゲット Figure

Figure オブジェクト

ターゲット Figure。Figure オブジェクトとして指定します。この Figure は関数 uifigure で作成されていなければなりません。

message — メッセージ

文字ベクトル | 文字ベクトルの cell 配列 | string 配列

メッセージ。文字ベクトル、文字ベクトルの cell 配列、または string 配列として指定します。任意の長さのメッセージを指定できます。

複数行のテキストを表示する場合は、文字ベクトルの cell 配列または string 配列を使用します。配列の各要素は、テキストの各行です。

例: 'Invalid value'

title — タイトル

文字ベクトル | string スカラー

タイトル。文字ベクトルまたは string スカラーとして指定します。長いタイトルは打ち切られ、その後に省略記号が付きます。タイトルが打ち切られる正確な長さは、システム設定によって異なります。

改行文字 (\n) などの書式文字はスペースに置き換えられます。

名前と値の引数

引数のオプションのペアを Name1=Value1,...,NameN=ValueN として指定します。ここで Name は引数名で、Value は対応する値です。名前と値の引数は他の引数の後になければなりませんが、ペアの順序は重要ではありません。

R2021a より前では、コンマを使用してそれぞれの名前と値を区切り、Name を引用符で囲みます。

例: 'Icon','warning'

CloseFcn — 警告ダイアログ ボックスのクローズ要求コールバック関数

'' (既定値) | 関数ハンドル | cell 配列 | 文字ベクトル

警告ダイアログ ボックスのクローズ要求コールバック関数。次の値のいずれかとして指定します。

• 関数ハンドル。

• 最初の要素が関数ハンドルである cell 配列。cell 配列内のその後の要素はコールバック関数に渡される引数です。

• 有効な MATLAB 式である文字ベクトル。MATLAB はベース ワークスペース内でこの式を評価します。

アプリ ユーザーがタイトル バーの閉じるボタンをクリックするか、[OK] ボタンをクリックして警告ダイアログ ボックスを閉じると、CloseFcn コールバックが実行されます。表示された警告ダイアログ ボックスの基の Figure ウィンドウをアプリ ユーザーが MATLAB コマンド ラインから閉じた場合も、関数 CloseFcn が実行されます。関数 close を使用して、コマンド ラインから Figure ウィンドウを閉じることができます。

Icon — アイコン

'error' (既定値) | 事前定義されているアイコン | カスタム アイコン

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

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

次の表は、事前定義されているアイコンを示す値の一覧です。たとえば、チェック マークのアイコンを表示するには、名前と値のペア 'Icon','success' を指定します。

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

カスタム アイコン

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

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

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

Modal — モーダル

true (既定値) | false

モーダル。true または false として指定します。

モーダル ダイアログ ボックスは、ダイアログ ボックスが閉じられるまで Figure をアクセス不可にするものです。ただし、追加のダイアログ ボックスの表示は妨げられません。

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を参照してください。

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を参照してください。

バージョン履歴

R2016a で導入

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

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

参考

関数

• uifigure | msgbox | errordlg | warndlg | uiconfirm | uiprogressdlg