Simple String List Object
Overview
Holds a list of string values.
Sections
Init, Main, Procedures, OnExit, and Structure.
Properties
| Name | Description |
|---|---|
| All | Returns all the strings in the list as one string. |
| Count | Returns the number of strings. |
| Delimiter | Delimiter used in property All. |
| Item[] | Gets item at index. |
| ObjectIsEmpty | Returns 1 if object is not created. |
| LastReturnCode Returns last known return code from object. |
note
Properties ObjectIsEmpty and LastReturnCode are common methods. For more information see Common properties and methods.
Methods
| Name | Description |
|---|---|
| Insert | Inserts a string at index. |
| Add | Adds an string to the end of list. |
| Delete | Deletes the item at index. |
| IndexOf | Returns the index of first item that equals search value. |
| Clear | Clears all items in list. |
| Sort | Sorts items in list on name. |
| LoadFromString | Adds items to list from a separated string. |
| CreateObject | Creates a new instance of the object. |
| FreeObject | Releases the instance of the object. |
note
Methods CreateObject and FreeObject are common methods. For more information see Common properties and methods.
See Also
Properties
All
Fetches all the strings in a list as one string. The Delimiter property
is used as separator between strings.The default delimiter string is ;.
Type: String
Default: ''
Read: get_All
Write: -
See Also
Simple String List Object::Delimiter
Count
Returns the number of items in list.
Type: Integer
Default: -
Read: get_Count
Write: -
See Also
Delimiter
The delimiter (separator) used in property All. The delimiter may consist of more than one character.
Type: String
Default: ;
Read: get_Delimiter
Write: put_Delimiter
See Also
Item[]
Fetches and sets an item at a specified index.
Valid values for index are 1..n.
Type: String
Default: -
Read: get_Item
Write: put_Item
See Also
Methods
Add
Adds a string to the end of the list.
Parameters
| Item | Type: String Description: Value to add. |
See Also
Simple String List Object::Insert
Simple String List Object::LoadFromString
Insert
Inserts a string at index.
Valid values for index are 1..n.
Parameters
| Index | Type: Integer Description: Index where to insert the item. Index is 1..n. |
| Value | Type: String Description: Value to insert. |
See Also
Simple String List Object::Add
Simple String List Object::LoadFromString
Delete
Deletes an item at index.
Parameters
| Index | Type: Integer Description: Index where to delete an item. Index is 1..n. |
IndexOf
Fetches the index of the first item that equals the specified search value.
Parameters
| Start at | Type: Integer Default: 1 Description: Index where to start the search. Index is 1..n. |
| SearchValue | Type: String Description: String value to search for. |
| Return value | Type: Integer Description: Index of searched string value. Returns -1 if no value is found. |
Clear
Clears all items in list.
Parameters
-
Sort
Sorts items in list on name in descending order.
Parameters
-
LoadFromString
Adds items to list from a separated string. Values are appended to the list. The separator may consist of more than one character.
Parameters
| Values | Type: String Description: String of separated values. |
| ItemSeparator | Type: String Default: ;Description: Character separating string values. |
See Also
Simple String List Object::Add
Simple String List Object::Insert