Generate Sequence Diagram dialog box

Go Up to Modeling Dialog Boxes Index

Context menu > Generate Sequence Diagram

You can open the Generate Sequence Diagram dialog box from context menus of the Model View or Diagram View. Right-click a method and choose Generate Sequence Diagram from the context menu.

In the Generate Sequence Diagram dialog box you can set options for Sequence Diagram generation. This dialog box lists the classes and namespaces involved in the method and allows you to choose which classes and namespaces to display on the sequence diagram to be generated.

Options

By default, the Generate Sequence Diagram dialog box uses setting of Sequence Diagram Generation options that are specified in the Modeling - Generate Sequence Diagram Options dialog box. Here you can change these options as required for the sequence diagram to be generated.

The Generate Sequence Diagram dialog box provides the following options:

Option	Description
Diagram name	The name of the sequence diagram to be generated. By default, this is the name of the method for which to generate the sequence diagram.
Exclude messages to self	Specifies whether to skip messages to self on the sequence diagram to be generated. If this option is checked, then messages that an object sent to itself are not shown.
Exclude messages to properties	Specifies whether to skip implementations of property accessors.
Hyperlink method with diagram	Defines whether to hyperlink the method and the newly created sequence diagram. The method is displayed in blue text on the diagram to indicate that a hyperlink exists. Right-click the method and choose Hyperlinks > Sequence_diagram_name to navigate to the sequence diagram.
Exclude repeated messages to	Specifies whether to skip repeated implementations of methods. If this option is checked ON, you should specify which messages should not be shown. One of the following two options should be selected: one object—shows only the first implementation of the method for each object of a class. all objects of a class—shows only the first implementation of the method only for the first object of a class.
Call depth	During source code parsing, this value limits how deep the parser traverses the source code calling sequence. This value can help keep the generated sequence diagram from becoming so large that it becomes unusable. You may want to use this option as a means for quickly generating a high-level sequence diagram for a complex method by using a low call nesting value (1-3). Based on the results of your diagram, you can choose to look deeper and/or create additional sequence diagrams for each of the major methods uncovered.

Parameters

The central pane lists the classes and namespaces involved in the method. It has the following parameters:

Parameter	Description
Name	Lists the names of namespaces and classes involved in the method.
Show On Diagram	Defines whether to show namespaces and classes on the sequence diagram to be generated. All involved namespaces and classes are selected by default. However, some classes may not be relevant. To increase the meaningfulness of the generated diagram, clear the check boxes before the namespaces and classes that are not helpful in explaining the sequence of operations.
Show Implementation	Defines whether to show implementations of methods in the selected namespaces and classes.

Buttons

The Generate Sequence Diagram dialog box has the following buttons:

Button	Description
OK	Generates the new sequence diagram and shows the generated diagram in the Diagram View.
Cancel	Closes the dialog box without generating a sequence diagram.
Help	Displays this help topic.

See Also

• Generating Sequence Diagrams
• Modeling - Generate Sequence Diagram Options