Documentation Center

  • Trial Software
  • Product Updates

Simulink.MaskParameter class

Package: Simulink

Control mask parameters programmatically

Description

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

Properties

Type

Specifies the mask parameter type.

Type: string

Values: 'edit'|'checkbox'|'popup'|'unidt'|'min'|'max'|'promote'

Default: 'edit'

TypeOptions

Specifies the option for the parameter if it exists, otherwise, it is empty. Applicable for parameters of type popup and promote .

Type: cell array of strings

Default: {''}

Name

Specifies the name of the mask parameter. This name is assigned to the mask workspace variable created for this parameter.

Type: string

Default: Empty String

Prompt

Specifies a string that appears as the label associated with the parameter on the mask dialog.

Type: string

Default: Empty String

Value

Specifies the value of the mask parameter.

Default: Depends on the type of the parameter.

Evaluate

Indicates if the parameter value is to be evaluated in MATLAB® or treated as a string when the block is evaluated.

Type: boolean

Values: 'on'|'off'

Default: 'on'

Tunable

Indicates if the parameter value can be changed during simulation.

Type: boolean

Values: 'on'|'off'

Default: 'on'

NeverSave

Indicates if the parameter value gets saved in the model file.

Type: boolean

Values: 'on'|'off'

Default: 'off'

Internal

Indicates if the parameter should never show on the mask dialog box.

Type: boolean

Values: 'on'|'off'

Default: 'off'

Enabled

Indicates if the parameter is enabled in the mask dialog box.

Type: boolean

Values: 'on'|'off'

Default: 'on'

Visible

Indicates if the parameter is visible in the mask dialog box.

Type: boolean

Values: 'on'|'off'

Default: 'on'

ToolTip

Indicates if tool tip is enabled for the mask parameter.

Type: boolean

Values: 'on'|'off'

Default: 'on'

Callback

Specifies the MATLAB code that executes when a user changes the parameter value from the mask dialog box.

Type: string

Default: Empty String

TabName

Specifies the tab name of the mask dialog box where the parameter is displayed.

Type: string

Default: Empty String

Methods

setSet properties of mask parameters

How To

Was this topic helpful?