Main Content

addSetting

添加新出厂设置

自 R2019b 起

全页折叠

语法

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

说明

示例

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

示例

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

示例

全部折叠

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

创建根出厂组 mytoolbox。

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

添加设置 FontSize 并为其赋予默认值。

fontSizeSetting = addSetting(myToolboxFactoryTree,'FontSize','FactoryValue',11,'Hidden',false);

创建一个设置，并指定一个函数以验证它的值。

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

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

创建根出厂组 mytoolbox。

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

添加设置 FontSize 并指定验证函数 numericValidationFcn。只要设置设定为非数值，MATLAB® 就会引发错误。

addSetting(myToolboxFactoryTree,'FontSize','FactoryValue',11,'Hidden',false, ...
    'ValidationFcn',@numericValidationFcn);

输入参数

全部折叠

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

示例: addSetting(s.mytoolbox,'newSetting')

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

示例: addGroup(parentGroup,'newSetting')

名称-值参数

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

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

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

出厂设置的值，指定为除句柄类型外的任何类型的 MATLAB 数据。也不支持包含句柄的数据容器，如元胞数组、结构体和对象。必须为设置指定出厂值或出厂值函数，但不能同时指定两者。

用于设定出厂设置值的函数，指定为函数句柄。出厂设置的值设置为指定函数的输出。

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

可以为设置指定出厂值或出厂值函数，但不能同时指定两者。

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

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

只读状态，指定为 true 或 false。在为 true 时，无法设置设置的个人值或临时值。

用于验证设置值的函数，指定为函数句柄。指定时，该函数验证出厂设置的值。

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

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

版本历史记录

在 R2019b 中推出

另请参阅

|

主题