removeParameter

Class: Simulink.Mask
Namespace: Simulink

Remove parameter from mask dialog box

Syntax

successIndicator = maskObj.removeParameter(controlIdentifier)

Description

successIndicator = maskObj.removeParameter(controlIdentifier) removes parameter, specified by controlIdentifier, like edit, check box, popup from an existing mask dialog box. First get the mask object and assign it to the variable maskObj.

Successful removal of a parameter returns a Boolean value of 1.

Input Arguments

controlIdentifer — Unique identifier for the parameter

character vector | string scalar

Programmatic identifier for the parameter of mask dialog box, specified as a character vector.

Examples

Remove Parameter from Mask Dialog Box

% Get mask object on the Gain block in the model Engine.

maskObj = Simulink.Mask.get('Engine/Gain');

% Remove parameter named checkbox1 from mask dialog box.

p = maskObj.removeParameter('checkbox1');

Note

You can also use the index number as the controlIdentifier.

Version History

Introduced in R2012b