Simulink.MaskParameter Class

R2026b

Namespace: Simulink

Set or modify the properties of a mask parameter

Description

Use a Simulink.MaskParameter object to programmatically set or modify the properties of a mask parameter, such as its type, value, callback, and dialog settings.

Use an instance of Simulink.MaskParameter to set the properties of a mask parameter.

Properties

Type — Mask parameter type

edit (default) | checkbox | popup | combobox | listbox | promote

Mask parameter type, specified as character vector

Data Types: char | string

TypeOptions — Type options of parameter

cell (default) | Simulink.Mask.EnumerationTypeOptions | ...

The options that are displayed within a popup or combobox or listbox parameter, specified as a cell array.

Data Types: cell

Name — Name of mask parameter

character vector (default)

Name of the mask parameter, specified as a character vector. This name is assigned to the mask workspace variable created for the mask parameter. The mask parameter name must not match the built-in parameter name.

Data Types: char

Prompt — Display name for mask parameter

character vector (default)

Display name for the mask parameter, specified as a character vector. This name appears as the label associated with the parameter on the mask dialog box.

Data Types: char

Value — Mask parameter value

character vector (default)

Mask parameter value, specified as a character vector. For example, the default value for Checkbox is 'on' while the default value for Listbox is {''} and accepts a cell array of character vectors.

Data Types: char

Evaluate — Option to evaluate mask parameter

"on" (default) | "off"

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

Tunable — Option to decide tunable behavior of mask parameter

"on" (default) | "off" | "run-to-run"

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

NeverSave — Option to save mask parameter values in model file

"off" (default) | "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.

Hidden — Option to hide mask parameter value

"off" (default) | "on"

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

ReadOnly — Option to edit mask parameter value

"off" (default) | "on"

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

Enabled — Option to enable mask parameter

"on" (default) | "off"

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

Visible — Option to show mask parameter in mask dialog box

"on" (default) | "off"

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

ShowTooltip — Option to enable tooltips for mask parameter

"on" (default) | "off"

Option to enable tooltips for the mask parameter, specified as "on" or "off".

Callback — Callback code for the mask parameter

character vector (default)

Callback code for the mask parameter, specified as a character vector. The callback code executes when a user changes the parameter value in the mask dialog box. If the callback for the parameter is in a callback file, then this property remains empty.

Data Types: char | string

TabName — Name of tab container

character vector (default)

Name of the tab container in which the mask parameter is displayed in the mask dialog box, specified as a character vector.

Data Types: char

Alias — Alternative name for mask parameter

character vector (default)

Alternative name for the mask parameter, specified as a character vector.

Data Types: char

DialogControl — Layout options

Simulink.dialog.parameter.Edit object (default) | Simulink.dialog.parameter.Popup | Simulink.dialog.parameter.ComboBox | ...

Layout options for the parameter in the mask dialog box, specified as a character vector or logical value. The location of the parameter in the mask dialog box such as the row location, prompt location is specified. Additionally horizontal stretch or shrink of the mask parameter is also specified.

Data Types: object

ConstraintName — Constraint associated with parameter

character vector (default)

Constraint associated with the mask parameter, specified as a character vector. To associate a constraint programmatically the constraint must be already available. To associate a constraint in a MAT file, use the format <matfilename>:<constraintname>.

Data Types: char

Methods

Public Methods

set

Version History

Introduced in R2006a

R2026b: Use Simulink.MaskParameter.Behavior object to access parameter behavior properties

Use the Simulink.MaskParameter.Behavior object to access ReadOnly, Hidden, and NeverSave parameter behavior properties. Support for accessing these properties directly from the Simulink.MaskParameter class will be removed in a future release.