Box Properties :: API Properties and Methods by Object (Stateflow User's Guide)

Stateflow User's Guide

Box Properties

The following are properties of Stateflow API objects of type Box. See also Box Methods.

Property
Type
Acc
Description

ArrowSize
Double
RW
Size of transition arrows coming into this box (default = 8). Equivalent to selecting Arrowhead Size from the context menu for this box.

BadIntersection
Boolean
RO
If true, this box graphically intersects a state, graphical function, or other box.

Chart
Chart
RO
Chart object containing this box.

Description
String
RW
Description of this box (default = ''). Equivalent to entering a description in the Description field of the properties dialog for this box.

Document
String
RW
Document link to this box (default = ''). Equivalent to entering the Document Link field of the properties dialog for this box.

FontSize
Double
RW
Size of the font (default = 12) for the label text of this box. This property overrides the font size set for this box at creation by the StateFont.Size property of the containing Chart's object. Equivalent to selecting Font Size > <font size> in the context menu for this box.

Id
Integer
RW
Unique identifier assigned to this box to distinguish it from other objects loaded in memory.

IsGrouped
Boolean
RW
If set to true (default = false), group this box.

IsSubchart
Boolean
RW
If set to true (default = false), make this box a subchart.

LabelString
String
RW
Label for this box (default = '?'). Equivalent to typing the label for this box in its label text field in the diagram editor.

Machine
Machine
RO
Machine that contains this box.

Name
String
RW
Name of this box (default = ''). Equivalent to typing this box's name into the beginning of the label text field for this box in the diagram editor.

Position
Rect
RW
Position and size of this box in the Stateflow chart, given in the form of a 1-by-4 array (default is [0 0 90 60]) consisting of the following:
(x,y) coordinates for the box's left upper vertex relative to the upper left vertex of the Stateflow diagram editor workspace

Width and height of the box

Subviewer
Chart or State
RO
State or chart in which this box can be graphically viewed.

Tag
Any Type
RW
Holds data of any type (default = []) for this box.

Property	Type	Acc	Description
`ArrowSize`	Double	RW	Size of transition arrows coming into this box (default = 8). Equivalent to selecting Arrowhead Size from the context menu for this box.
`BadIntersection`	Boolean	RO	If `true`, this box graphically intersects a state, graphical function, or other box.
`Chart`	Chart	RO	Chart object containing this box.
`Description`	String	RW	Description of this box (default = `''`). Equivalent to entering a description in the Description field of the properties dialog for this box.
`Document`	String	RW	Document link to this box (default = `''`). Equivalent to entering the Document Link field of the properties dialog for this box.
FontSize	Double	RW	Size of the font (default = `12`) for the label text of this box. This property overrides the font size set for this box at creation by the `StateFont.Size` property of the containing Chart's object. Equivalent to selecting Font Size > <font size> in the context menu for this box.
`Id`	Integer	RW	Unique identifier assigned to this box to distinguish it from other objects loaded in memory.
IsGrouped	Boolean	RW	If set to `true` (default = `false`), group this box.
IsSubchart	Boolean	RW	If set to `true` (default = `false`), make this box a subchart.
`LabelString`	String	RW	Label for this box (default = `'?'`). Equivalent to typing the label for this box in its label text field in the diagram editor.
`Machine`	Machine	RO	Machine that contains this box.
`Name`	String	RW	Name of this box (default = `''`). Equivalent to typing this box's name into the beginning of the label text field for this box in the diagram editor.
`Position`	Rect	RW	Position and size of this box in the Stateflow chart, given in the form of a 1-by-4 array (default is `[0 0 90 60]`) consisting of the following: (x,y) coordinates for the box's left upper vertex relative to the upper left vertex of the Stateflow diagram editor workspace Width and height of the box
`Subviewer`	Chart or State	RO	State or chart in which this box can be graphically viewed.
Tag	Any Type	RW	Holds data of any type (default = `[]`) for this box.

State Methods Box Methods