String.paragraph(paraNum)

Operator Type:

Operator Scope of Action:

Operator Purpose:

Operator First Added:

Operator Last Altered:

Function [other Function type actions]

Item [operators of similar scope]

Data manipulation [other Data manipulation operators]

Baseline

As at baseline

String.paragraph(paraNum)

returns the text of the paraNum paragraph in the source string. paraNum is zero-based, i.e. the first paragraph is .paragraph(0); empty paragraphs are ignored. If the string does not contain paraNum paragraphs, the result is an empty string.

If paraNum is negative, Tinderbox counts from the last paragraph. Thus, $Text.paragraph(-1) is the last paragraph in the text.

For example:

$MyString = $Text.paragraph(2);

sets $MyString the the contents of the third paragraph of $Text—recall at N is zero-based, so counting 0/1/2 means 2 is #3 in the sequence.