CheckBoxTree 属性

选中的节点，指定为 TreeNode 对象或由 TreeNode 对象组成的数组。使用此属性以编程方式获取或设置复选框树中的选中节点。

如果 CheckedNodes 包含父节点，则父节点的所有子级都会自动添加到 CheckedNodes。如果 CheckedNodes 包含父节点的所有子级，则该父节点会自动添加到 CheckedNodes。

选定节点，指定为 TreeNode 对象。使用此属性获取或设置复选框树中选定的节点。

在复选框树 UI 组件中，所选节点以蓝色高亮显示来表示。

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

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

示例: 'Arial'

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

示例: 14

字体粗细，指定为下列值之一：

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

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

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

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

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

以下是 MATLAB 在许多类型的绘图中使用的默认颜色的 RGB 三元组和十六进制颜色代码。

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

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

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

以下是 MATLAB 在许多类型的绘图中使用的默认颜色的 RGB 三元组和十六进制颜色代码。

此 属性 为只读。

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

如果要使用 removeStyle 函数从树中删除样式，请使用此属性。

示例：删除样式

首先，向一个树添加两个样式。

fig = uifigure;
fig.Position = [100 100 250 350];
t = uitree(fig,'checkbox');
n1 = uitreenode(t,'Text','Fruits');
n11 = uitreenode(n1,'Text','Banana');
n12 = uitreenode(n1,'Text','Cherry');
n2 = uitreenode(t,'Text','Vegetables');
n21 = uitreenode(n2,'Text','Broccoli');
n22 = uitreenode(n2,'Text','Lettuce');
expand(t)

s1 = uistyle('FontColor',[0 0.4 0.7]);    % Blue
s2 = uistyle('FontColor',[0.1 0.5 0.1]);  % Green

addStyle(t,s1,'level',2);
addStyle(t,s2,'node',[n2 n21 n22]);

当您查询 t.StyleConfigurations 时，MATLAB 返回一个 2×3 表数组。级别样式首先添加到树中，因此它具有样式顺序号 1。级别样式的 TargetIndex 值 {[ 2]} 表示该样式应用于第二级节点。同样，第二个样式添加到了树中的三个节点。

t.StyleConfigurations

ans =

  2×3 table

         Target     TargetIndex                Style          
         ______    ______________    _________________________

    1    level     {[         2]}    1×1 matlab.ui.style.Style
    2    node      {1×3 TreeNode}    1×1 matlab.ui.style.Style

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

removeStyle(t,2)

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

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

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

将此属性设置为 'on' 可允许用户在运行时编辑节点文本。Enable 属性也必须设置为 'on' 才能使文本可编辑。

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

将此属性设置为 'off' 可使树及其节点灰显，表示用户不能与树或其节点进行交互。

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

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

位置和大小，指定为 [left bottom width height] 形式的四元素向量。此表介绍该向量中的每个元素。所有测量值都以像素为单位。

位置和大小，指定为 [left bottom width height] 形式的四元素向量。向量中的值相对于父容器。所有测量值都以像素为单位。此属性值等同于 Position 属性值。

此 属性 为只读。

位置和大小，返回 [left bottom width height] 形式的四元素向量。向量中的值相对于父容器。所有测量值都以像素为单位。此属性值等同于 Position 属性值。

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

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

g = uigridlayout([4 3]);
cbt = uitree(g,'checkbox');
cbt.Layout.Row = 3;
cbt.Layout.Column = 2;

要使该树跨多个行或列，请将 Row 或 Column 属性指定为二元素向量。例如，此树跨列 2 到 3：

cbt.Layout.Column = [2 3];

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

使用此回调函数可在用户选中或取消选中树中的节点时执行命令。

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

下表说明了 CheckedNodesChangedData 对象的属性。

