Main Content

Stateflow.Box

Box in chart, state, box, or function

    Description

    Use Stateflow.Box objects to organize objects such as functions and states in your chart. You can also use a box to encapsulate states and functions in a separate namespace. For more information, see Group Chart Objects by Using Boxes.

    Creation

    Description

    example

    box = Stateflow.Box(parent) creates a Stateflow.Box object in a parent chart, state, box, or graphical function.

    Input Arguments

    expand all

    Parent for the new box, specified as a Stateflow® API object of one of these types:

    Properties

    expand all

    Stateflow API objects have properties that correspond to the values you set in the Stateflow Editor. To access or modify a property, use dot notation. To access or modify multiple properties for multiple API objects, use the get and set functions, respectively. For more information, see Modify Properties and Call Functions of Stateflow Objects.

    Content

    Name of the box, specified as a character vector.

    Label for the box, specified as a character vector.

    Whether to comment out the box, specified as a numeric or logical 1 (true) or 0 (false). Setting this property to true is equivalent to right-clicking the box and selecting Comment Out. For more information, see Commenting Stateflow Objects in a Chart.

    This property is read-only.

    Whether the box is implicitly commented out, specified as a numeric or logical 1 (true) or 0 (false). The box is implicitly commented out when you comment out a state, box, or function that contains it.

    Comment text for the box, specified as a character vector. This property applies only when the IsExplicitlyCommented property is true. In the Stateflow Editor, when you point to the comment badge on the box, the text appears as a tooltip. When you set the IsExplicitlyCommented property to false, the value of CommentText reverts to ''.

    Graphical Appearance

    Position and size of the box, specified as a four-element numeric vector of the form [left top width height].

    This property is read-only.

    Whether the box graphically intersects a box, state, or function, specified as a numeric or logical 1 (true) or 0 (false).

    Whether the box is a grouped box, specified as a numeric or logical 1 (true) or 0 (false). When you copy and paste a grouped box, you copy not only the box but all of its contents. For more information, see Copy and Paste by Grouping.

    Whether the box is a subchart, specified as a numeric or logical 1 (true) or 0 (false).

    Whether to display a preview of the box contents, specified as a numeric or logical 1 (true) or 0 (false). This property applies only when the IsSubchart property is true.

    Font size for the box label, specified as a scalar. The StateFont.Size property of the chart that contains the box sets the initial value of this property.

    Hierarchy

    This property is read-only.

    Chart that contains the box, specified as a Stateflow.Chart object.

    This property is read-only.

    Subviewer for the box, specified as a Stateflow.Chart, Stateflow.State, Stateflow.Box, or Stateflow.Function object. The subviewer is the chart or subchart where you can graphically view the box.

    This property is read-only.

    Machine that contains the box, specified as a Stateflow.Machine object.

    This property is read-only.

    Location of the parent of the box in the model hierarchy, specified as a character vector.

    Identification

    Description for the box, specified as a character vector.

    Document link for the box, specified as a character vector.

    User-defined tag for the box, specified as data of any type.

    This property is read-only.

    Unique identifier, specified as an integer scalar. Use this property to distinguish the box from other objects in the model. The value of this property is reassigned every time you start a new MATLAB® session and may be recycled after an object is deleted.

    Object Functions

    findIdentify specified objects in hierarchy
    getChildrenIdentify children of object
    getParentIdentify parent of object
    dialogOpen properties dialog box
    isCommentedDetermine if graphical object is commented out
    viewDisplay object in editing environment
    highlightHighlight graphical object
    fitToViewZoom in on graphical object

    Examples

    collapse all

    Add a box in the chart ch. Set its name to 'A'.

    box = Stateflow.Box(ch);
    box.Name = 'A';
    Introduced before R2006a