uicontextmenu

创建上下文菜单组件

全页折叠

语法

cm = uicontextmenu

cm = uicontextmenu(parent)

cm = uicontextmenu(___,Name,Value)

说明

cm = uicontextmenu 在当前图窗中创建一个上下文菜单，并返回 ContextMenu 对象。如果图窗不存在，则 MATLAB^® 调用 figure 函数以创建一个图窗。

要使该上下文菜单能够在图窗中打开，您还必须执行以下步骤：

将该上下文菜单分配给同一图窗中的 UI 组件或图形对象。
在该上下文菜单中创建至少一个子级 Menu 对象。

cm = uicontextmenu(parent) 在指定的父图窗中创建上下文菜单。父级可以是使用 uifigure 或 figure 函数创建的图窗。

示例

cm = uicontextmenu(___,Name,Value) 使用一个或多个名称-值参量指定 ContextMenu 属性。例如，uicontextmenu("ContextMenuOpeningFcn",@myfunction) 创建一个上下文菜单，当用户打开该上下文菜单时，该菜单执行 myfunction。可将此选项与上述语法中的任何输入参量组合一起使用。

示例

全部折叠

为 UI 图窗创建上下文菜单

在 UI 图窗中创建一个具有两个菜单项的上下文菜单。通过将图窗的 ContextMenu 属性设置为 ContextMenu 对象，将该上下文菜单分配给图窗本身。要查看上下文菜单，请右键点击图窗窗口中的任意位置。

fig = uifigure;

cm = uicontextmenu(fig);
m1 = uimenu(cm,"Text","Menu1");
m2 = uimenu(cm,"Text","Menu2");

fig.ContextMenu = cm;

Context menu with two options: "Menu1" and "Menu2"

为 UI 组件创建上下文菜单

创建具有一个按钮的 UI 图窗。然后，在该图窗中创建一个包含两个菜单项的上下文菜单，并将该上下文菜单分配给该按钮。要查看上下文菜单，请右键点击该按钮。

fig = uifigure;
btn = uibutton(fig);

cm = uicontextmenu(fig);
m1 = uimenu(cm,"Text","Option 1");
m2 = uimenu(cm,"Text","Option 2");

btn.ContextMenu = cm;

Context menu for a button with two options: "Option 1" and "Option 2"

编写响应以下操作的代码：上下文菜单打开

创建这样一个上下文菜单，每次打开该上下文菜单时都会在命令行窗口中显示一条消息。

在图窗中创建一个线图。然后，创建包含一个菜单项的上下文菜单，并将该菜单分配给线图。创建一个 ContextMenuOpeningFcn 回调函数，它在每次上下文菜单打开时在命令行窗口中显示输出。

f = figure;
cm = uicontextmenu(f);
m = uimenu(cm,"Text","Menu1");
cm.ContextMenuOpeningFcn = @(src,event)disp("Context menu opened");
p = plot(1:10,"ContextMenu",cm);

要查看上下文菜单，请右键点击绘图线条。当上下文菜单打开时，命令行窗口显示 Context menu opened。

The context menu with a menu item called "Menu1" displays on the plot line.

编写响应以下操作的代码：上下文菜单选择

自 R2023b 起

创建一个显示超链接的 App，并允许用户使用上下文菜单将链接 URL 复制到剪贴板。

在名为 hyperlinkApp.m 的文件中，编写实现该 App 的函数：

创建一个 UI 图窗和一个网格布局管理器，以对该 App 进行布局。
在网格布局管理器中创建两个超链接。
创建一个具有 Copy Hyperlink 菜单项的上下文菜单，并将该上下文菜单分配给两个超链接。
编写一个名为 copyHyperlink 的回调函数。在该回调函数中，通过使用 event.ContextObject 事件数据访问右键点击的 Hyperlink 对象，然后将 URL 复制到剪贴板。将该函数赋给菜单项的 MenuSelectedFcn 回调属性。有关回调的详细信息，请参阅Create Callbacks for Apps Created Programmatically。

function hyperlinkApp
fig = uifigure;
g = uigridlayout(fig,[2, 1]);
g.RowHeight = {'fit','fit'};

