Main Content

本页翻译不是最新的。点击此处可查看最新英文版本。

ContextMenu 属性

控制上下文菜单的外观和行为

上下文菜单是当您右键点击图形对象或 UI 组件时出现的菜单。使用 uicontextmenu 函数创建上下文菜单并设置属性。通过更改属性值,可以修改上下文菜单的外观和行为。使用圆点表示法引用特定上下文菜单对象和属性。您可以将使用 uifigurefigure 函数创建的图窗作为上下文菜单的父级。

fig = uifigure;
cm = uicontextmenu(fig);
m = uimenu(cm,'Text','Go To File');
fig.ContextMenu = cm;

回调

全部展开

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

  • 函数句柄。

  • 第一个元素是函数句柄的元胞数组。元胞数组中的后续元素是传递到回调函数的参量。

  • 包含有效 MATLAB® 表达式的字符向量(不推荐)。MATLAB 在基础工作区计算此表达式。

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

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

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

注意

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

  • 上下文菜单与基于 uifigure 的 App 相关联(例如在 App 设计工具中创建的 App)。

  • 上下文菜单与 UI 组件(而不是图形对象,如 AxesLine 对象)相关联。

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

属性
ContextObjectApp 用户打开上下文菜单时右键点击的对象
InteractionInformation

有关 App 用户在组件中打开上下文菜单时右键点击的位置的信息。根据 ContextObject 的值,此信息存储为具有不同属性的对象。

例如,如果 ContextObjectTable 对象,则 InteractionInformation 存储有关用户右键点击的表中的行和列的信息。有关 InteractionInformation 可以具有的属性的更多详细信息,请参阅下面的表。

Source执行回调的上下文菜单对象
EventName'ContextMenuOpening'

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

ContextObjectInteractionInformation 属性
任一值Location

用户右键点击的位置相对于 ContextObject 的父容器左下角的位置,以 [x y] 二元素向量形式返回。

x 的值表示从父容器的左边缘到右键点击位置的水平距离。y 的值表示从父容器的下边缘到右键点击位置的垂直距离。距离的测量单位为像素。

ScreenLocation

用户右键点击的位置相对于其主显示画面左下角的位置,以 [x y] 二元素向量形式返回。

x 的值表示从显示画面左边缘到右键点击位置的水平距离。y 的值表示从显示画面的下边缘到右键点击位置的垂直距离。距离的测量单位为像素。

TableDisplayRow

用户右键点击的在表中直观显示的行,以数值标量形式返回。

如果用户没有对表进行排序,则 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) 形式返回。
TreeNode

右键点击的节点,以 TreeNode 对象形式返回。

如果用户右键点击了树中未关联到节点的区域,则 Node 是空数组。

Level

所右键点击节点的级别,以数值标量形式返回。Tree 对象的直接父节点位于第 1 级,第 1 级节点的父节点位于第 2 级,依此类推。

如果用户右键点击了树中未关联到节点的区域,则 Level 是空数组。

ListBoxItem

右键点击的列表框项的索引,以数值标量形式返回。

如果用户右键点击了列表框中与项无关的区域,则 Item 为空数组。

对象创建函数,指定为下列值之一:

  • 函数句柄。

  • 第一个元素是函数句柄的元胞数组。元胞数组中的后续元素是传递到回调函数的参量。

  • 包含有效 MATLAB 表达式的字符向量(不推荐)。MATLAB 在基础工作区计算此表达式。

有关将回调指定为函数句柄、元胞数组或字符向量的详细信息,请参阅App 设计工具中的回调

此属性指定要在 MATLAB 创建对象时执行的回调函数。MATLAB 将在执行 CreateFcn 回调之前初始化所有属性值。如果不指定 CreateFcn 属性,则 MATLAB 执行默认的创建函数。

对现有组件设置 CreateFcn 属性没有任何作用。

如果将此属性指定为函数句柄或元胞数组,则可以使用回调函数的第一个参量访问正在创建的对象。否则,使用 gcbo 函数访问该对象。

对象删除函数,指定为下列值之一:

  • 函数句柄。

  • 第一个元素是函数句柄的元胞数组。元胞数组中的后续元素是传递到回调函数的参量。

  • 包含有效 MATLAB 表达式的字符向量(不推荐)。MATLAB 在基础工作区计算此表达式。

有关将回调指定为函数句柄、元胞数组或字符向量的详细信息,请参阅App 设计工具中的回调

此属性指定在 MATLAB 删除对象时要执行的回调函数。MATLAB 在销毁对象的属性之前执行 DeleteFcn 回调。如果不指定 DeleteFcn 属性,则 MATLAB 执行默认的删除函数。

如果将此属性指定为函数句柄或元胞数组,则可以使用回调函数的第一个参量访问要删除的对象。否则,使用 gcbo 函数访问该对象。

回调执行控件

全部展开

