addDialogControl

クラス: Simulink.dialog.Container
名前空間: Simulink.dialog

マスク ダイアログ ボックスにダイアログ コントロール要素を追加

このページをすべて展開する

構文

success = maskObj.addDialogControl(controlType,controlIdentifier)
success = maskObj.addDialogControl(Name=Value)

説明

success = maskObj.addDialogControl(controlType,controlIdentifier) は、マスク ダイアログ ボックスにテキスト、ハイパーリンク、タブなどのダイアログ コントロール要素を追加します。最初にマスク オブジェクトを取得して変数 maskObj に代入します。

success = maskObj.addDialogControl(Name=Value) は、マスク ダイアログ ボックスの要素に対して 1 つ以上の名前と値の引数を指定します。

入力引数

すべて展開する

ダイアログ コントロール要素の値のタイプ。次のオプションのいずれかとして指定します。

  • 'panel'

  • 'group'

  • 'tabcontainer'

  • 'tab'

  • 'collapsiblepanel'

  • 'text'

  • 'image'

  • 'hyperlink'

  • 'pushbutton'

マスク ダイアログ ボックスの要素のプログラム識別子を指定します。語の間にスペースがない一意の名前を使用します。詳細については、変数名を参照してください。

名前と値の引数

すべて展開する

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

このダイアログ コントロール要素の値を指定するために使用するコントロールのタイプ。タイプは必須の引数です。可能な値は 'hyperlink' および 'pushbutton' です。

例: text

データ型: char | string

ダイアログ コントロール要素の識別子。文字ベクトルまたは string として指定します。Name は必須の引数です。このフィールドはすべてのダイアログ コントロール タイプで利用できます。

例: tag

データ型: char | string

マスク ダイアログ ボックスのダイアログ コントロール要素で表示されるテキスト。文字ベクトルまたは string として指定します。このフィールドはパネルおよびイメージ ダイアログ コントロール タイプを除くすべてのダイアログ コントロール タイプで利用できます。

例: maskButton.Prompt = 'Compute';

データ型: char | string

マスク ダイアログ ボックスのダイアログ コントロール要素で表示されるテキスト。このフィールドはパネルおよびイメージ ダイアログ コントロール タイプを除くすべてのダイアログ コントロール タイプで利用できます。

例: This is a push button

データ型: char | string

ダイアログ コントロール要素に値を設定できるかどうかを指定するオプション。このフィールドはすべてのダイアログ コントロール タイプで利用できます。

データ型: logical

ダイアログ コントロール要素がユーザーに表示されるか非表示であるかを設定するオプション。このフィールドはすべてのダイアログ コントロール タイプで利用できます。

データ型: logical

ダイアログ コントロール要素を編集して [適用] をクリックしたときに実行される MATLAB コードのコンテナー。このフィールドはハイパーリンクおよびプッシュ ボタン ダイアログ コントロール タイプでのみ利用できます。

データ型: char | string

ダイアログ コントロールが新しい行に配置されるか同じ行に配置されるかを設定するオプション。このフィールドはすべてのダイアログ コントロール タイプで利用できます。

データ型: logical

イメージ ファイルへのパスを格納します。このフィールドはイメージおよびプッシュ ボタン ダイアログ コントロール タイプで利用できます。

データ型: char | string

子のダイアログ コントロールのコンテナーを指定するオプション。可能な値は、'panel'、'group' および 'tab' ダイアログ コントロールの名前です。

データ型: logical

例

すべて展開する

ライブ スクリプトを開く

マスク オブジェクトを取得し、ダイアログ コントロール要素を追加します。

% Get mask object on model Engine
new_system('Engine');
add_block('built-in/Gain','Engine/gain');
save_system;
open_system('Engine');
maskObj = Simulink.Mask.create(gcb);
save_system;
% Add hyperlink to mask dialog box

maskLink = maskObj.addDialogControl('hyperlink','link'); 
maskLink.Prompt = 'Mathworks Home Page';
maskLink.Callback = 'web(''www.mathworks.com'')'
maskLink = 
  Hyperlink with properties:

                 Name: 'link'
               Prompt: 'Mathworks Home Page'
             Callback: 'web('www.mathworks.com')'
                  Row: 'new'
              Enabled: 'on'
              Visible: 'on'
    HorizontalStretch: 'on'
              Tooltip: ''


% Add text to mask dialog box
maskText = maskObj.addDialogControl('text','text_tag'); 
maskText.Prompt = 'Enable range checking';

% Add button to mask dialog box
maskButton = maskObj.addDialogControl('pushbutton','button_tag'); 
maskButton.Prompt = 'Compute';
save_system;

マスク ダイアログ ボックスのタブにダイアログ コントロール要素を追加

マスク ダイアログ ボックスにタブを作成し、そのタブに要素を追加します。

% Get mask object on a block named 'GainBlock'
add_block('built-in/Gain','Engine/gain1');
maskObj = Simulink.Mask.create(gcb);
maskObj = Simulink.Mask.get(gcb);

% Create a tab container

maskObj.addDialogControl('tabcontainer','allTabs');
tabs = maskObj.getDialogControl('allTabs');

% Create tabs and name them

maskTab1 = tabs.addDialogControl('tab','First');
maskTab1.Prompt = 'First tab';

maskTab2 = tabs.addDialogControl('tab','Second');
maskTab2.Prompt = 'Second tab';

% Add elements to one of the tabs

firstTab = tabs.getDialogControl('First');
firstTab.addDialogControl('text','textOnFirst');
firstTab.getDialogControl('textOnFirst').Prompt = 'Tab one';
save_system;

名前と値のペアを使用したダイアログ コントロール要素の追加

ダイアログ コントロール要素を追加し、その値を指定します。

% Get mask object on model Engine

add_block('built-in/Gain','Engine/gain2');
maskObj = Simulink.Mask.create(gcb);
maskObj = Simulink.Mask.get(gcb);

% Add a dialog box and specify values for it

maskDialog = maskObj.addDialogControl('Name','abc','Type','text','Prompt','hello','Visible','off');
save_system;

バージョン履歴

R2014a で導入

参考

トピック