Returns the number of items between the beginning of a value and an occurrence of a specified string.
Built-in Function handler[]
Syntax:
itemOffset(<itemToFind>, <stringToSearch> [, <itemsToSkip>])
Examples:
itemOffset("C","A,B,C,D,E") -- returns 3
itemOffset("C","A,B,C,D,E",2) -- returns 1
itemOffset("D,E","A,B,C,D,E") -- returns 4
Use the itemOffset function to find which item a string occurs in.
The value returned by the itemOffset function is the number of the item where itemToFind appears in stringToSearch. If the itemToFind is not in stringToSearch, the itemOffset function returns zero.
If the itemToFind contains more than one item, and the entire itemToFind appears in the stringToSearch, the itemOffset function returns the item number where the itemToFind starts.
If you specify how many itemsToSkip, the itemOffset function skips the specified number of items in the stringToSearch. The value returned is relative to this starting point instead of the beginning of the stringToSearch.
Parameters:
- itemToFind (string): string to search
- stringToSearch (string): all the text
- itemsToSkip: A non-negative integer. If you don't specify how many itemsToSkip, the itemOffset function does not skip any items.
- Returns: The itemOffset function returns a non-negative integer.
See also: offset (function), value (function), wholeMatches (property), itemDelimiter (property)