hlink1 = uihyperlink(g);
hlink1.Text = "MathWorks Home";
hlink1.URL = "https://www.mathworks.com/";
hlink2 = uihyperlink(g);
hlink2.Text = "MATLAB App Building";
hlink2.URL = "https://www.mathworks.com/products/matlab/app-designer.html";

cm = uicontextmenu(fig);
m = uimenu(cm);
m.Text = "Copy Hyperlink";
hlink1.ContextMenu = cm;
hlink2.ContextMenu = cm;

m.MenuSelectedFcn = @copyHyperlink;
end

function copyHyperlink(src,event)
url = event.ContextObject.URL;
clipboard("copy",url)
end

在 R2023b 之前的版本中: 编写回调函数，以通过查询图窗的 CurrentObject 属性（而不是使用 event.ContextObject 事件数据）访问右键点击的 Hyperlink 对象。

运行 hyperlinkApp 函数。右键点击其中一个超链接，然后选择 Copy Hyperlink 来复制链接 URL。

显示特定表单元格的上下文菜单

自 R2023b 起

创建一个 App，它显示一个表并允许用户使用上下文菜单项删除行。对上下文菜单项进行编程，使其仅在用户右键点击表数据行时出现。

在名为 tableApp.m 的文件中，编写实现该 App 的函数：

创建一个 UI 图窗并用一些随机数据创建一个表 UI 组件。
创建一个具有 Delete Row 菜单项的上下文菜单，并将该上下文菜单分配给表。
编写两个回调函数来响应上下文菜单操作：
- deleteRow - 查询右键点击的表行，然后删除该行。
- toggleVisibility - 当用户右键点击一个表数据行时显示 Delete Row 菜单项，否则隐藏该项。
在每个回调中，使用 event.InteractionInformation 回调事件数据来访问有关用户在表中为打开上下文菜单而右键点击的位置的信息。
将 deleteRow 函数赋给该菜单项的 MenuSelectedFcn 回调属性，将 toggleVisibility 函数赋给上下文菜单的 ContextMenuOpeningFcn 回调属性。有关回调的详细信息，请参阅Create Callbacks for Apps Created Programmatically。

function tableApp
fig = uifigure;
tbl = uitable(fig);
tbl.Position = [20 20 400 300];
tbl.Data = randi(10,[10 4]);

cm = uicontextmenu(fig);
m = uimenu(cm);
m.Text = "Delete Row";
tbl.ContextMenu = cm;

m.MenuSelectedFcn = @deleteRow;
cm.ContextMenuOpeningFcn = @(src,event)toggleVisibility(src,event,m);
end

function deleteRow(src,event)
tbl = event.ContextObject;
row = event.InteractionInformation.Row;
tbl.Data(row,:) = [];
end

function toggleVisibility(src,event,m)
row = event.InteractionInformation.Row;
rowClicked = ~isempty(row);
m.Visible = rowClicked;
end

运行 tableApp 函数，然后右键点击该表。仅当右键点击表行时，上下文菜单才会出现。选择 Delete Row 项以删除右键点击的行。

UI figure window with a table. A context menu with a "Delete Row" item is visible over a table row header and the pointer is pointing to the menu item.

存储在 event.InteractionInformation 属性中的特定回调事件数据取决于用户为打开上下文菜单而右键点击的 UI 组件。有关详细信息，请参阅关于 Menu 和 ContextMenu 的回调属性描述。

跨树节点共享上下文菜单

自 R2023b 起

为树组件创建一个上下文菜单。根据用户右键点击的树节点级别自定义上下文菜单操作。

在当前文件夹的新脚本中，创建一个 UI 图窗。然后，创建一个树，其中包含四个顶层节点和一组嵌套节点。

fig = uifigure;

t = uitree(fig,"Position",[20 200 175 100]);

category1 = uitreenode(t,"Text","Runners");
r1 = uitreenode(category1,"Text","Joe");
r2 = uitreenode(category1,"Text","Linda");

category2 = uitreenode(t,"Text","Cyclists");
c1 = uitreenode(category2,"Text","Rajeev");

category3 = uitreenode(t,"Text","Hikers");
h1 = uitreenode(category3,"Text","Jack");

category4 = uitreenode(t,"Text","Swimmers");
s1 = uitreenode(category4,"Text","Logan");

