set

Class: Simulink.MaskParameter
Namespace: Simulink

Set properties of mask parameters

Syntax

maskobj.Parameters.set(Name,Value)

Description

maskobj.Parameters.set(Name,Value) sets the properties of a mask parameter.

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: 'Type','edit'

Type — Type of parameter

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

Type of parameter, specified as character vector.

Data Types: char | string

TypeOptions — Type options of parameter

cell (default) | ...

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)

The name of the mask parameter, specified as a character vector. This name is assigned to the mask workspace variable created for this parameter.

Data Types: char | string

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 | string

Value — Mask parameter value

character vector (default)

The default value of the mask parameter in the Mask Parameters dialog. Type specific, depends on the Type of the parameter, specified as a character vector.

Data Types: char | string

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 value.

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

Alias — Alternative name for mask parameter

empty (default)

Alternative name for the mask parameter is specified as character vector.

Data Types: char | string

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.

Examples

Set the Values of Mask Parameter

1. Get mask as an object using a masked block’s path.

   maskobj = Simulink.Mask.get('setmaskparameter/Subsystem');

2. Get mask parameter

   parameters = maskobj.Parameters(1);

3. Edit mask parameter so it is of type popup, cannot be evaluated.

    maskobj.Parameters.set('Type','popup','TypeOptions',...
   {'Red' 'Blue' 'Green'},'Evaluate','off')

Version History

Introduced in R2006a