回调中断,指定为 'on''off',或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 'on' 等效于 true'off' 等效于 false。因此,您可以使用此属性的值作为逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

此属性确定是否可以中断运行中回调。有以下两种回调状态要考虑:

  • 运行中回调是当前正在执行的回调。

  • 中断回调是试图中断运行中回调的回调。

每次执行处理回调队列的命令时,MATLAB 都会确定回调中断行为。这些命令包括 drawnowfigureuifiguregetframewaitforpause

如果运行中回调不包含上述命令之一,则不会发生中断。MATLAB 首先完成执行运行中回调,然后执行中断回调。

如果运行中回调确实包含上述命令之一,则由运行中回调所属对象的 Interruptible 属性来确定是否发生中断:

  • 如果 Interruptible 的值为 'off',则不会发生中断。此时,由中断回调所属对象的 BusyAction 属性确定中断回调是被丢弃还是添加到回调队列中。

  • 如果 Interruptible 的值为 'on',则发生中断。下次 MATLAB 处理回调队列时,它会停止运行中回调的执行,并执行中断回调。在中断回调完成后,MATLAB 将继续执行运行中回调。

注意

回调的中断和执行在以下情况下会有不同的表现:

  • 如果中断回调是 DeleteFcnCloseRequestFcnSizeChangedFcn 回调,则无论是否存在 Interruptible 属性值都会发生中断。

  • 如果运行中回调当前正在执行 waitfor 函数,则无论是否存在 Interruptible 属性值都会发生中断。

  • 如果中断回调由 Timer 对象所有,则回调将根据调度执行,而不考虑 Interruptible 属性值。

注意

发生中断时,MATLAB 不保存属性状态或显示内容。例如,gcagcf 命令返回的对象可能会在另一个回调执行时发生改变。

回调排队,指定为 'queue''cancel'BusyAction 属性决定 MATLAB 如何处理中断回调的执行。有以下两种回调状态要考虑:

  • 运行中回调是当前正在执行的回调。

  • 中断回调是试图中断运行中回调的回调。

BusyAction 属性仅在同时满足以下两个条件时才确定回调排队行为:

在这些情况下,由中断回调所属对象的 BusyAction 属性确定 MATLAB 如何处理中断回调。以下是 BusyAction 属性的可能值:

  • 'queue' - 将中断回调放入队列中,以便在运行中回调执行完毕后进行处理。

  • 'cancel' - 不执行中断回调。

此 属性 为只读。

删除状态,以 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值形式返回。

DeleteFcn 回调开始执行时,MATLAB 会将 BeingDeleted 属性设置为 'on'BeingDeleted 属性将一直保持 'on' 设置状态,直到组件对象不再存在为止。

在查询或修改对象之前,请先检查其 BeingDeleted 属性的值,以确认它不是待删除项。

父级/子级

全部展开

父对象,指定为使用 uifigurefigure 函数创建的 Figure 对象。如果未指定父图窗,则 MATLAB 调用 figure 函数以创建一个图窗来用作父图窗。

通过将此属性设置为目标 Figure 对象,可将 ContextMenu 对象移到不同的图窗中。

上下文菜单子级,以空的 GraphicsPlaceholderMenu 对象的向量形式返回。

不能使用 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;
Context menu with three menu items.

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

cm.Children
ans = 

  3×1 Menu array:

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

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

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

对象句柄的可见性,指定为 'on''callback''off'

此属性控制对象在其父级的子级列表中的可见性。当对象未显示在其父级的子级列表中时,通过搜索对象层次结构或查询属性来获取对象的函数不会返回该对象。这些函数包括 getfindobjgcagcfgconewplotclaclfcloseHandleVisibility 属性还控制对象句柄是否显示在父图窗的 CurrentObject 属性中。对象即使在不可见时也有效。如果可以访问某个对象,则可以设置和获取其属性,并将其传递给针对对象进行运算的任意函数。

HandleVisibility 值描述
'on'对象句柄始终可见。
'callback'对象句柄在回调或回调所调用的函数中可见,但在从命令行调用的函数中不可见。此选项阻止通过命令行访问对象,但允许回调函数访问对象。
'off'对象句柄始终不可见。该选项用于防止另一函数无意中对 UI 进行更改。将 HandleVisibility 设置为 'off' 可在执行该函数时暂时隐藏句柄。

标识符

全部展开

此 属性 为只读。

图形对象的类型,以 'uicontextmenu' 形式返回。

对象标识符,指定为字符向量或字符串标量。您可以指定唯一的 Tag 值作为对象的标识符。如果需要访问您代码中其他位置的对象,可以使用 findobj 函数基于 Tag 值搜索对象。

用户数据,指定为任何数组。指定 UserData 对在 App 内共享数据很有用。有关详细信息,请参阅在回调之间共享数据

版本历史记录

在 R2006a 之前推出

全部展开

另请参阅

| |