Simulink.MaskParameter Class
Namespace: Simulink
Control mask parameters programmatically
Description
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.
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 mask parameter, specified as a logical.
Data Types: char
Tunable
— Option to change mask parameter during simulation
on
(default) | off
| run-to-run
Option to change the mask parameter during simulation, specified as character vector or string. The available options are:
off - you cannot change mask parameter values during simulation in this mode.
on - you can change the mask parameter value during simulation. Each time you make a change the model is compiled.
run-to-run - If the mask parameter is set to run-to-run in Fast Restart mode, the value can be changed between runs. The model is not recompiled to reflect the value in simulation results.
Data Types: char
NeverSave
— Option to save mask parameter value in model file
off
(default) | on
Option to save the mask parameter value in the model file, specified as a logical.
Data Types: char
Hidden
— Option to hide mask parameter
off
(default) | on
Option to hide the mask parameter in the mask dialog, specified as a logical.
Data Types: char
ReadOnly
— Option to edit mask parameter
off
(default) | on
Option to edit the mask parameter in the mask dialog, specified as a logical.
Data Types: char
Enabled
— Option to enable mask parameter
on
(default) | off
Option to enable the mask parameter in the mask dialog, specified as a logical.
Data Types: char
Visible
— Option to show mask parameter in mask dialog
on
(default) | off
Option to show the mask parameter in the mask dialog, specified as a logical.
Data Types: char
ShowTooltip
— Option to enable tooltips for mask parameter
on
(default) | off
Option to enable tooltips for the mask parameter, specified as a logical.
Data Types: char
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.
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, specified as a character vector or logical value. The location of the parameter in the mask dialog 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 the 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
Version History
Introduced in R2006a
Comando MATLAB
Hai fatto clic su un collegamento che corrisponde a questo comando MATLAB:
Esegui il comando inserendolo nella finestra di comando MATLAB. I browser web non supportano i comandi 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)