tokenOffset

Typefunction
DictionaryLCS
LibraryLiveCode Script
Syntax
tokenOffset(<stringToFind>, <stringToSearch> [, <tokensToSkip>])
Summary

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

Introduced7.0
OSmac, windows, linux, ios, android
Platformsdesktop, server, mobile
Parameters
NameTypeDescription
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.

Example
tokenOffset(tToken, tSampleText)
tokenOffset("it's", "Tomorrow it's going to rain") -- returns 2
Values
NameTypeDescription
return

The tokenOffset function returns a non-negative integer.

RelatedProperty: wholeMatches
Function: wordOffset, paragraphOffset, sentenceOffset, byteOffset, truewordOffset, codeunitOffset, codepointOffset, offset
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.

Tagstext processing