API Component.Property.AddListItem

	AddListItem
Alters or appends a list entries text for the property by named index
- HANDLE	Handle
The component handle to alter the property of
- STRING	Property
The textual name of the property
- STRING	Index
The text or integer entry of the property
- STRING	Value
The value to update the entry with
- BOOL	Return

Detailed description

Sets the text part of a list property identified by its 3-digit Index'. If the line does not exist then a new line is appended to the list.

Note the Index is not the line of the list to extract, but the 3-digit identifier. If multiple lines have the same identifier this will extract the first found.

To find the index from the line, use GetListIndex.

To add the line to the list only if it exists, use SetListItem.

Examples

Calling in a calculation

• Declare a variable 'result' of type BOOL
• Add to a calculation icon:

  result = ::Component.Property.AddListItem(handle, "property", "index", "value")

No additional examples