UI figure window with a tree that has four collapsed top-level nodes

创建一个上下文菜单，其中包含一个菜单项和两个子菜单，用户可以点击该上下文菜单来展开单个树节点或所有树节点。对于每个子菜单，指定当用户选择菜单选项时要执行的 MenuSelectedFcn 回调函数。

cm = uicontextmenu(fig);
m1 = uimenu(cm,"Text","Expand...");

sbm1 = uimenu(m1,"Text","This Node", ...
    "MenuSelectedFcn",@expandSingle);
sbm2 = uimenu(m1,"Text","All Nodes", ...
    "MenuSelectedFcn",@expandAll);

通过将每个节点的 ContextMenu 属性设置为 ContextMenu 对象，将上下文菜单分配给顶层树节点。

category1.ContextMenu = cm;
category2.ContextMenu = cm;
category3.ContextMenu = cm;
category4.ContextMenu = cm;

在文件的底部，定义 expandSingle 和 expandAll 回调函数。定义函数来接受 MATLAB 传递给所有回调函数的源和事件数据。使用 event.InteractionInformation 和 event.ContextObject 属性来访问有关用户为打开上下文菜单而右键点击的位置的信息。

function expandSingle(src,event)
node = event.InteractionInformation.Node;
expand(node)
end

function expandAll(src,event,t)
n = event.ContextObject;
t = ancestor(n,"uitree");
expand(t)
end

保存并运行脚本。右键点击任一顶层树节点可查看上下文菜单。

UI figure window with a tree that has four collapsed top-level nodes. Over the "Cyclists" node, a context menu with an "Expand" menu item and two submenu items, "This Node" and "All Nodes", is visible. The pointer is pointing to the "All Nodes" item.

输入参数

全部折叠

`parent` — 父图窗
`Figure` 对象

父图窗，指定为使用 uifigure 或 figure 函数创建的 Figure 对象。如果您没有指定父图窗，则 MATLAB 调用 figure 函数来创建一个作为父图窗的 Figure 对象。

名称-值参数

全部折叠

将可选的参量对组指定为 Name1=Value1,...,NameN=ValueN，其中 Name 是参量名称，Value 是对应的值。名称-值参量必须出现在其他参量之后，但参量对组的顺序无关紧要。

示例: uicontextmenu(ContextMenuOpeningFcn=@myfunction) 创建当用户打开上下文菜单时执行 myfunction 的上下文菜单。

在 R2021a 之前，使用逗号分隔每个名称和值，并用引号将 Name 引起来。

示例: uicontextmenu("ContextMenuOpeningFcn",@myfunction) 创建当用户打开上下文菜单时执行 myfunction 的上下文菜单。

注意

此处所列的属性只是一部分。有关完整列表，请参阅 ContextMenu。

`ContextMenuOpeningFcn` — 上下文菜单打开回调函数
`''` (默认) | 函数句柄 | 元胞数组 | 字符向量

上下文菜单打开回调函数，指定为下列值之一：

函数句柄。
第一个元素是函数句柄的元胞数组。元胞数组中的后续元素是传递到回调函数的参量。
包含有效 MATLAB 表达式的字符向量（不推荐）。MATLAB 在基础工作区计算此表达式。

有关将回调属性值指定为函数句柄、元胞数组或字符向量的详细信息，请参阅Specify a Callback Function。

此回调函数在上下文菜单打开以响应用户交互时执行。您可以使用此回调函数根据用户右键点击的内容来自定义上下文菜单的外观。

此回调函数可以访问有关用户与 App 的交互的特定信息。MATLAB 将 ContextMenuOpeningData 对象中的此信息作为第二个参量传递给回调函数。在 App 设计工具中，该参量名为 event。您可以使用圆点表示法查询对象属性。例如，event.ContextObject 返回有关用户打开上下文菜单时右键点击的组件的信息。

注意

虽然您可以为任何上下文菜单指定 ContextMenuOpeningFcn 回调，但回调事件数据中的 ContextMenuOpeningData 对象仅在上下文菜单满足以下两个条件时才可用：

上下文菜单与基于 uifigure 的 App 相关联（例如在 App 设计工具中创建的 App）。
上下文菜单与 UI 组件（而不是图形对象，如 Axes 或 Line 对象）相关联，或与仅包含 UI 组件的容器相关联。