返回节点列表的属性按层次结构顺序返回节点。例如，CheckedNodes 属性首先按节点在树组件中出现的顺序列出树的第一个层级中所有选中的节点。然后，同样按节点的出现顺序列出树的第二个层级中所有选中的节点。这种模式一直持续到列出树的最后一个层级中的节点为止。这与 findall 函数返回节点的顺序相匹配。

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

所选内容改变时的回调，指定为下列值之一：

使用此回调函数可在用户在树中选择不同的节点时执行命令。

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

下表说明了 SelectedNodesChangedData 对象的属性。

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

节点展开时的回调，指定为下列值之一：

使用此回调函数可在用户展开树中的节点时执行命令。

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

下表说明了 NodeExpandedData 对象的属性。

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

节点折叠时的回调，指定为下列值之一：

使用此回调函数以在用户折叠树中的节点时执行命令。

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

下表说明了 NodeCollapsedData 对象的属性。

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

节点文本更改回调，指定为下列值之一：

使用此回调函数可在用户更改树中节点的文本时执行命令。

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

下表说明了 NodeTextChangedData 对象的属性。

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

点击的函数，指定为下列值之一：

当用户点击树中的任意位置时，此回调函数就会执行。

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

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

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

有关编写回调的详细信息，请参阅Create Callbacks for Apps Created Programmatically。

示例：点击树时打开对话框

创建一个包含一些树节点的树。指定名为 chooseIcon 的 ClickedFcn 回调函数，该函数在用户点击树时执行。在 chooseIcon 函数中：

要尝试此示例，请将代码保存在新脚本中并运行它。点击树中的节点并选择图标图像文件。

fig = uifigure;
t = uitree(fig,"checkbox");
n1 = uitreenode(t);
n2 = uitreenode(t);
n11 = uitreenode(n1);
n21 = uitreenode(n2);
t.ClickedFcn = @chooseIcon;
expand(t)

function chooseIcon(src,event)
node = event.InteractionInformation.Node;
if ~isempty(node)
    [file,path] = uigetfile("*.png");
    if ~isequal(file,0)
        node.Icon = fullfile(path,file);
    end
    focus(src)
end
end

双击函数，指定为下列值之一：

当用户点击树中的任意位置时，此回调函数就会执行。

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

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

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

有关编写回调的详细信息，请参阅Create Callbacks for Apps Created Programmatically。

示例：双击树时打开对话框

创建一个包含一些树节点的树。指定名为 chooseIcon 的 DoubleClickedFcn 回调函数，该函数在用户双击树时执行。在 chooseIcon 函数中：

要尝试此示例，请将代码保存在新脚本中并运行它。双击树中的节点并选择图标图像文件。

fig = uifigure;
t = uitree(fig,"checkbox");
n1 = uitreenode(t);
n2 = uitreenode(t);
n11 = uitreenode(n1);
n21 = uitreenode(n2);
t.DoubleClickedFcn = @chooseIcon;
expand(t)

function chooseIcon(src,event)
node = event.InteractionInformation.Node;
if ~isempty(node)
    [file,path] = uigetfile("*.png");
    if ~isequal(file,0)
        node.Icon = fullfile(path,file);
    end
    focus(src)
end
end

对象创建函数，指定为下列值之一：

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

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

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

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

对象删除函数，指定为下列值之一：

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

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

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

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

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

每次执行处理回调队列的命令时，MATLAB 都会确定回调中断行为。这些命令包括 drawnow、figure、uifigure、getframe、waitfor 和 pause。

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

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

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

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

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

此 属性 为只读。

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

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

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

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

子级，以 TreeNode 对象数组形式返回。

不能使用 Children 属性添加或删除子级，但可以使用此属性查看子级列表。子级的顺序反映了显示在屏幕上的子级节点的顺序。要向该列表中添加子级，请将子组件的 Parent 属性设置为 Tree 对象。

要重新排序子级，请使用 move 函数。

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

对象句柄的可见性，指定为 'on'、'callback' 或 'off'。

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

此 属性 为只读。

图形对象的类型，以 'uicheckboxtree' 形式返回。

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

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

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