Simulink.dialog.Button class

Package: Simulink.dialog
Superclasses: Simulink.dialog.Control

Create instance of button dialog control

Description

The Simulink.dialog.Button class is a handle class that enables you to manage button dialog control.

The Simulink.dialog.Button class is a handle class.

Properties

Name — Identifier of button dialog control

'Control' (default) | string scalar | character vector

Identifier of the button dialog control, specified as a string scalar or character vector.

Example: 'Control1'

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Data Types: char | string

Prompt — Display text of button dialog control

string scalar | character vector

Display text of the button dialog control, specified as a string scalar or character vector.

Example: 'Signal 1'

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Data Types: char | string

Callback — MATLAB^® code executed when you click button dialog control

character vector

MATLAB code executed when you click the button dialog control, specified as a character vector.

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Data Types: char

FilePath — Filename of image

string scalar | character vector

Filename of image shown on the button dialog control, specified as a string scalar or character vector. The file must be located on the MATLAB path.

Example: 'model.png'

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Data Types: char | string

Row — Placement of button dialog control

'new' (default) | 'current'

Placement of button dialog control, specified as 'new' or 'current'.

• 'new' — Place the button dialog control in a new row on the mask dialog box.

• 'current' — Place the button dialog control in the same row as the previous dialog control on the mask dialog box.

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Data Types: char | string

Enabled — Option to edit button on mask dialog box

'on' (default) | 'off'

Option to edit the button on the mask dialog box, specified as 'on' or 'off'.

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Data Types: logical

Visible — Option to display button on mask dialog box

'on' (default) | 'off'

Option to display the button on the mask dialog box, specified as 'on' or 'off'.

Example: 'on'

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Data Types: logical

HorizontalStretch — Option to control horizontal stretch of button dialog control

'on' (default) | 'off'

Option to control the horizontal stretch of the button dialog control when you resize the mask dialog box, specified as 'on' or 'off'.

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Data Types: logical

Tooltip — Informative message

string scalar | character vector

Informative message that appears when you point to the button on the mask dialog box, specified as a string scalar or character vector.

Example: 'Click to select'

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Data Types: char | string

Alternatives

You can manage a button dialog control using the Parameters & Dialog pane in the Mask Editor dialog box. For more information, see Parameters & Dialog Pane.

Version History

Introduced in R2013b