PropertyHandle :: LocatePosition - Set current position in property handle
The function sets the current position (offset) of the property handle to the value passed in set_pos0. When the property handle is selected, changes on the selected instance are saved before changing the position. When the position passed is less than 0, the property handle is positioned on top.
In case of activated filter condition, the function does not check the filter condition. When the position passed is greater or equal to the absolute collection count, the function returns an error.
Implementation details
- set_pos0
- Position in collection
The position of an instance in a collection depends on the selected index. if the collection is unsorted the position is the only way for accessing the instance.
For sorted collections the position is determined according to the instance key. If is a contradiction between position and key value the position will be ignored.
Special positions are
CUR_INSTANCE (-1) refers to the currently selected instance. If no instance is selected it refers to the first instance.
FIRST_INSTANCE (0) refers to the first instance in a collection according to the selected index (sort order).
FIRST_INSTANCE (0x7fffffff) refers to the last instance in a collection according to the selected index (sort order).