下表列出了 ContextMenuOpeningData 对象的属性。

属性	值
`ContextObject`	App 用户打开上下文菜单时右键点击的对象
`InteractionInformation`	有关 App 用户在组件中打开上下文菜单时右键点击的位置的信息。根据 `ContextObject` 的值，此信息存储为具有不同属性的对象。例如，如果 `ContextObject` 是 `Table` 对象，则 `InteractionInformation` 存储有关用户右键点击的表中的行和列的信息。有关 `InteractionInformation` 可以具有的属性的更多详细信息，请参阅下面的表。
`Source`	执行回调的上下文菜单对象
`EventName`	`'ContextMenuOpening'`

下表列出了 InteractionInformation 对象的属性。这些属性取决于 App 用户打开上下文菜单时右键点击的对象。

`ContextObject`	`InteractionInformation` 属性	值
任一值	`Location`	用户右键点击的位置相对于 `ContextObject` 的父容器左下角的位置，以 `[x y]` 二元素向量形式返回。 `x` 的值表示从父容器的左边缘到右键点击位置的水平距离。`y` 的值表示从父容器的下边缘到右键点击位置的垂直距离。距离的测量单位为像素。
任一值	`ScreenLocation`	用户右键点击的位置相对于其主显示画面左下角的位置，以 `[x y]` 二元素向量形式返回。 `x` 的值表示从显示画面左边缘到右键点击位置的水平距离。`y` 的值表示从显示画面的下边缘到右键点击位置的垂直距离。距离的测量单位为像素。
`Table`	`DisplayRow`	用户右键点击的在表中直观显示的行，以数值标量形式返回。如果用户没有对表进行排序，则 `DisplayRow` 的值与 `Row` 的值相同。如果用户右键点击了表 UI 组件中与行无关的区域，则 `DisplayRow` 为空数组。
	`DisplayColumn`	用户右键点击的在表中直观显示的列，以数值标量形式返回。如果用户没有重新排列表，则 `DisplayColumn` 的值与 `Column` 的值相同。如果用户右键点击了表 UI 组件中与列无关的区域，则 `DisplayColumn` 为空数组。
	`Row`	用户右键点击的对应于原始表数据的行，以数值标量形式返回。如果用户没有对表进行排序，则 `Row` 的值与 `DisplayRow` 的值相同。如果用户右键点击了表 UI 组件中与行无关的区域，则 `Row` 为空数组。
	`Column`	用户右键点击的对应于原始表数据的列，以数值标量形式返回。如果用户没有重新排列表，则 `Column` 的值与 `DisplayColumn` 的值相同。如果用户右键点击了表 UI 组件中与列无关的区域，则 `Column` 为空数组。
	`RowHeader`	用户是否右键点击了表的行标题，以逻辑值 `0` (`false`) 或 `1` (`true`) 形式返回。
	`ColumnHeader`	用户是否右键点击了表的列标题，以逻辑值 `0` (`false`) 或 `1` (`true`) 形式返回。
`Tree`	`Node`	右键点击的节点，以 `TreeNode` 对象形式返回。如果用户右键点击了树中未关联到节点的区域，则 `Node` 是空数组。
`Tree`	`Level`	所右键点击节点的级别，以数值标量形式返回。`Tree` 对象的直接父节点位于第 1 级，第 1 级节点的父节点位于第 2 级，依此类推。如果用户右键点击了树中未关联到节点的区域，则 `Level` 是空数组。
`ListBox`	`Item`	右键点击的列表框项的索引，以数值标量形式返回。如果用户右键点击了列表框中与项无关的区域，则 `Item` 为空数组。

`Children` — 上下文菜单子级
空 `GraphicsPlaceholder` 数组 (默认) | `Menu` 对象的向量

上下文菜单子级，以空的 GraphicsPlaceholder 或 Menu 对象的向量形式返回。

不能使用 Children 属性添加或删除子级。可以使用此属性查看子级列表或对子菜单项重新排序。子级在此数组中的顺序与菜单项在打开的上下文菜单中出现的顺序相反。

例如，以下代码创建三个上下文菜单。当您在运行的 App 中打开上下文菜单时，Menu1 将作为第一个菜单选项出现。

