Swimlanes

Return to Introduction  Previous page  Next page

A Swimlanes object is attached to a diagram's SwimlaneDef object and provides a mechanism to access individual swimlanes.

Swimlanes Attributes

Attribute

Type

Notes

Items

Swimlane collection

Read/Write. Access an individual swimlane.

param: Index [Object]

Either a string representing the title text or an integer representing the zero-based index of the swimlane to delete.

If the string matches more than one swimlane title, the first matching swimlane is returned.

ObjectType

ObjectType

Read only.  Distinguishes objects referenced through a Dispatch interface.

Swimlanes Methods

Method

Type

Notes

Count ()

Long

Gives the number of swimlanes.

Add (String, Long)

Swimlane

Adds a new swimlane to the end of the list.

param: Title [String]
The title text that appears at the top of the swimlane. Can be the same as an existing swimlane title.

param: Width [Long]
The width of the swimlane in pixels.

Returns:
A swimlane object representing the newly added entry.

Delete (Object)

void

param: Index [Object]

Either a string representing the title text or an integer representing the zero-based index of the swimlane to delete.

If the string matches more than one entry, only the first entry is deleted.

DeleteAll ()

void

Removes all swimlanes.

Insert (Long, String, Long)

Swimlane

Inserts a swimlane at a specific position.

param: Index [Long]

The zero-based index of the existing Swimlane before which this new entry is inserted.

param: Title [String]

The title text which appears at the top of the swimlane.  Can be the same as an existing swimlane title.

param: Width [Long]

The width of the swimlane in pixels.

Returns:

A swimlane object representing the newly added entry.