主要内容

DropDown

下拉列表 UI 组件

  • Drop-down UI component

说明

下拉列表 UI 组件允许 App 用户选择选项或键入文本。在创建下拉列表后,使用 DropDown 对象修改其外观和行为。

创建对象

使用 uidropdown 函数在 App 中创建一个下拉列表。

属性

全部展开

下拉列表

值,指定为 ItemsItemsData 数组的元素。默认情况下,ValueItems 中的第一个元素。

Value 指定为 Items 的元素,即可选择与该元素匹配的下拉项。如果 ItemsData 非空,则 Value 必须设置为 ItemsData 的元素,而下拉列表将选中列表中的关联项目。

Editable 设置为 'on' 时,您还可以将 Value 指定为字符向量或字符串标量。

下拉项,指定为字符向量元胞数组、字符串数组或一维分类数组。允许重复的元素。下拉组件显示的选项与 Items 数组中的元素数量一样多。如果将此属性指定为分类数组,MATLAB® 将使用数组中的值,而不是完整的类别集。

示例: {'Red','Yellow','Blue'}

示例: {'1','2','3'}

Items 属性值的每个元素关联的数据,指定为 1×n 数值数组或 1×n 元胞数组。允许重复的元素。

例如,如果您将 Items 值设置为员工姓名,则可以将 ItemsData 值设置为对应的员工 ID 号。ItemsData 值对 App 用户不可见。

如果 ItemsData 值和 Items 值中的数组元素数量不匹配,将发生以下情况之一:

  • 如果 ItemsData 值为空,则 Items 值的所有元素都呈现给 App 用户。

  • 如果 ItemsData 值中的元素数大于 Items 值,则 Items 值的所有元素都呈现给 App 用户。MATLAB 将忽略多余的 ItemsData 元素。

  • 如果 ItemsData 值非空,但元素数少于 Items 值,只将在 ItemsData 值中具有对应元素的 Items 值的元素呈现给 App 用户。

示例: {'One','Two','Three'}

示例: [10 20 30 40]

项目或项目数据列表中组件值的索引,指定为正整数。

在大多数情况下,您可以使用 Value 属性来查询和更新组件值。但是,当 ItemsItemsData 属性都非空时,ValueIndex 属性会很有用。在这种情况下,您可以使用 ValueIndex 属性来查询与当前值对应的 Items 的元素。

fig = uifigure;
dd = uidropdown(fig, ...
    "Items",["Red","Green","Blue"], ...
    "ItemsData",["#F00","#0F0","#00F"]);
idx = dd.ValueIndex;
 
disp(dd.Items(idx) + ": " + dd.Value)
Red: #F00

当下拉组件的 Editable 属性设置为 'on' 时,您也可以将 ValueIndex 指定为空数组 ([])。当 App 用户在组件中键入与 Items 中的项目不对应的值时,MATLAB 会将 ValueIndex 属性设置为空数组。如果您将 ValueIndex 设置为空数组,MATLAB 会将 Value 属性设置为 ''

占位符文本,指定为字符向量或字符串标量。占位符提供下拉项的简短描述。仅当下拉组件显示 '' 时,占位符文本才会出现。在以下两种情况下会出现这种情形:

  • Value 属性设置为 ''

  • Value 属性设置为其对应项为 ''ItemsData 元素。

例如,要在没有 ItemsData 的下拉组件中显示占位符,请将 '' 添加到 Items,并将 Value 属性设置为 ''

fig = uifigure('Position',[100 100 300 200]);
dd = uidropdown(fig,'Items',{'','One','Two'}, ...
                'Value','', ...
                'Placeholder','Options');

UI figure window that contains a drop-down list with text "Options"

字体和颜色

字体名称,指定为系统支持的字体名称。默认字体取决于具体操作系统和区域设置。

如果指定的字体不可用,MATLAB 将使用运行 App 的系统上的可用字体中的最佳匹配项。

