slreportgen.utils.getDisplayIcon

Get Simulink or Stateflow icon file name

Syntax

displayIcon = slreportgen.utils.getDisplayIcon(obj)

displayIcon = slreportgen.utils.getDisplayIcon(___,FullPath=pathOption)

Description

displayIcon = slreportgen.utils.getDisplayIcon(obj) returns the file path of the icon image for the Simulink^® or Stateflow^® object,obj. The file path is relative to the MATLAB^® root folder .

displayIcon = slreportgen.utils.getDisplayIcon(___,FullPath=pathOption) returns the full file of the icon image for the Simulink or Stateflow object, obj.

Examples

Get Icon Path for Stateflow Chart

openExample("sf_car")
chart = find(slroot,"-isa","Stateflow.Chart", ...
    Name="shift_logic");
iconPath = slreportgen.utils.getDisplayIcon(chart);

Get Full Path to Icon Image for Stateflow Chart

openExample("sf_car")
chart = find(slroot,"-isa","Stateflow.Chart", ...
    Name="shift_logic");
iconPath = slreportgen.utils.getDisplayIcon(chart,FullPath=true);

Input Arguments

obj — Simulink or Stateflow object

string | character array

Simulink or Stateflow object, specified as a string or character array of its path or handle.

pathOption — Whether to include full file path to icon image

0 (false) (default) | 1 (true)

Whether to include the full file path to the icon image, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Include the full file path to the icon image.

• 0 (false) — Do not include the full file path to the icon image.

Output Arguments

displayIcon — Icon image file path

character vector

Icon image file path, returned as a character vector.

Version History

Introduced in R2018b