Simulink.dialog.Text Class

Namespace: Simulink.dialog
Superclasses: Simulink.dialog.Control

Manage text dialog control

Description

The Simulink.dialog.Text class enables you to manage a text dialog control in a mask dialog box. To create a text dialog control, get the mask object and add text dialog control element to it. For more information on adding dialog control elements to a mask dialog box, see Add Dialog Control Elements to Mask Dialog Box.

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

Class Attributes

ConstructOnLoad	true
HandleCompatible	true

For information on class attributes, see Class Attributes.

Properties

Name — Identifier of text dialog control

string scalar | character vector

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

Example: 'Text1'

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Data Types: string | char

Prompt — Display text of text dialog control

string scalar | character vector

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

Example: 'The input signal range is between 0 - 10 V'

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Data Types: string | char

WordWrap — Option to break lines between words in mask dialog box

'on' (default) | 'off'

Option to break lines between words in the mask dialog box, specified as 'on' or 'off'.

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Row — Placement of text dialog control

'new' (default) | 'current'

Placement of the text dialog control, specified as one of these values:

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

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

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Visible — Option to display text in mask dialog box

'on' (default) | 'off'

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

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Enabled — Display state of text

'on' (default) | 'off'

The display state of the text in the mask dialog box, specified as one of these values:

• 'on' — Text is active in the mask dialog box.

• 'off' — Text is grayed out in the mask dialog box.

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Tooltip — Informative message

string scalar | character vector

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

Example: 'Signal Description'

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Data Types: string | char

HorizontalStretch — Option to control horizontal stretch of text dialog control

'on' (default) | 'off'

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

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Alternatives

You can manage a text 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