addGroup
説明
s = addGroup(
は、指定した親設定グループに新しい設定グループを追加し、新しい設定グループを含む parentgroup
,name
)SettingsGroup
オブジェクトを返します。既定では、設定グループは非表示ではありません。つまり、親設定グループ内に表示されます。
s = addGroup(___,
は、1 つ以上の名前と値のペアの引数を使用して、設定グループのプロパティを指定します。たとえば、Name,Value
)'Hidden',true
は非表示の設定グループを追加します。名前と値のペアは他のすべての入力引数の後で指定します。
例
設定グループの追加と削除
関数 settings
を使用して設定ツリーのルートにアクセスしてから、設定グループ mysettings
を作成します。
s = settings;
newGroup = addGroup(s,"mysettings");
s
s = SettingsGroup with properties: mysettings: [1×1 SettingsGroup] mytest: [1×1 SettingsGroup] matlab: [1×1 SettingsGroup]
removeGroup
を使用して mysettings
を削除します。
removeGroup(s,"mysettings");
s
s = SettingsGroup with properties: mytest: [1×1 SettingsGroup] matlab: [1×1 SettingsGroup]
非表示の設定グループの追加
関数 settings
を使用して設定ツリーのルートにアクセスし、非表示の設定グループ myhiddensettings
を作成します。新しいグループは非表示であるため、親設定グループを表示しても表示されません。
s = settings;
addGroup(s,"myhiddensettings",Hidden=true);
s
s = SettingsGroup with properties: mytest: [1×1 SettingsGroup] matlab: [1×1 SettingsGroup]
myhiddensettings
は、設定ツリーには表示されませんが、アクセスは可能です。たとえば、myhiddensettings
内に設定グループ myveryhiddensettings
を作成できます。
addGroup(s.myhiddensettings,"myveryhiddensettings");
s.myhiddensettings
ans = SettingsGroup 'myhiddensettings' with properties: myveryhiddensettings: [1×1 SettingsGroup]
非表示のグループは、表示されるグループと同じ方法で削除できます。
removeGroup(s,"myhiddensettings")
グループ内の設定値の検証
設定グループを作成し、そのグループの既定の検証関数を指定します。この関数は、グループ内で独自の検証関数が定義されていないすべての設定の値を検証します。
入力が数値でない場合にエラーをスローする検証関数 numericValidationFcn
を作成します。
function numericValidationFcn(x) errorMsg = "Value must be numeric."; assert(isnumeric(x),errorMsg); end
関数 settings
を使用して設定ツリーのルートにアクセスしてから、設定グループ myNumericSettings
を作成します。検証関数を指定します。
s = settings; newNumericGroup = addGroup(s,"myNumericSettings",... ValidationFcn=@numericValidationFcn);
myNumericSettings
グループ内に新しい設定を作成し、その設定の値を数値以外の値に設定しようとすると、MATLAB でエラーが発生します。たとえば、次のステートメントを実行すると、MATLAB でエラーが発生します。このステートメントは PersonalValue
を数値ではなく string に設定しようとします。
addSetting(newNumericGroup,"mySetting",PersonalValue="Hello")
removeGroup
を使用して myNumericSettings
を削除します。
removeGroup(s,"myNumericSettings");
入力引数
parentgroup
— 親設定グループ
SettingsGroup
オブジェクト
グループの追加先の親設定グループ。SettingsGroup
オブジェクトとして指定します。ルートの設定グループ オブジェクトおよび利用可能なすべての設定グループにアクセスするには、関数 settings
を使用します。
name
— 追加する設定グループの名前
文字ベクトル | string スカラー
追加する設定グループの名前。文字ベクトルまたは string スカラーとして指定します。指定した親設定グループに name
が既に存在する場合、MATLAB® はエラーをスローします。また、addSetting
や hasGroup
など、SettingsGroup
オブジェクトのメソッドの名前と name
が一致している場合も MATLAB でエラーになります。
名前と値の引数
引数のオプションのペアを Name1=Value1,...,NameN=ValueN
として指定します。ここで Name
は引数名で、Value
は対応する値です。名前と値の引数は他の引数の後になければなりませんが、ペアの順序は重要ではありません。
R2021a より前では、コンマを使用してそれぞれの名前と値を区切り、Name
を引用符で囲みます。
例: addGroup(parentgroup,'myGroup','Hidden',true)
は、指定した親設定グループに新しい非表示の設定グループを追加します。
Hidden
— 非表示の状態
false
(既定値) | true
非表示の状態。true
または false
として指定します。
true
に設定すると、設定グループおよびグループ内の設定は表示されませんが、アクセスは可能なままです。
ValidationFcn
— グループ内の設定を検証する関数
関数ハンドル
グループ内の設定を検証する関数。関数ハンドルとして指定します。指定した関数は、グループ内で独自の検証関数が定義されていないすべての設定の値を検証するために使用されます。
関数ハンドルを関連付ける関数は、設定可能な値を入力引数として受け入れ、出力引数をもたず、検証が失敗した場合にエラーをスローするものでなければなりません。
関数ハンドルは、MATLAB パス上の関数をポイントしなければなりません。無名または入れ子の関数ハンドルはサポートされません。
バージョン履歴
R2019b で導入
MATLAB コマンド
次の MATLAB コマンドに対応するリンクがクリックされました。
コマンドを MATLAB コマンド ウィンドウに入力して実行してください。Web ブラウザーは MATLAB コマンドをサポートしていません。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)