StringList Collection

This object is a collection of strings that exist on a Xpedition Designer schematic. This collection has a well-defined interface that allows for removing/adding/iterating any of the elements that compose the collection.

This collection can be used as either a parameter of as a return object in scripts. It is constrained by specific semantics only in the context of a given method.

For example, GetAvailableSheets Method (SchematicSheetDocuments Collection) uses the StringList collection to return the names of available sheets; in this case the collection is of strings that denote that names of schematic sheets.

The following table lists methods of the StringList collection with links to the respective reference pages.

Table 1. StringList Collection Methods

Method

Description

Append Method (StringList Collection)Adds an element to the end of the collection.
Clear Method (StringList Collection)Removes all elements from the collection.
GetCount Method (StringList Collection)Returns the number of elements in the collection.
GetItem Method (StringList Collection)Returns a string (specified by Index) that is contained in the collection.
Insert Method (StringList Collection)Inserts an element into the collection at the position specified by the index argument.
Remove Method (StringList Collection)Removes an element specified by its index position from the collection.