tokenOffset

Returns the number of tokens between the beginning of a value and an occurrence of a specified string.

# Metadata

Platforms: desktop, server, mobile OS: mac, windows, linux, ios, android Introduced: 7.0 Security:

# Syntax

tokenOffset(stringToFind, stringToSearch [, tokensToSkip])

# Params

- stringToFind : - stringToSearch : - tokensToSkip : The tokensToSkip is a non-negative integer. If you don't specify how many tokensToSkip, the tokenOffset function does not skip any tokens.

# Examples

tokenOffset(tToken, tSampleText)

tokenOffset("it's", "Tomorrow it's going to rain") -- returns 2

# Description

Use the tokenOffset function to find which sentence a string occurs in.

The value returned by the tokenOffset function is the number of the token where the stringToFind first appears in stringToSearch. If the stringToFind is not in stringToSearch, the tokenOffset function returns zero. If the stringToFind itself contains more than one token, the tokenOffset function always returns zero, even if the stringToFind appears in the stringToSearch.

If you specify how many tokensToSkip, the tokenOffset function skips the specified number of sentences in the stringToSearch. The value returned is relative to this starting point instead of the beginning of the stringToSearch.

# Tags

text processing,

# See

- **property:** wholeMatches - **function:** wordOffset, paragraphOffset, sentenceOffset, byteOffset, truewordOffset, codeunitOffset, codepointOffset, offset