Simulink Reference

Mask Parameters

This section lists parameters that describe masked blocks. This table lists masking parameters, which correspond to Mask Editor dialog box parameters.

Table 8-15: Mask Parameters 

Parameter	Description/Prompt	Values
Mask	Turns mask on or off.	{on} | off
MaskCallbackString	Mask parameter callbacks	delimited string
MaskCallbacks	Mask parameter callbacks	cell array
MaskDescription	Block description	string
MaskDisplay	Drawing commands	display commands
MaskEditorHandle	Mask editor figure handle (for internal use)	handle
MaskEnableString	Mask parameter enable status	delimited string
MaskEnables	Mask parameter enable status	cell array of strings, each either 'on' or 'off'
MaskHelp	Block help	string
MaskIconFrame	Icon frame (Visible is on, Invisible is off)	{on} | off
MaskIconOpaque	Icon transparency (Opaque is on, Transparent is off)	{on} | off
MaskIconRotate	Icon rotation (Rotates is on, Fixed is off)	on | {off}
MaskIconUnits	Drawing coordinates	Pixel | {Autoscale} | Normalized
MaskInitialization	Initialization commands	MATLAB command
MaskNames
MaskPrompts	Prompt (see below)	cell array of strings
MaskPromptString	Prompt (see below)	delimited string
MaskPropertyNameString
MaskSelfModifiable	Indicates that the block can modify itself.	on | {off}
MaskStyles	Control type (see below)	cell array {Edit} | Checkbox | Popup
MaskStyleString	Control type (see below)	{Edit} | Checkbox | Popup
MaskTunableValues	Tunable parameter attributes	cell array of strings
MaskTunableValue String	Tunable parameter attributes	delimited string
MaskType	Mask type	string
MaskValues	Block parameter values (see below)	cell array of strings
MaskValueString	Block parameter values (see below)	delimited string
MaskVariables	Variable (see below)	string
MaskVisibilities	Specifies visibility of parameters

When you use the Mask Editor to create a dialog box parameter for a masked block, you provide this information:

• The prompt, which you enter in the Prompt field
• The variable that holds the parameter value, which you enter in the Variable field
• The type of field created, which you specify by selecting a Control type
• Whether the value entered in the field is to be evaluated or stored as a literal, which you specify by selecting an Assignment type

The mask parameters, listed in the table on the previous page, store the values specified for the dialog box parameters in these ways:

• The Prompt field values for all dialog box parameters are stored in the MaskPromptString parameter as a string, with individual values separated by a vertical bar (|), as shown in this example.

• "Slope:|Intercept:"
  

• The Variable field values for all dialog box parameters are stored in the MaskVariables parameter as a string, with individual assignments separated by a semicolon. A sequence number indicates the prompt that is associated with a variable. A special character preceding the sequence number indicates the Assignment type: @ indicates Evaluate, & indicates Literal.

• For example, "a=@1;b=&2;" indicates that the value entered in the first parameter field is assigned to variable a and is evaluated in MATLAB before assignment, and the value entered in the second field is assigned to variable b and is stored as a literal, which means that its value is the string entered in the dialog box.

• The Control type field values for all dialog box parameters are stored in the MaskStyleString parameter as a string, with individual values separated by a comma. The Popup strings values appear after the popup type, as shown in this example:

• "edit,checkbox,popup(red|blue|green)"
  

• The parameter values are stored in the MaskValueString mask parameter as a string, with individual values separated by a vertical bar. The order of the values is the same as the order in which the parameters appear on the dialog box. For example, these statements define values for the parameter field prompts and the values for those parameters:

• MaskPromptString     "Slope:|Intercept:"
  MaskValueString      "2|5"
  

Block-Specific Parameters

Model File Format