paragraphOffset | |||||||||||||
Type | function | ||||||||||||
Dictionary | LCS | ||||||||||||
Library | LiveCode Script | ||||||||||||
Syntax |
| ||||||||||||
Summary | Returns the number of paragraphs between the beginning of a value and an occurrence of a specified string. | ||||||||||||
Introduced | 7.0 | ||||||||||||
OS | mac, windows, linux, ios, android | ||||||||||||
Platforms | desktop, server, mobile | ||||||||||||
Parameters |
| ||||||||||||
Example |
| ||||||||||||
Values |
| ||||||||||||
Related | Property: wholeMatches Function: wordOffset, tokenOffset, sentenceOffset, byteOffset, truewordOffset, codeunitOffset, codepointOffset, offset | ||||||||||||
Description | Use the paragraphOffset function to find which paragraph a string occurs in. The value returned by the paragraphOffset function is the number of the paragraph where the stringToFind first appears in stringToSearch. If the stringToFind is not in stringToSearch, the paragraphOffset function returns zero. If the stringToFind itself contains more than one paragraph, the paragraphOffset function always returns zero, even if the stringToFind appears in the stringToSearch. If you specify how many paragraphsToSkip, the paragraphOffset function skips the specified number of paragraphs in the stringToSearch. The value returned is relative to this starting point instead of the beginning of the stringToSearch. | ||||||||||||
Tags | text processing |