Please note : This help page is not for the latest version of Enterprise Architect. The latest help can be found here.

Swimlanes Class

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

Swimlanes Attributes

Attribute

Description

See also

Count

Long

Notes: Read/Write

Gives the number of swimlanes.

ObjectType

ObjectType

Notes: Read only

Distinguishes objects referenced through a Dispatch interface.

ObjectType

Swimlanes Methods

Method

Description

See also

Add(string Title, long Width)

Swimlane

Notes: Adds a new swimlane to the end of the list, and returns a swimlane object representing the newly added entry.

Parameters:

  • Title: String - The title text that appears at the top of the swimlane; this can be the same as an existing swimlane title
  • Width: Long - The width of the swimlane in pixels

Swimlane Class

Delete(object Index)

Void

Notes: Deletes a selected swimlane.

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

Parameter:

  • Index: Object - Either a string representing the title text or an integer representing the zero-based index of the swimlane to delete

DeleteAll()

Void

Notes: Removes all swimlanes.

Insert(long Index, string Title, long Width)

Swimlane

Notes: Inserts a swimlane at a specific position, and returns a swimlane object representing the newly added entry.

Parameters:

  • Index: Long - The zero-based index of the existing Swimlane before which this new entry is inserted
  • Title: String - The title text which appears at the top of the swimlane; this can be the same as an existing swimlane title
  • Width: Long - The width of the swimlane in pixels

Swimlane Class

Items(object Index)

Swimlane collection

Notes: Accesses an individual swimlane.

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

Parameter:

  • Index: Object - Either a string representing the title text or an integer representing the zero-based index of the swimlane to get

Swimlane Class

Learn more