helpdlg

ヘルプ ダイアログ ボックスの作成

ページ内をすべて折りたたむ

構文

helpdlg
helpdlg(msg)
helpdlg(msg,title)
f = helpdlg(___)

説明

メモ

helpdlg よりも uialert の方が追加のカスタマイズ オプションがあるため推奨されます。

helpdlg は、ヘルプ ダイアログという既定のタイトルと、これは既定のヘルプですという既定のメッセージの付いた、非モーダル ヘルプ ダイアログ ボックスを作成します。

複数のアプリ ウィンドウ、MATLAB® デスクトップ、または Simulink® でヘルプ ダイアログ ボックスを表示し、ダイアログ ボックスに応答する前にそれらを操作できるようにする場合は、この関数を使用します。

helpdlg(msg) は、カスタム メッセージ テキストを指定します。一致するダイアログ ボックス タイトルのダイアログ ボックスが既に存在している場合、MATLAB で前面に表示されます。

例

helpdlg(msg,title) は、ダイアログ ボックスのカスタム タイトルを指定します。

例

f = helpdlg(___) は、figure オブジェクトを返します。この構文では、前述の構文の任意の入力引数を使用できます。

例

すべて折りたたむ

helpdlg("Consider using a cell array.")

Help dialog box with the title "Help Dialog", a blue icon that contains the letter "i", the message "Consider using a cell array", and an OK button

string 配列を使用して、ヘルプ ダイアログ ボックスのテキストを指定します。改行は各配列要素の後に挿入されます。

helpdlg(["Valid data types are:","int8", ...
    "int16","int32","int64"])

Help dialog box. The message lists valid data types with each data type on its own line.

カスタム タイトルとメッセージでダイアログ ボックスを作成します。 

helpdlg("Choose 10 points from the figure",...
    "Point Selection")

Help dialog box with the title "Point Selection" and the message "Choose 10 points from the figure"

ダイアログ ボックスが表示されない場合、その他のウィンドウの下に隠れている可能性があります。コマンドをもう一度発行し、前面に表示します。

helpdlg("Choose 10 points from the figure", ...
    "Point Selection")

ここで、同じタイトルで別のメッセージを使用して helpdlg をもう一度呼び出し、メッセージを変更します。 

helpdlg("Choose 5 points from the figure", ...
    "Point Selection")

ダイアログ ボックスを作成した後は、helpdlg を呼び出して同じ title を指定するたびに、MATLAB によってそのダイアログ ボックスが前面に表示されるようになります。ダイアログ ボックス title が変更されない場合、helpdlg への呼び出しの合い間にダイアログ ボックスを閉じると、MATLAB で新しいダイアログ ボックスのみが作成されます。

入力引数

すべて折りたたむ

ヘルプ メッセージ。文字ベクトル、string スカラー、文字ベクトルの cell 配列、または string 配列として指定します。

  • ヘルプ メッセージを文字ベクトルまたは string スカラーとして指定すると、長いメッセージはダイアログ ボックスに納まるように折り返されます。

  • ヘルプ メッセージを文字ベクトルまたは string 配列の cell 配列として指定すると、各配列要素間に改行が挿入されます。長い要素はダイアログ ボックスに納まるように折り返されます。

例: "This value is required."

例: {'Valid data types are:','int8','int16','int32','int64'}

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

例: "Value Specification"

詳細

すべて折りたたむ

ヒント

  • MATLAB プログラムの実行は、モーダル ヘルプ ダイアログ ボックスがアクティブであっても続行されます。ユーザーがダイアログ ボックスを閉じるまでプログラムの実行をブロックする場合は、関数 uiwait を使用します。

  • 単一ウィンドウの App Designer または uifigure ベースのアプリ向けにモーダル警告ダイアログ ボックスを作成するには、代わりに関数 uialert を使用します。

バージョン履歴

R2006a より前に導入

参考

| | |