Main Content

Menu のプロパティ

メニューの外観と動作の制御

アプリ ウィンドウの最上部のメニューにオプションのドロップダウン リストが表示されます。メニューを作成したり、既存のメニューにサブメニューを追加するには、関数 uimenu を呼び出します。プロパティは、メニューの外観と動作を制御します。ドット表記を使用して、特定のオブジェクトとプロパティを参照します。

fig = uifigure;
m = uimenu(fig);
m.Text = 'Open Selection';

Menu オブジェクトの一部のプロパティは、メニューが関数 uifigure と関数 figure のどちらを使用して作成された Figure の子かによって異なります。関数 uifigure は、新しいアプリの作成時に使用が推奨される関数であり、App Designer アプリで使用される関数です。詳細については、アプリの作成方法を参照してください。

メニュー

すべて展開する

メニュー ラベル。文字ベクトルまたは string スカラーとして指定します。このプロパティはメニュー (またはメニュー項目) に表示されるラベルを指定します。

予約語 'default''remove' および 'factory' (大文字小文字が区別されます) の使用は避けてください。予約語を使用しなければならない場合は、その単語の前にバックスラッシュ文字を指定します。たとえば、'default''\default' として指定します。

ラベルのテキストにアンパサンド文字 (&) を使用して、ニーモニックのキーボード ショートカット (Alt+mnemonic) を指定できます。Alt を押すと、メニューにはアンパサンドの次に来る文字が下線付きで表示されます。メニュー項目は Alt キーを押したまま表示される文字を入力すると選択できます。

ニーモニックを使用するには、アプリ内で定義するすべてのメニューおよびメニュー項目のニーモニックを指定しなければなりません。ニーモニックを一部のメニューまたはメニュー項目に対してのみ定義する場合は、Alt キーを押しても効果はありません。

次の表にいくつか例を示します。

テキスト値ニーモニック ヒント付きメニュー ラベル
'&Open Selection'

Open Selection menu label. The "O" in "Open" is underlined.

'O&pen Selection'

Open Selection menu label. The "p" in "Open" is underlined.

'&Save && Go'

Open Selection menu label. The "S" in "Save & Go" is underlined.

キーボード ショートカット。1 文字、または 1 文字を含む string として指定します。このプロパティを使用して、メニュー項目を選択するキーボード ショートカットを定義します。

例: mitem.Accelerator = "H"

アクセラレータの値を指定すると、ユーザーはマウスを使用する代わりに、文字と別のキーを押すことによってメニュー項目を選択できます。キーは、使用するプラットフォームに依存します。

  • Windows® システム: Ctrl+accelerator

  • Macintosh システム: Command+accelerator

  • Linux® システム: Ctrl+accelerator

アクセラレータを使用する際の注意事項

  • アクセラレータのキー シーケンスを入力する場合、アプリ ウィンドウはフォーカス内になければなりません。

  • アクセラレータは最上位メニューで使用できません。

  • アクセラレータはメニュー項目が次のすべての条件を満たす場合にのみ機能します。

    • サブメニュー項目が含まれていない。

    • コールバック関数を実行する。

    • Visible プロパティが 'on' に設定されている。

    • そのアクセラレータの値が、同じ Figure 内の異なるアクティブなメニュー項目にまだ代入されていない。

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

このプロパティを 'on' に設定すると、メニュー項目の上に境界線が描画されます。

メモ

メニュー項目が最上位メニュー項目の場合、Separator プロパティは無視されます。

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

このプロパティを 'on' に設定するには、対応するメニュー項目の次にチェック マークを付けます。'off' に設定すると、チェック マークが外されます。この機能を使用すると、アプリケーションの機能を有効または無効にするメニュー項目の状態を表示できます。

メモ

メニュー項目が次の場合、Checked プロパティは無視されます。

  • 最上位メニュー項目

  • 1 つ以上の子メニュー項目をもつメニュー項目

