Simulink.dialog.Image Class

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

Manage image dialog control

Description

The Simulink.dialog.Image class enables you to manage an image dialog control in a mask dialog box. To create an image dialog control, get the mask object and add an image 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.Image class is a handle class.

Class Attributes

ConstructOnLoad	true
HandleCompatible	true

For information on class attributes, see Class Attributes.

Properties

Name — Identifier of image dialog control

string scalar | character vector

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

Example: 'Image1'

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Data Types: string | char

FilePath — Relative path or filename of image

string scalar | character vector

The relative path or filename of the image shown on the image dialog control, specified as a string scalar or character vector. The file must be located on the MATLAB^® path. Provide the relative path to the image when the image is in a packaged directory else provide the filename of the image.

Example: 'model.png','+audio/+simulink/model.png'

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Data Types: string | char

Row — Placement of image dialog control

'new' (default) | 'current'

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

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

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

'on' (default) | 'off'

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

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Enabled — Display state of image

'on' (default) | 'off'

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

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

• 'off' — Image 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 image 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 image dialog control

'on' (default) | 'off'

Option to control the horizontal stretch of the image 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 an image 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