API Component.Property.SetListItem

From Flowcode Help
Jump to: navigation, search

Sets an existing list entries text for the property by named index

Class hierarchy

Component

Property
SetListItem

Contents


Parameters

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


Return value

BOOL

Returns true if the operation is a success, else false


Detailed description

Sets the text part of a list property identified by its 3-digit Index. If the line does not exist this call fails.


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 regardless of whether it exists, use AddListItem.

Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon:
    result = ::Component.Property.SetListItem(handle, "property", "index", "value")

No additional examples

Personal tools