Simulink.MaskParameter.Behavior Class

R2026b

Namespace: Simulink.MaskParameter

Set properties that control mask parameter behavior

Since R2026b

expand all in page

Description

Use a Simulink.MaskParameter.Behavior object to set properties that control mask parameter behavior.

Properties

expand all

Option to evaluate the mask parameter, specified as "on or "off".

Option to decide the tunable behavior of a mask parameter, specified as "on" or "off" or "run-to-run". The available options are:

  • "on" — Enables changes to the mask parameter value during simulation. Each time you make a change, the model recompiles.

  • "off" — Disables changes to the mask parameter values during simulation.

  • "run-to-run" — Allows changes to the mask parameter value between simulation runs. Simulink® applies the changes when the simulation restarts but does not reflect them during an active simulation.

Data Types: char | string

Option to edit the mask parameter value in the mask dialog box, specified as "off or "on".

Option to hide the mask parameter value in the mask dialog box, specified as "off or "on".

Option to save the mask parameter values in the model file, specified as "off or "on".

  • "off" — Simulink saves the mask parameter value with the model.

  • "on" — Simulink does not save the mask parameter value with the model.

Option to evaluate only the custom values in a combo box, specified as "off" or "on". This property works with the Evaluate property to control how Simulink evaluates combo box values. Use this property only when Evaluate is "on".

  • If Evaluate is "on" and EvalOnlyCustomValues is "on", Simulink evaluates only typed custom values in a combo box.

  • If Evaluate is "on" and EvalOnlyCustomValues is "off", Simulink evaluates both predefined type options and typed custom values in a combo box.

Examples

collapse all

Open the example TypesOfMaskParametersExample. Get the mask object of the Subsystem block ComboBoxWithEvaluate and the parameter object of the mask parameter gain.

openExample("simulink_masking/TypesOfMaskParametersExample");
maskObj = Simulink.Mask.get('slexMaskParameterOptionsExample/ComboBoxWithEvaluate');
maskParam = maskObj.getParameter('gain');

To set the properties EvalOnlyCustomValues and Hidden to "on", use the following commands.

maskParam.Behavior.Evaluate = "on";
maskParam.Behavior.EvalOnlyCustomValues = "on";
maskParam.Behavior.Hidden = "on";

Version History

Introduced in R2026b

See Also

|

Topics