Main Content

matlab.settings.FactoryGroup.createToolboxGroup

为工具箱创建 FactoryGroup 根对象

自 R2019b 起

说明

示例

s = matlab.settings.FactoryGroup.createToolboxGroup(name) 为工具箱创建根出厂组,并以 FactoryGroup 对象形式返回新组。默认情况下,根出厂组处于隐藏状态,这意味着它不会显示在父设置组中。

示例

s = matlab.settings.FactoryGroup.createToolboxGroup(___,Name,Value) 使用一个或多个名称-值对组参数指定根出厂组属性。例如,'Hidden',false 创建可见的 FactoryGroup 根对象。请在所有其他输入参数之后指定名称-值对组。

示例

全部折叠

为工具箱 mytoolbox 创建根出厂组,并使其可见。

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

创建根出厂组并指定默认验证函数。此函数验证组中未指定其自己的验证函数的所有出厂设置的值。其中包括子组中的设置,前提是子组或设置未指定它们自己的验证函数。

首先,创建一个当输入为非数值时会引发错误的验证函数 numericValidationFcn

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

创建根出厂组 mytoolbox。指定验证函数 numericValidationFcn。如果根出厂设置组内的设置被设置为非数值,MATLAB® 就会引发错误。

s = matlab.settings.FactoryGroup.createToolboxGroup('mytoolbox', ...
    'Hidden',false,'ValidationFcn',@numericValidationFcn);

输入参数

全部折叠

工具箱根出厂组的名称,指定为字符向量或字符串。如果根出厂组 name 已经存在,MATLAB 将显示错误。

名称-值参数

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

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

示例: matlab.settings.FactoryGroup.createToolboxGroup('myToolbox','Hidden',false) 创建可见的根出厂组。

隐藏状态,指定为 truefalse

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

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

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

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

版本历史记录

在 R2019b 中推出