メニュー ラベルの色。RGB 3 成分、16 進数カラー コード、または表にリストされた色オプションのいずれかとして指定します。

RGB 3 成分および 16 進数カラー コードは、カスタム色を指定するのに役立ちます。

  • RGB 3 成分は、色の赤、緑、青成分の強度を指定する 3 成分の行ベクトルです。強度値は [0,1] の範囲でなければなりません。たとえば [0.4 0.6 0.7] のようになります。

  • 16 進数カラー コードは、ハッシュ記号 (#) で始まり、3 桁または 6 桁の 0 から F までの範囲の 16 進数が続く文字ベクトルまたは string スカラーです。この値は大文字と小文字を区別しません。したがって、カラー コード "#FF8800""#ff8800""#F80"、および "#f80" は等価です。

あるいは、名前を使用して一部の一般的な色を指定できます。次の表に、名前の付いた色オプション、等価の RGB 3 成分、および 16 進数カラー コードを示します。

色名省略名RGB 3 成分16 進数カラー コード外観
"red""r"[1 0 0]"#FF0000"

Sample of the color red

"green""g"[0 1 0]"#00FF00"

Sample of the color green

"blue""b"[0 0 1]"#0000FF"

Sample of the color blue

"cyan" "c"[0 1 1]"#00FFFF"

Sample of the color cyan

"magenta""m"[1 0 1]"#FF00FF"

Sample of the color magenta

"yellow""y"[1 1 0]"#FFFF00"

Sample of the color yellow

"black""k"[0 0 0]"#000000"

Sample of the color black

"white""w"[1 1 1]"#FFFFFF"

Sample of the color white

MATLAB® の多くのタイプのプロットで使用されている既定の色の RGB 3 成分および 16 進数カラー コードを次に示します。

RGB 3 成分16 進数カラー コード外観
[0 0.4470 0.7410]"#0072BD"

Sample of RGB triplet [0 0.4470 0.7410], which appears as dark blue

[0.8500 0.3250 0.0980]"#D95319"

Sample of RGB triplet [0.8500 0.3250 0.0980], which appears as dark orange

[0.9290 0.6940 0.1250]"#EDB120"

Sample of RGB triplet [0.9290 0.6940 0.1250], which appears as dark yellow

[0.4940 0.1840 0.5560]"#7E2F8E"

Sample of RGB triplet [0.4940 0.1840 0.5560], which appears as dark purple

[0.4660 0.6740 0.1880]"#77AC30"

Sample of RGB triplet [0.4660 0.6740 0.1880], which appears as medium green

[0.3010 0.7450 0.9330]"#4DBEEE"

Sample of RGB triplet [0.3010 0.7450 0.9330], which appears as light blue

[0.6350 0.0780 0.1840]"#A2142F"

Sample of RGB triplet [0.6350 0.0780 0.1840], which appears as dark red

対話機能

すべて展開する

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

  • 'on' — オブジェクトを表示します。

  • 'off' — オブジェクトを削除せずに非表示にします。非表示の UI コンポーネントのプロパティには引き続きアクセスできます。

アプリの起動を高速化するには、起動時に表示する必要のないすべての UI コンポーネントの Visible プロパティを 'off' に設定します。

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

  • このプロパティを 'on' に設定した場合、アプリ ユーザーはコンポーネントを操作できます。

  • このプロパティを 'off' に設定した場合、コンポーネントはグレー表示されます。これは、アプリ ユーザーがコンポーネントを操作することができず、コンポーネントはコールバックをトリガーしないことを示します。

このプロパティを設定してもこのタイプのオブジェクトには影響しません。

コールバック

すべて展開する

メニューで選択されているコールバック関数。次の値のいずれかとして指定します。

  • 関数ハンドル。

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

  • 有効な MATLAB 式を含む文字ベクトル (非推奨)。MATLAB は、この式をベース ワークスペースで評価します。

コールバックのプロパティ値を関数ハンドル、cell 配列または文字ベクトルとして指定する方法の詳細については、コールバック関数の指定を参照してください。

コールバックは、メニュー項目の位置および操作のタイプに従って応答します。

  • メニューを左クリックすると、メニューが展開し、そのコールバックがトリガーされます。

  • いずれかのメニューが展開しているときに他の親メニュー (または最上位メニュー) をポイントすると、そのメニューが展開し、そのコールバックがトリガーされます。

メモ

メニュー項目を動的に変更するためにコールバックを使用しないでください。コールバックでメニュー項目の削除、追加、および置き換えを行うと、メニューが空白になることがあります。代わりに、Visible プロパティを使用してメニュー項目の非表示と表示を設定します。また、Enable プロパティを設定してメニュー項目の有効化や無効化を行うこともできます。メニュー項目を完全に埋めるには、これらの項目を削除して、コールバックの外部に作成してください。

コンテキスト メニューに関連付けられたメニュー

Figure ウィンドウの上部にあるメニュー項目ではなくコンテキスト メニューにメニュー コンポーネントが関連付けられている場合、このコールバック関数は、ユーザーのアプリ操作に関する特定の情報にアクセスできます。MATLAB は、この情報を MenuSelectedData オブジェクトに格納して、2 番目の引数としてコールバック関数に渡します。App Designer では、引数は event という名前です。ドット表記を使用して、オブジェクトのプロパティをクエリできます。たとえば、event.ContextObject は、関連付けられているコンテキスト メニューを開くためにユーザーが右クリックしたコンポーネントに関する情報を返します。

メモ

任意の Menu オブジェクトに対して MenuSelectedFcn コールバックを指定できます。ただし、コールバック イベント データの MenuSelectedData オブジェクトは、メニューが属しているコンテキスト メニューが以下の両方の条件を満たしている場合にのみ使用可能です。

  • コンテキスト メニューが uifigure ベースのアプリ (App Designer で作成されたアプリなど) に関連付けられている。

  • Axes オブジェクトや Line オブジェクトなどのグラフィックス オブジェクトではなく UI コンポーネントにコンテキスト メニューが関連付けられている。

次の表に、MenuSelectedData オブジェクトのプロパティを示します。

プロパティ
ContextObjectアプリ ユーザーがコンテキスト メニューを開くために右クリックしたオブジェクト
InteractionInformation

アプリ ユーザーがコンテキスト メニューを開くために右クリックしたコンポーネント内の位置に関する情報。この情報は、ContextObject の値に応じて異なるプロパティをもつオブジェクトとして格納されます。

たとえば、ContextObjectTable オブジェクトの場合、InteractionInformation は、ユーザーが右クリックしたテーブル内の行と列に関する情報を格納します。InteractionInformation がもつことのできるプロパティの詳細については、次の表を参照してください。

Sourceコールバックを実行するコンテキスト メニュー オブジェクト
EventName'MenuSelected'

次の表に、InteractionInformation オブジェクトのプロパティを示します。プロパティは、アプリ ユーザーがコンテキスト メニューを開くために右クリックしたオブジェクトによって異なります。

ContextObjectInteractionInformation プロパティ
任意Location

ContextObject の親コンテナーの左下隅を基準とした、ユーザーが右クリックした位置。[x y] の形式の 2 要素ベクトルとして返されます。

x の値は、親コンテナーの左端から右クリック位置までの水平距離を表します。y の値は、親コンテナーの下端から右クリック位置までの垂直距離を表します。距離はピクセル単位で測定されます。

ScreenLocation

プライマリ ディスプレイの左下隅を基準とした、ユーザーが右クリックした位置。[x y] の形式の 2 要素ベクトルとして返されます。

x の値は、ディスプレイの左端から右クリック位置までの水平距離を表します。y の値は、ディスプレイの下端から右クリック位置までの垂直距離を表します。距離はピクセル単位で測定されます。

TableDisplayRow

ユーザーの右クリック位置に視覚的に表示されているテーブルの行。数値スカラーとして返されます。

ユーザーがテーブルを並べ替えていない場合、DisplayRow の値は Row と同じになります。ユーザーが右クリックしたテーブル UI コンポーネントの領域が行に関連付けられていない場合、DisplayRow は空の配列になります。

DisplayColumn

ユーザーの右クリック位置に視覚的に表示されているテーブルの列。数値スカラーとして返されます。

ユーザーがテーブルを再配列していない場合、DisplayColumn の値は Column と同じになります。ユーザーが右クリックしたテーブル UI コンポーネントの領域が列に関連付けられていない場合、DisplayColumn は空の配列になります。

Row

ユーザーの右クリック位置に対応する元のテーブル データの行。数値スカラーとして返されます。

ユーザーがテーブルを並べ替えていない場合、Row の値は DisplayRow と同じになります。ユーザーが右クリックしたテーブル UI コンポーネントの領域が行に関連付けられていない場合、Row は空の配列になります。

Column

ユーザーの右クリック位置に対応する元のテーブル データの列。数値スカラーとして返されます。

ユーザーがテーブルを再配列していない場合、Column の値は DisplayColumn と同じになります。ユーザーが右クリックしたテーブル UI コンポーネントの領域が列に関連付けられていない場合、Column は空の配列になります。

RowHeaderユーザーがテーブルの行ヘッダーを右クリックしたかどうか。logical 0 (false) または logical 1 (true) として返されます。
ColumnHeaderユーザーがテーブルの列ヘッダーを右クリックしたかどうか。logical 0 (false) または logical 1 (true) として返されます。
TreeNode

右クリックされたノード。TreeNode オブジェクトとして返されます。

ユーザーが右クリックしたツリーの領域がノードに関連付けられていない場合、Node は空の配列になります。

Level

右クリックされたノードのレベル。数値スカラーとして返されます。Tree オブジェクトを直接の親とするノードがレベル 1、レベル 1 のノードを親とするノードがレベル 2 となり、以下同様に続きます。

ユーザーが右クリックしたツリーの領域がノードに関連付けられていない場合、Level は空の配列になります。

ListBoxItem

右クリックされたリスト ボックス項目のインデックス。数値スカラーとして返されます。

ユーザーが右クリックしたリスト ボックスの領域が項目に関連付けられていない場合、Item は空の配列になります。

オブジェクト作成関数。次の値のいずれかとして指定します。

  • 関数ハンドル。

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

  • 有効な MATLAB 式を含む文字ベクトル (非推奨)。MATLAB は、この式をベース ワークスペースで評価します。

コールバックを関数ハンドル、cell 配列、または文字ベクトルとして指定する方法の詳細については、App Designer のコールバックを参照してください。

このプロパティは、MATLAB がオブジェクトを作成するときに実行されるコールバック関数を指定します。MATLAB は CreateFcn コールバックを実行する前に、すべてのプロパティ値を初期化します。CreateFcn プロパティを指定しない場合、MATLAB は既定の作成関数を実行します。

既存のコンポーネントに CreateFcn プロパティを設定しても効果はありません。

このプロパティを関数ハンドルまたは cell 配列として指定した場合、コールバック関数の最初の引数を使用して、作成中のオブジェクトにアクセスできます。それ以外の場合は、関数 gcbo を使用してオブジェクトにアクセスします。

オブジェクト削除関数。次の値のいずれかとして指定します。

  • 関数ハンドル。

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

  • 有効な MATLAB 式を含む文字ベクトル (非推奨)。MATLAB は、この式をベース ワークスペースで評価します。

コールバックを関数ハンドル、cell 配列、または文字ベクトルとして指定する方法の詳細については、App Designer のコールバックを参照してください。

このプロパティは、MATLAB がオブジェクトを削除するときに実行されるコールバック関数を指定します。MATLAB は、オブジェクトのプロパティを破棄する前に DeleteFcn コールバックを実行します。DeleteFcn プロパティを指定しない場合、MATLAB は既定の削除関数を実行します。

このプロパティを関数ハンドルまたは cell 配列として指定した場合、コールバック関数の最初の引数を使用して、削除されるオブジェクトにアクセスできます。それ以外の場合は、関数 gcbo を使用してオブジェクトにアクセスします。

コールバック実行制御

すべて展開する

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

このプロパティは実行中のコールバックが割り込み可能かどうかを決定します。次の 2 つのコールバックの状態について考慮する必要があります。

  • "実行中" コールバックは、現在実行しているコールバックです。

  • "割り込み" コールバックは、実行中のコールバックに割り込もうとするコールバックです。

MATLAB は、コールバック キューを処理するコマンドを実行するたびにコールバックの割り込み動作を判別します。これらのコマンドには、drawnowfigureuifiguregetframewaitforpause があります。

実行中コールバックにこれらのコマンドが含まれていない場合、割り込みは発生しません。MATLAB は、実行中コールバックの実行を先に終了させ、その後に割り込みコールバックを実行します。

実行中コールバックにこれらのいずれかのコマンドが含まれている場合、実行中コールバックを所有するオブジェクトの Interruptible プロパティに応じて割り込みが発生するかどうかが決まります。

  • Interruptible の値が 'off' の場合、割り込みは発生しません。代わりに、割り込みコールバックを所有するオブジェクトの BusyAction プロパティに応じて、割り込みコールバックが破棄されるかコールバック キューに追加されるかが決まります。

  • Interruptible の値が 'on' の場合、割り込みが発生します。MATLAB は、コールバック キューの次回処理時に、実行中コールバックの実行を停止し、割り込みコールバックを実行します。割り込みコールバックが完了した後、MATLAB は実行中だったコールバックの実行を再開します。

メモ

コールバックの割り込みと実行は、以下の状況では動作が異なります。

  • 割り込みコールバックが DeleteFcnCloseRequestFcn または SizeChangedFcn コールバックの場合、Interruptible プロパティの値にかかわらず割り込みが発生します。

  • 実行中のコールバックが関数 waitfor を現在実行している場合、Interruptible プロパティの値にかかわらず割り込みが発生します。

  • 割り込みコールバックが Timer オブジェクトで所有されている場合、Interruptible プロパティの値にかかわらずスケジュールに従ってコールバックが実行されます。

メモ

MATLAB は、割り込みが発生したときにプロパティの状態や表示を保存しません。たとえば、gca コマンドや gcf コマンドから返されたオブジェクトは、別のコールバックを実行するときに変更されている可能性があります。

コールバック キューイング。'queue' または 'cancel' として指定します。BusyAction プロパティは MATLAB による割り込みコールバックの実行の処理方法を決定します。次の 2 つのコールバックの状態について考慮する必要があります。

  • "実行中" コールバックは、現在実行しているコールバックです。

  • "割り込み" コールバックは、実行中のコールバックに割り込もうとするコールバックです。

BusyAction プロパティによってコールバック キューイングの動作が決まるのは、次の両方の条件を満たす場合のみです。

  • 実行中コールバックに drawnowfigureuifiguregetframewaitforpause などのコールバック キューを処理するコマンドが含まれている。

  • 実行中コールバックを所有するオブジェクトの Interruptible プロパティの値が 'off' である。

これらの条件に当てはまる場合、割り込みコールバックを所有するオブジェクトの BusyAction プロパティに応じて MATLAB による割り込みコールバックの処理方法が決まります。BusyAction プロパティは次の値を取ることができます。

  • 'queue' — 割り込みコールバックをキューに入れ、実行中のコールバックが終了した後に処理されるようにします。

  • 'cancel' — 割り込みコールバックを実行しません。

この プロパティ は読み取り専用です。

削除状態。matlab.lang.OnOffSwitchState 型の on/off logical 値として返されます。

MATLAB は、DeleteFcn コールバックが実行を開始すると、BeingDeleted プロパティを 'on' に設定します。コンポーネント オブジェクトが存在しなくなるまで BeingDeleted プロパティは 'on' に設定されたままです。

クエリや変更の前にオブジェクトが削除されようとしていないか確認するために BeingDeleted プロパティの値をチェックします。

親/子

すべて展開する

親オブジェクト。関数 uifigure を使用して作成された Figure オブジェクト、別の Menu オブジェクト、または ContextMenu オブジェクトとして指定します。このプロパティを設定することで、メニュー項目を別のウィンドウまたは別のメニューに移動できます。親を既存の Menu オブジェクトとして指定して、メニュー項目をメニューに追加するか、またはメニュー項目を入れ子にします。

メニューの子。空の GraphicsPlaceholder または Menu オブジェクトの 1 次元配列として返されます。

Children プロパティを使用して、子コンポーネントの追加または削除を行うことはできません。このプロパティは、子のリストの表示や子メニュー項目の並べ替えに使用します。

子メニューをこのリストに追加するには、別の Menu オブジェクトの Parent プロパティをこの Menu オブジェクトに設定します。

オブジェクト ハンドルの可視性。'on''callback' または 'off' として指定します。

このプロパティは、オブジェクトの親がもつ子のリストにおけるそのオブジェクトの可視性を制御します。オブジェクトがその親オブジェクトのリストで、子として可視できない場合、オブジェクト階層の検索またはプロパティのクエリによってオブジェクトを取得する関数は、そのオブジェクトを返しません。これらの関数には、getfindobjclf および close が含まれます。オブジェクトは参照できない場合も有効です。オブジェクトにアクセスできる場合は、そのプロパティを設定および取得して、それをオブジェクトに作用する任意の関数に渡すことができます。

HandleVisibility の値説明
'on' オブジェクトは常に参照できます。
'callback'オブジェクトはコールバック内から、あるいはコールバックにより呼び出される関数から参照できます。しかし、コマンド ラインから呼び出される関数からは参照できません。このオプションを使用すると、コマンド ラインからのオブジェクトへのアクセスがブロックされますが、コールバック関数からのアクセスは許可されます。
'off'オブジェクトは常に参照できません。このオプションは、他の関数による UI の意図しない変更を防止するために役立ちます。HandleVisibility'off' に設定すると、その関数の実行中にオブジェクトが一時的に非表示になります。

識別子

すべて展開する

この プロパティ は読み取り専用です。

グラフィックス オブジェクトのタイプ。'uimenu' として返されます。

オブジェクト識別子。文字ベクトルまたは string スカラーとして指定します。オブジェクトの識別子として機能する一意の Tag 値を指定できます。コードの他の部分からオブジェクトにアクセスする必要がある場合、関数 findobj を使用して Tag 値に基づいてオブジェクトを検索できます。

ユーザー データ。任意の MATLAB 配列として指定します。たとえば、スカラー、ベクトル、行列、cell 配列、文字配列、table、または構造体を指定できます。このプロパティを使用して、任意のデータをオブジェクトに保存します。

App Designer を使用している場合は、UserData プロパティを使用する代わりに、アプリでパブリック プロパティまたはプライベート プロパティを作成してデータを共有します。詳細については、App Designer アプリ内でのデータの共有を参照してください。

uifigure ベースのアプリのみ

すべて展開する

メモ

このプロパティは、App Designer 内および関数 uifigure を使用して作成されたアプリ内のメニューでのみ有効です。

ツールヒント。文字ベクトル、文字ベクトルの cell 配列、string 配列、または 1 次元の categorical 配列として指定します。このプロパティを使用して、実行時にユーザーがポインターをコンポーネントに合わせるとメッセージが表示されるようにします。複数行のテキストを表示するには、文字ベクトルの cell 配列または string 配列を指定します。配列の各要素は、テキストの各行になります。このプロパティを categorical 配列として指定した場合、MATLAB はカテゴリの完全なセットではなく、配列内の値を使用します。

バージョン履歴

R2006a より前に導入

すべて展開する