addGroup

添加新的出厂设置组

全页折叠

语法

s = addGroup(parentgroup,name)
s = addGroup(___,Name,Value)

说明

s = addGroup(parentgroup,name) 将出厂设置组 name 添加到指定的父出厂设置组并以 FactoryGroup 对象形式返回新组。默认情况下，出厂设置组处于隐藏状态，这意味着它们不会显示在父设置组中。

示例

s = addGroup(___,Name,Value) 使用一个或多个名称-值对组参量指定出厂组属性。例如，'Hidden',false 将添加一个在出厂设置树中可见的组。请在所有其他输入参量之后指定名称-值对组。

示例

示例

全部折叠

为工具箱 mytoolbox 创建根出厂组，然后将一个组添加到树中。

创建根出厂组 mytoolbox。

myToolboxFactoryTree = matlab.settings.FactoryGroup.createToolboxGroup('mytoolbox', ...
    'Hidden',false);

将 font 组添加到树中。

toolboxFontGroup = addGroup(myToolboxFactoryTree,'font','Hidden',false);

添加一个设置组并指定默认验证函数。此函数验证组内所有设置的值，但指定其自有验证函数的设置除外。其中包括子组中的设置，前提是子组或设置未指定它们自己的验证函数。

首先，创建一个当输入为非数值时会抛出错误的验证函数 numericValidationFcn。

function numericValidationFcn(x)
    errorMsg = 'Value must be numeric.'; 
    assert(isnumeric(x),errorMsg);
end

创建根出厂组 mytoolbox，并将 mynumericsettings 组添加到树中。指定验证函数 numericValidationFcn。只要组内的设置设置为非数值，MATLAB® 就会抛出错误。

myToolboxFactoryTree = matlab.settings.FactoryGroup.createToolboxGroup('mytoolbox', ...
    'Hidden',false);
toolboxFontGroup = addGroup(myToolboxFactoryTree,'mynumericsettings','Hidden',false, ...
    'ValidationFcn',@numericValidationFcn);

输入参数

全部折叠

要向其添加组的父出厂组，指定为 FactoryGroup 对象。使用 matlab.settings.FactoryGroup.createToolboxGroup 函数创建根出厂组对象。

示例: addGroup(s.mytoolbox,'newGroup')

要添加的出厂组的名称，指定为字符向量或字符串。如果出厂组 name 已经存在于指定父出厂组中，MATLAB 会显示错误。

示例: addGroup(s.mytoolbox,'newGroup')

名称-值参数

全部折叠

以 Name1=Value1,...,NameN=ValueN 的形式指定可选参量对组，其中 Name 是参量名称，Value 是对应的值。名称-值参量必须出现在其他参量之后，但对各个参量对组的顺序没有要求。

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

示例: addGroup(parentGroup,'newGroup','Hidden',false) 创建一个可见的出厂组。

隐藏状态，指定为 true 或 false。

当设置为 true 时，出厂组（包括组中的所有出厂组和出厂设置）不会显示在命令行窗口中或作为 Tab 键自动填充的一部分，但仍可访问它们。

用于验证组内出厂设置的函数，指定为函数句柄。如果指定了该函数，它将验证组内所有出厂设置的值，但指定其自身验证函数的设置除外。其中包括子组中的设置，前提是子组或设置未指定它们自己的验证函数。

函数句柄必须与接受潜在设置值作为输入参量、没有输出参量并且在验证失败时抛出错误的函数相关联。

函数句柄必须指向 MATLAB 路径上的函数。不支持匿名或嵌套的函数句柄。

版本历史记录

在 R2019b 中推出

另请参阅

|

主题