fig = uifigure;
cm = uicontextmenu(fig);
m1 = uimenu(cm,'Text','Menu1');
m2 = uimenu(cm,'Text','Menu2');
m3 = uimenu(cm,'Text','Menu3');
fig.ContextMenu = cm;

cm.Children 以相反顺序返回菜单项列表。

cm.Children

ans = 

  3×1 Menu array:

  Menu    (Menu3)
  Menu    (Menu2)
  Menu    (Menu1)

HandleVisibility 属性设置为 'off' 的对象不会列在 Children 属性中。

要向此列表添加子级，请将另一个 Menu 对象的 Parent 属性设置为此 ContextMenu 对象。

提示

要在运行的 App 中显示一个上下文菜单，该上下文菜单必须：
- 有至少一个菜单项。
- 分配给同一图窗中的 UI 组件或图形对象。
要以编程方式打开一个上下文菜单，请使用 open 函数。上下文菜单必须为使用 uifigure 函数创建的图窗的子级。要显示上下文菜单，它必须有至少一个用 uimenu 函数创建的菜单项。
要以交互方式打开一个上下文菜单，当与该上下文菜单相关联的组件具有焦点时，您可以使用键盘快捷方式 Shift+F10 打开该上下文菜单。

版本历史记录

在 R2006a 之前推出

全部展开

R2023b: 访问有关用于打开上下文菜单的操作的信息

当 ContextMenuOpeningFcn 回调与 UI 组件上的一个上下文菜单相关联时，该回调具有附加事件数据。使用此数据在 App 中自定义和共享上下文菜单。

事件数据属性	描述
`ContextObject`	App 用户打开上下文菜单时右键点击的对象
`InteractionInformation`	有关 App 用户在组件中打开上下文菜单时右键点击的位置的信息，例如表的单元格

R2023b: 当右键点击树中的任意位置时，会出现关于树的上下文菜单

如果您创建一个上下文菜单并将其分配给 Tree 对象，则右键点击树中的任何位置，包括具有树节点的区域，都会出现该上下文菜单。通过在树上设置上下文菜单，而不是在每个单独的树节点上设置上下文菜单，可以使树中的所有节点都支持该上下文菜单。

如果您在单个 TreeNode 对象上设置一个上下文菜单，则当您右键点击该节点时，树节点上下文菜单仍会出现，即使 Tree 对象有已分配的上下文菜单。

以前，仅当您右键点击树节点下的树部分时，树的上下文菜单才会出现。要保持此行为，请创建一个 ContextMenuOpeningFcn 回调；仅当右键点击不包含树节点的区域时，该回调才会显示上下文菜单。

fig = uifigure;
cm = uicontextmenu(fig,ContextMenuOpeningFcn=@hideMenu);
m1 = uimenu(cm,Text="Menu Item");
t = uitree(fig,ContextMenu=cm);
n1 = uitreenode(t);
 
function hideMenu(src,event)
if isprop(event.InteractionInformation,"Node")
    src.Visible = "off";
end
end

另请参阅

uicontextmenu

语法

说明

示例

为 UI 图窗创建上下文菜单

为 UI 组件创建上下文菜单

编写响应以下操作的代码：上下文菜单打开

编写响应以下操作的代码：上下文菜单选择

显示特定表单元格的上下文菜单

跨树节点共享上下文菜单

输入参数

parent — 父图窗 Figure 对象

名称-值参数

ContextMenuOpeningFcn — 上下文菜单打开回调函数 '' (默认) | 函数句柄 | 元胞数组 | 字符向量

Children — 上下文菜单子级 空 GraphicsPlaceholder 数组 (默认) | Menu 对象的向量

提示

版本历史记录

R2023b: 访问有关用于打开上下文菜单的操作的信息

R2023b: 当右键点击树中的任意位置时，会出现关于树的上下文菜单

另请参阅

函数

属性

主题

`parent` — 父图窗
`Figure` 对象

`ContextMenuOpeningFcn` — 上下文菜单打开回调函数
`''` (默认) | 函数句柄 | 元胞数组 | 字符向量

`Children` — 上下文菜单子级
空 `GraphicsPlaceholder` 数组 (默认) | `Menu` 对象的向量