示例: 'Arial'

字体大小,指定为正数。测量单位为像素。默认字体大小取决于具体操作系统和区域设置。

示例: 14

字体粗细,指定为下列值之一:

  • 'normal' - 特定字体定义的默认粗细

  • 'bold' - 字符轮廓比 'normal'

并非所有字体都有加粗字体。对于非加粗字体,指定 'bold' 会得到普通字体。

字体角度,指定为 'normal''italic'。并非所有字体都有倾斜字体角度。对于无斜体字体,指定 'italic' 后会使用常规字体角度。

字体颜色,指定为 RGB 三元组、十六进制颜色代码或下表中列出的选项之一。

RGB 三元组和十六进制颜色代码对于指定自定义颜色非常有用。

  • RGB 三元组是包含三个元素的行向量,其元素分别指定颜色中红、绿、蓝分量的强度。强度值必须位于 [0,1] 范围内,例如 [0.4 0.6 0.7]

  • 十六进制颜色代码是字符向量或字符串标量,以井号 (#) 开头,后跟三个或六个十六进制数字,范围可以是 0F。这些值不区分大小写。因此,颜色代码 "#FF8800""#ff8800""#F80""#f80" 是等效的。

此外,还可以按名称指定一些常见的颜色。下表列出了命名颜色选项、等效 RGB 三元组和十六进制颜色代码。

颜色名称短名称RGB 三元组十六进制颜色代码外观
"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

下表列出了浅色和深色主题中绘图的默认调色板。

调色板调色板颜色

"gem" - 浅色主题默认值

在 R2025a 之前的版本中: 大多数绘图默认使用这些颜色。

Sample of the "gem" color palette

"glow" - 深色主题默认值

Sample of the "glow" color palette

您可以使用 orderedcolorsrgb2hex 函数获取这些调色板的 RGB 三元组和十六进制颜色代码。例如,获取 "gem" 调色板的 RGB 三元组并将其转换为十六进制颜色代码。

RGB = orderedcolors("gem");
H = rgb2hex(RGB);

在 R2023b 之前的版本中: 使用 RGB = get(groot,"FactoryAxesColorOrder") 获取 RGB 三元组。

在 R2024a 之前的版本中: 使用 H = compose("#%02X%02X%02X",round(RGB*255)) 获取十六进制颜色代码。

背景颜色,指定为 RGB 三元组、十六进制颜色代码或下表中列出的颜色选项之一。

RGB 三元组和十六进制颜色代码对于指定自定义颜色非常有用。

  • RGB 三元组是包含三个元素的行向量,其元素分别指定颜色中红、绿、蓝分量的强度。强度值必须位于 [0,1] 范围内,例如 [0.4 0.6 0.7]

  • 十六进制颜色代码是字符向量或字符串标量,以井号 (#) 开头,后跟三个或六个十六进制数字,范围可以是 0F。这些值不区分大小写。因此,颜色代码 "#FF8800""#ff8800""#F80""#f80" 是等效的。

此外,还可以按名称指定一些常见的颜色。下表列出了命名颜色选项、等效 RGB 三元组和十六进制颜色代码。

颜色名称短名称RGB 三元组十六进制颜色代码外观
"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

下表列出了浅色和深色主题中绘图的默认调色板。

调色板调色板颜色

"gem" - 浅色主题默认值

在 R2025a 之前的版本中: 大多数绘图默认使用这些颜色。

Sample of the "gem" color palette

"glow" - 深色主题默认值

Sample of the "glow" color palette

您可以使用 orderedcolorsrgb2hex 函数获取这些调色板的 RGB 三元组和十六进制颜色代码。例如,获取 "gem" 调色板的 RGB 三元组并将其转换为十六进制颜色代码。

RGB = orderedcolors("gem");
H = rgb2hex(RGB);

在 R2023b 之前的版本中: 使用 RGB = get(groot,"FactoryAxesColorOrder") 获取 RGB 三元组。

在 R2024a 之前的版本中: 使用 H = compose("#%02X%02X%02X",round(RGB*255)) 获取十六进制颜色代码。

此 属性 为只读。

使用 uistyle 函数创建的所添加样式的配置,以 n×3 表数组形式返回。表数组的每一行对应于当前应用于下拉组件的一个样式。对连续添加的样式赋予 n+1 的样式顺序号。TargetTargetIndex 列指定样式所添加到的组件部分。Style 列指定样式类名。

如果要使用 removeStyle 函数从下拉组件中删除样式,请使用此属性。

示例:删除样式

首先,向一个下拉组件添加两个样式。

fig = uifigure;
fig.Position = [100 100 300 250];
dd = uidropdown(fig);

s1 = uistyle("FontColor","blue");
s2 = uistyle("FontColor","red");

addStyle(dd,s1,"item",1);
addStyle(dd,s2,"item",[2 3 4]);

Drop-down list with four items. The first item has a blue font color and the last three items have a red font color.

当您查询 dd.StyleConfigurations 时,MATLAB 返回一个 2×3 表数组。蓝色字体样式首先添加到该组件中,因此其样式顺序号为 1。级别样式的 TargetIndex{[1]} 表示该样式应用于组件中的第一个项目。同样,第二个样式添加到该组件中的最后三个项目

dd.StyleConfigurations
ans =

  2×3 table

         Target    TargetIndex              Style          
         ______    ___________    _________________________

    1     item      {[    1]}     1×1 matlab.ui.style.Style
    2     item      {[2 3 4]}     1×1 matlab.ui.style.Style

通过指定样式顺序号 2 删除添加到下拉组件中的第二个样式。组件外观更新为仅使用第一个样式。

removeStyle(dd,2)

Drop-down list with four items. The first item has a blue font color and the last three items have a black font color.

交互性

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

  • 'on' - 显示对象。

  • 'off' - 隐藏对象而不删除它。您仍然可以访问不可见 UI 组件的属性。

要使您的 App 更快地启动,请将不需要在启动时出现的所有 UI 组件的 Visible 属性设置为 'off'

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

如果 Enable 属性值为 'off',则 App 用户不能更改下拉组件文本,即使 Editable 属性值为 'on' 也是如此。

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

  • 如果您将此属性设置为 'on',则 App 用户可以与组件进行交互。

  • 如果您将此属性设置为 'off',组件将灰显,指示 App 用户无法与其交互,并且它不会触发回调。

工具提示,指定为字符向量、字符向量元胞数组、字符串数组或一维分类数组。如果使用此属性,则在运行时当用户将指针悬停在组件上时,将显示消息。即使禁用组件,工具提示也会显示。要显示多行文本,请指定字符向量元胞数组或字符串数组。数组中的每个元素变为一行文本。如果将此属性指定为分类数组,MATLAB 将使用数组中的值,而不是完整的类别集。

上下文菜单,指定为使用 uicontextmenu 函数创建的 ContextMenu 对象。使用此属性可在您右键点击组件时显示上下文菜单。

位置

下拉组件相对于父级的位置和大小,指定为向量 [left bottom width height]。此表介绍该向量中的每个元素。

元素描述
left父容器的内部左边缘与下拉组件的外部左边缘之间的距离
bottom父容器的内部下边缘与下拉组件的外部下边缘之间的距离
width下拉组件的左右外部边缘之间的距离
height下拉组件的上下外部边缘之间的距离

所有测量值都以像素为单位。

Position 值相对于父容器的可绘制区域。可绘制区域是指容器边框内的区域,不包括装饰元素(如菜单栏或标题)所占的区域。

示例: [100 100 100 22]

下拉组件的内部位置和大小,指定为 [left bottom width height]。位置值相对于父容器。所有测量值都以像素为单位。此属性值等同于下拉组件的 Position

此 属性 为只读。

下拉组件的外部位置和大小,以 [left bottom width height] 形式返回。位置值相对于父容器。所有测量值都以像素为单位。此属性值等同于下拉组件的 Position

布局选项,指定为 GridLayoutOptions 对象。此属性为网格布局容器的子级组件指定选项。如果组件不是网格布局容器的子级(例如,它是图窗或面板的子级),则此属性为空且不起作用。但是,如果组件是网格布局容器的子级,则可以通过在 GridLayoutOptions 对象上设置 RowColumn 属性,将组件放置在网格的所需行和列中。

例如,以下代码将一个下拉框放置在其父网格的第三行第二列中。

g = uigridlayout([4 3]);
dd = uidropdown(g);
dd.Layout.Row = 3;
dd.Layout.Column = 2;

要使该下拉框跨多个行或列,请将 RowColumn 属性指定为二元素向量。例如,此下拉框跨列 23

dd.Layout.Column = [2 3];

回调

更改值后执行的回调,指定为下列值之一:

  • 函数句柄。

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

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

当用户从下拉列表中选择不同的选项时,将会执行此回调函数。如果以编程方式更改 Value 属性,将不会执行此回调函数。

此回调函数可以访问有关用户与下拉组件的交互的特定信息。MATLAB 将 ValueChangedData 对象中的此信息作为第二个参量传递给回调函数。在 App 设计工具中,该参量名为 event。您可以使用圆点表示法查询对象属性。例如,event.PreviousValue 返回下拉组件的上一个值。ValueChangedData 对象不可用于指定为字符向量的回调函数。

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

属性
ValueApp 用户最近一次交互之后下拉组件的值
PreviousValueApp 用户最近一次交互之前下拉组件的值
Edited

逻辑值,指明在下拉组件中键入一个新值时是否执行回调。

  • 0 (false) - App 用户选择或键入了下拉组件的 Items 属性的元素。

  • 1 (true) - App 用户键入的值不是下拉组件的 Items 属性的元素。

ValueIndexApp 用户最近一次交互之后项目中下拉组件值的索引
PreviousValueIndexApp 用户最近一次交互之前项目中下拉组件值的索引
Source执行回调的组件
EventName'ValueChanged'

有关编写回调的详细信息,请参阅App 设计工具中的回调

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

  • 函数句柄。

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

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

此属性指定当用户点击打开下拉菜单时要执行的回调函数。此回调的一个可能用途是动态更新下拉菜单中的条目列表。

此回调函数可以访问有关用户与下拉组件的交互的特定信息。MATLAB 将 DropDownOpeningData 对象中的此信息作为第二个参量传递给回调函数。在 App 设计工具中,该参量名为 event。您可以使用圆点表示法查询对象属性。例如,event.Source 返回用户与之交互的 DropDown 对象以触发回调。DropDownOpeningData 对象不可用于指定为字符向量的回调函数。

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

属性
Source执行回调的组件
EventName'DropDownOpening'

有关编写回调的详细信息,请参阅App 设计工具中的回调

点击后的回调,指定为下列值之一:

  • 函数句柄。

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

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

当用户点击下拉组件中的任意位置时,此回调函数执行。

此回调函数可以访问有关用户与下拉组件交互的特定信息。MATLAB 将 ClickedData 对象中的此信息作为第二个参量传递给回调函数。在 App 设计工具中,该参量名为 event。您可以使用圆点表示法查询对象属性。例如,event.InteractionInformation 返回有关用户在下拉组件中点击位置的信息。ClickedData 对象不可用于指定为字符向量的回调函数。

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

属性
InteractionInformation

有关 App 用户在组件中点击位置的信息。此信息存储为具有以下属性的对象:

  • Item

  • ScreenLocation

  • Location

您可以使用圆点表示法查询对象属性。例如,event.InteractionInformation.Item 返回用户点击了下拉组件的哪一项。

Source执行回调的组件
EventName'Clicked'

下表列出了与下拉组件相关联的 InteractionInformation 对象的属性。

属性
Item

点击的下拉组件项的索引,以标量形式返回。

如果用户点击下拉组件中与项无关的区域,则 Item 为空数组。

Location

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

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

ScreenLocation

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

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

有关编写回调的详细信息,请参阅App 设计工具中的回调

示例:点击下拉组件时显示数据

创建一个下拉组件,其中包含表示食品杂货的项和表示其成本的项数据。指定名为 displayCostClickedFcn 回调函数,该函数在用户点击组件时执行。在 displayCost 函数中:

  • 使用 event.InteractionInformation 对象访问有关用户是否点击了某个项的信息。

  • 如果用户点击某个项(而不是下拉组件中与项无关的位置),则会查询该项及其成本。

  • 在命令行窗口中显示该项及其成本。

要尝试此示例,请将代码保存在新脚本中并运行它。点击下拉组件中的项以显示其成本。

fig = uifigure;
dd = uidropdown(fig);
dd.Items = ["Apple","Banana","Orange"];
dd.ItemsData = [1.2,0.5,1.2];
dd.ClickedFcn = @displayCost;

function displayCost(dd,event)
idx = event.InteractionInformation.Item;
if ~isempty(idx)
    fruit = dd.Items(idx);
    cost = dd.ItemsData(idx);
    disp(fruit + " cost $" + cost)
end
end

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

  • 函数句柄。

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

  • 包含有效 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 属性的值,以确认它不是待删除项。

父级/子级

父容器,指定为 Figure 对象或其子容器之一:TabPanelButtonGroupGridLayout。如果未指定容器,MATLAB 将调用 uifigure 函数以创建一个新 Figure 对象来充当父容器。

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

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

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

标识符

此 属性 为只读。

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

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

用户数据,指定为任何 MATLAB 数组。例如,您可以指定标量、向量、矩阵、元胞数组、字符数组、表或结构体。使用此属性存储对象上的任意数据。

如果您在 App 设计工具中工作,请在该 App 中创建公共或私有属性以共享数据,而不是使用 UserData 属性。有关详细信息,请参阅在用 App 设计工具创建的 App 内共享数据

对象函数

addStyleAdd style to UI component
removeStyle从 UI 组件中删除样式
focusGive focus to UI component

示例

全部折叠

在 UI 图窗中创建一个下拉组件并指定项。

fig = uifigure;
dd = uidropdown(fig,"Items",["Red","Yellow","Blue","Green"]);

UI figure with a drop-down component. The value of the drop-down component is "Red".

确定与选定项关联的值。当 ItemsData 属性为空(默认值)时,下拉组件 Value 属性会将所选项的名称存储为该项在 Items 属性中所示的名称。

value = dd.Value
value =

    'Red'

通过指定 ItemsData 属性,将每个下拉组件项与一个十六进制颜色代码相关联。

dd.ItemsData = ["#F00" "#FF0" "#00F" "#0F0"];

ItemsData 非空时,下拉组件 Value 属性存储与所选项相关联的数据。

value = dd.Value
value =

    "#F00"

自 R2023a 起

创建一个包含三个项的下拉 UI 组件。

fig = uifigure;
dd = uidropdown(fig,"Items",["Good","Fair","Poor"]);

创建三个背景颜色样式。

s1 = uistyle("BackgroundColor","#77AC30");
s2 = uistyle("BackgroundColor","#EDB120");
s3 = uistyle("BackgroundColor","#F77A8F");

将样式添加到下拉组件项中以更改其背景颜色。

addStyle(dd,s1,"item",1);
addStyle(dd,s2,"item",2);
addStyle(dd,s3,"item",3);

项目背景颜色会更新,组件的外观会反映所选项的样式。当用户指向某个项时,该样式不会更改显示的颜色。

Drop-down UI component with three items. Each item has a different background color: The "Good" item is green, the "Fair" item is yellow, and the "Poor" item is red. The "Fair" item is selected and appears at the top of the component as yellow. The mouse cursor is pointing to the "Fair" item in the list, so that item is highlighted in blue.

创建一个 App,当 App 用户从下拉列表中进行选择时,该 App 会更改所绘制线条的颜色。

在名为 plotOptions.m 的文件中,编写实现该 App 的函数:

  • 创建一个 UI 图窗和一个网格布局管理器,以对该 App 进行布局。

  • 在网格布局管理器中创建 UI 坐标区和一个下拉组件。

  • 编写一个名为 updatePlot 的回调函数,该函数根据所选下拉组件项更改绘图颜色,并将该函数赋给 ValueChangedFcn 回调属性。有关回调的详细信息,请参阅Create Callbacks for Apps Created Programmatically

function plotOptions
fig = uifigure;
g = uigridlayout(fig);
g.RowHeight = {'1x','fit','1x'};
g.ColumnWidth = {'1x','fit'};

ax = uiaxes(g);
ax.Layout.Row = [1 3];
ax.Layout.Column = 1;

x = linspace(-2*pi,2*pi);
y = sin(x);
p = plot(ax,x,y,"Color","#F00");

dd = uidropdown(g, ...
    "Items",["Red","Yellow","Blue","Green"], ...
    "ItemsData",["#F00" "#FF0" "#00F" "#0F0"], ...
    "ValueChangedFcn",@(src,event) updatePlot(src,p));
dd.Layout.Row = 2;
dd.Layout.Column = 2;
end

function updatePlot(src,p)
val = src.Value;
p.Color = val;
end

运行 plotOptions 函数。从下拉列表中选择一个项以更改绘图颜色。

plotOptions

Figure contains an axes object and an object of type uigridlayout. The axes object contains an object of type line.

创建一个允许用户选择要显示的图像的 App。由于该 App 包含可编辑的下拉组件,因此可编写代码来处理用户选择现有项以及用户输入自己的值的情况。

在名为 imageApp.m 的文件中,编写实现该 App 的函数:

  • 创建一个 UI 图窗和一个网格布局管理器,以对该 App 进行布局。

  • 在网格布局管理器中创建一个可编辑的下拉组件和一个图像组件。

  • 编写名为 updateImage 的回调函数,该函数根据所选下拉组件项更改图像,并将该函数赋给 ValueChangedFcn 回调属性。查询回调事件数据以检查新值是从现有项中选择的还是由用户输入的,并验证任何用户输入的值。有关回调的详细信息,请参阅Create Callbacks for Apps Created Programmatically

function imageApp
fig = uifigure;
g = uigridlayout(fig,[2 3]);
g.RowHeight = {22,'1x'};
g.ColumnWidth = {'1x','fit','1x'};

dd = uidropdown(g, ...
    "Editable","on", ...
    "Items",["peppers.png","street1.jpg"]);
dd.Layout.Row = 1;
dd.Layout.Column = 2;

im = uiimage(g,"ImageSource","peppers.png");
im.Layout.Row = 2;
im.Layout.Column = [1 3];

dd.ValueChangedFcn = @(src,event)updateImage(src,event,im,fig);
end

function updateImage(src,event,im,fig)
val = src.Value;
if event.Edited && ~exist(val,"file")
    im.ImageSource = "";
    uialert(fig,"Enter a file on the MATLAB path","Invalid Image")
else
    im.ImageSource = val;
end
end

运行 imageApp 函数,通过选择现有项或输入您自己的图像路径来更新图像。

UI figure window with a drop-down list and an image of cars on a street. The drop-down list has the text "street2.jpg" and a cursor.

版本历史记录

在 R2016a 中推出

全部展开

另请参阅

函数

工具