Simulink.dialog.Group Class

Namespace: Simulink.dialog
Superclasses: Simulink.dialog.Container, Simulink.dialog.Control

Create instance of group dialog control

Description

The Simulink.dialog.Group class is a handle class that enables you to manage dialog control elements within groups on a mask dialog box. To manage dialog control elements in groups, get the mask object and use the methods of the Simulink.dialog.Container class.

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

Properties

Name — Identifier of group dialog control

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

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

Example: 'Container1'

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Data Types: char | string

Prompt — Display text of group dialog control

string scalar | character vector

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

Example: 'Signal Attributes'

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Data Types: char | string

Row — Placement of group dialog control

'new' (default) | 'current'

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

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

• 'current' — Place the group 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 parameters in mask dialog box

'on' (default) | 'off'

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

• 'on' — You can edit the parameters within the group on a mask dialog box.

• 'off' — You cannot edit the parameters within the group on a mask dialog box.

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Data Types: logical

Visible — Option to display group on mask dialog box

'on' (default) | 'off'

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

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Data Types: logical

AlignPrompts — Option to justify text boxes of edit and popup parameters within group dialog control

'off' (default) | 'on'

Option to justify the text boxes of edit and popup parameters within the group dialog control, specified as 'on' or 'off'.

• 'on' — Justify text boxes within the group dialog based on the longest parameter prompt.

• 'off' — Do not justify text boxes.

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Data Types: logical

DialogControls — Child dialog controls of group dialog control

character vector

Child dialog controls of the group dialog control, specified as a character vector.

Example: '[1×2 Simulink.dialog.Control]'

Attributes:

GetAccess	public
SetAccess	private
GetObservable	true
SetObservable	true

Data Types: char

Tooltip — Informative message

string scalar | character vector

Informative message that appears when you point to an instance of the group dialog control, specified as a string scalar or character vector.

Example: 'Type-A Signals'

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Data Types: char | string

Methods

Public Methods

addDialogControl	Add dialog control elements to mask dialog box
getDialogControl	Search for a specific dialog control on the mask
removeDialogControl	Remove dialog control from container in mask dialog box

Alternatives

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

Version History

Introduced in R2013b