| Products & Services | Solutions | Academia | Support | User Community | Company |
| Download Product Updates | | | Get Pricing | | | Trial Software |
| Documentation → Simulink |
| Contents | Index |
| Learn more about Simulink |
| On this page… |
|---|
This section lists parameters that describe masked blocks. You can use these descriptive parameters with get_param and set_param to obtain and specify the properties of a block mask.
The descriptive mask parameters listed in this section apply to all masks, and provide access to all mask properties. Be careful not to confuse these descriptive mask parameters with the mask-specific parameters defined for an individual mask in the Mask Editor Parameters pane.
See Working with Block Masks for information about block masks and the Mask Editor.
Mask Parameters
Parameter | Description/Prompt | Values |
|---|---|---|
Mask | Turns mask on or off. | {'on'} | 'off' |
MaskCallbackString | Mask parameter callbacks that are executed when the respective parameter is changed on the dialog. Set by the Dialog callback field on the Parameters pane of the Mask Editor dialog box. | pipe-delimited string {''} |
MaskCallbacks | Cell array version of MaskCallbackString. | cell array {'[]'} |
MaskDescription | Block description. Set by the Mask description field on the Documentation pane of the Mask Editor dialog box. | string {''} |
MaskDisplay | Drawing commands for the block icon. Set by the Drawing commands field on the Icon & Ports pane of the Mask Editor dialog box. | string {''} |
MaskEditorHandle | For internal use only. | |
MaskEnableString | Option that determines whether a parameter is greyed out in the dialog. Set by the Enable parameter check box on the Parameters pane of the Mask Editor dialog box. | pipe-delimited string {''} |
MaskEnables | Cell array version of MaskEnableString. | cell array of strings, each either 'on' or ''off' {'[]'} |
MaskHelp | Block help. Set by the Mask help field on the Documentation pane of the Mask Editor dialog box. | string {''} |
MaskIconFrame | Set the visibility of the icon frame (Visible is on, Invisible is off). Set by the Block Frame option on the Icon & Ports pane of the Mask Editor dialog box. | {'on'} | 'off' |
MaskIconOpaque | Set the transparency of the icon (Opaque is on, Transparent is off). Set by the Icon Transparency option on the Icon & Ports pane of the Mask Editor dialog box. | {'on'} | 'off' |
MaskIconRotate | Set the rotation of the icon (Rotates is on, Fixed is off). Set by the Icon Rotation option on the Icon & Ports pane of the Mask Editor dialog box. | 'on' | {'off'} |
MaskIconUnits | Set the units for the drawing commands. Set by the Icon Units option on the Icon & Ports pane of the Mask Editor dialog box. | 'pixel' | {'autoscale'} | 'normalized' |
MaskInitialization | Initialization commands. Set by the Initialization commands field on the Initialization pane of the Mask Editor dialog box. | MATLAB command {''} |
MaskNames | Cell array of mask dialog parameter names. Set inside the Variable column in the Parameters pane of the Mask Editor dialog box. | matrix {'[]'} |
MaskPortRotate | Specify the port rotation policy for the masked block. Set in the Port Rotation area on the Icon & Ports pane of the Mask Editor dialog box. | {'default} | 'physical' |
MaskPrompts | List of dialog parameter prompts (see below). Set inside the Dialog parameters area on the Parameters pane of the Mask Editor dialog box. | cell array of strings {'[]'} |
MaskPromptString | List of dialog parameter prompts (see below). Set inside the Dialog parameters area on the Parameters pane of the Mask Editor dialog box. | string {''} See Note 1. |
MaskPropertyName | Pipe-delimited version of MaskNames. | string {''} |
MaskRunInitForIconRedraw | For internal use only. | |
MaskSelfModifiable | Indicates that the block can modify itself. Set by the Allow library block to modify its contents check box on the Initialization pane of the Mask Editor dialog box. | 'on' | {'off'} |
MaskStyles | Determines whether the dialog parameter is a check box, edit field, or pop-up list. Set by the Type column in the Parameters pane of the Mask Editor dialog box. | cell array {'[]'} |
MaskStyleString | Comma-separated version of MaskStyles. | string {''} See Note 2. |
MaskTabNameString | For internal use only. | |
MaskTabNames | For internal use only. | |
MaskToolTipsDisplay | Determines which mask dialog parameters to display in the data tip for this masked block (see "Block Data Tips" in the Simulink documentation). Specify as a cell array of 'on' or 'off' values, each of which indicates whether to display the parameter named at the corresponding position in the cell array returned by MaskNames. | cell array of 'on' and 'off' {''} |
MaskToolTipString | Comma-delimited version of MaskToolTipsDisplay. | string {''} |
MaskTunableValues | Allows the changing of mask dialog values during simulation. Set by the Tunable column in the Parameters pane of the Mask Editor dialog box. | cell array of strings {'[]'} |
MaskTunableValueString | Comma-delimited string version of MaskTunableValues. | delimited string {''} |
MaskType | Mask type. Set by the Mask type field on the Documentation pane of the Mask Editor dialog box. | string {'Stateflow'} |
MaskValues | Dialog parameter values. | cell array {'[]'} |
MaskValueString | Delimited string version of MaskValues. | delimited string {''} See Note 3. |
MaskVarAliases | Specify aliases for a block's mask parameters. The aliases must appear in the same order as the parameters appear in the block's MaskValues parameter. | cell array {'[]'} |
MaskVarAliasString | For internal use only. | |
MaskVariables | List of the dialog parameters' variables (see below). Set inside the Dialog parameters area on the Parameters pane of the Mask Editor dialog box. | string {''} See Note 4. |
MaskVisibilities | Specifies visibility of parameters. Set with the Show parameter check box in the Options for selected parameter area on the Parameters pane of the Mask Editor dialog box. | matrix {'[]'} |
MaskVisibilityString | Delimited string version of MaskVisibilities. | string {''} |
MaskWSVariables | List of the variables defined in the mask workspace (read only). | matrix {'[]'} |
The MaskPromptString parameter stores the Prompt field values for all mask dialog box parameters as a string, with individual values separated by vertical bars (|), for example:
"Slope:|Intercept:"
The MaskStyleString parameter stores the Type field values for all mask dialog box parameters as a string, with individual values separated by commas. The Popup strings values appear after the popup type, as shown in this example:
"edit,checkbox,popup(red|blue|green)"
The MaskValueString parameter stores the values of all mask dialog box parameters 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:
"2|5"
The MaskVariables parameter stores the Variable field values for all mask dialog box parameters as a string, with individual assignments separated by semicolons. A sequence number indicates the prompt that is associated with a variable. A special character preceding the sequence number indicates whether the parameter value is evaluated or used literally. An at-sign (@) indicates evaluation; an ampersand (&) indicates literal usage. For example:
"a=@1;b=&2;"
This string defines two Variable field values:
The value entered in the first parameter field is evaluated in the MATLAB workspace, and the result is assigned to variable a in the mask workspace.
The value entered in the second parameter field is not evaluated, but is assigned literally to variable b in the mask workspace.
![]() | Block-Specific Parameters | Model File Format | ![]() |

Learn more about Simulink through this collection of videos, articles, technical literature and the Getting Started with Simulink Guide.
| © 1984-2009- The MathWorks, Inc. - Site Help - Patents - Trademarks - Privacy Policy - Preventing Piracy - RSS |