uicheckbox

创建复选框组件

语法

cbx = uicheckbox

cbx = uicheckbox(parent)

cbx = uicheckbox(___,Name,Value)

说明

cbx = uicheckbox 在新图窗窗口中创建一个复选框，并返回 CheckBox 对象。MATLAB^® 调用 uifigure 函数来创建该图窗。

cbx = uicheckbox(parent) 在指定的父容器中创建复选框。父容器可以是使用 uifigure 函数创建的 Figure 对象或其子容器之一。

cbx = uicheckbox(___,Name,Value) 使用一个或多个名称-值参量指定 CheckBox 属性。例如，uicheckbox("Value",1) 创建一个处于选中状态的复选框。可将此选项与上述语法中的任何输入参量组合一起使用。

示例

创建复选框

在 UI 图窗中创建复选框。

fig = uifigure;
cbx = uicheckbox(fig);

设置和访问复选框属性值

在 UI 图窗中创建复选框，并指定复选框文本。

fig = uifigure;
cbx = uicheckbox(fig,"Text","Subscribe");

查询该复选框的值。

val = cbx.Value

val = logical
   0

以编程方式通过更新 Value 属性选中该复选框。

cbx.Value = 1;

编写响应以下操作的代码：选中复选框

创建一个允许用户在绘图中显示和隐藏图例的 App。

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

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

• 在网格布局管理器中创建一个 UI 坐标区和一个复选框，并在坐标区中绘制一些数据。

• 编写一个名为 checkBoxChanged 的回调函数来切换绘图图例的可见性，并将该函数赋给复选框的 ValueChangedFcn 回调属性。有关回调的详细信息，请参阅Create Callbacks for Apps Created Programmatically。

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

ax = uiaxes(g);
ax.Layout.Row = 1;
ax.Layout.Column = [1 3];
plot(ax,magic(3));
lgd = legend(ax,"hide");
cbx = uicheckbox(g,"Text","Show legend");
cbx.Layout.Row = 2;
cbx.Layout.Column = 2;

cbx.ValueChangedFcn = @(src,event) checkBoxChanged(src,event,lgd);
end

function checkBoxChanged(src,event,lgd)
val = event.Value;
lgd.Visible = val;
end

运行 toggleLegendApp 函数。选中复选框以显示图例。

输入参数

parent — 父容器

Figure 对象 (默认) | Tab 对象 | Panel 对象 | ButtonGroup 对象 | GridLayout 对象

父容器，指定为使用 uifigure 函数创建的 Figure 对象或其子容器之一：Tab、Panel、ButtonGroup 或 GridLayout。如果不指定父容器，MATLAB 会调用 uifigure 函数创建新 Figure 对象充当父容器。

名称-值参数

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

示例: uicheckbox(Value=1) 指定显示的复选框带有选中标记。

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

示例: uicheckbox("Value",1) 指定显示的复选框带有选中标记。

注意

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

Value — 复选框的状态

0 (默认) | 1

复选框的状态，指定为 0 (false) 或 1 (true)。当 Value 属性设置为 1 时，复选框处于选中状态。当 Value 属性设置为 0 时，复选框处于清除状态。

ValueChangedFcn — 更改值后执行的回调

[] (默认) | 函数句柄 | 元胞数组 | 字符向量

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

• 函数句柄。

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

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

当用户选中或清除 App 中的复选框时，将会执行此回调。如果以编程方式更改复选框值，将不会执行此回调。

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

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

属性	值
Value	复选框在 App 用户最近一次与它交互之后的值。
PreviousValue	复选框在 App 用户最近一次与它交互之前的值。
Source	执行回调的组件。
EventName	'ValueChanged'

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

Position — 复选框的位置和大小

[100 100 84 22] (默认) | [left bottom width height]

复选框相对于父级的位置和大小，指定为向量 [left bottom width height]。此表介绍该向量中的每个元素。

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

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

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

示例: [200 200 102 15]

版本历史记录

在 R2016a 中推出

R2020b: 复选框文本换行

当 UI 组件的宽度小于要显示的文本的宽度时，使用 WordWrap 属性可防止文本在水平方向上被裁剪。将 WordWrap 属性设置为 'on' 会将文本分成若干新行，以便每行都适合组件宽度。它会尽可能避免拆分词语。当该属性设置为 'off' 时，文本不会换行。

另请参阅

函数

• uifigure

属性

• CheckBox

工具

• App 设计工具