Tinderbox 7 Icon

String.paragraphs(N)


Operator Type: 

Operator Scope of Action: 

Operator Purpose: 

Operator First Added: 

Operator Altered: 

 Function   [other Function type actions]

 Item   [operators of similar scope]

 Data manipulation   [other Data manipulation operators]

 Baseline

 7.5.3


String.paragraphs(N)

This function extracts the first N paragraphs of the referenced string or String-type attribute. Examples:

$MyString = "Paragraph 1\nParagraph 2".paragraphs(1) 

In the example the "\n" simulates a line break. The code would set $MyString to the string "Paragraph 1".

$Text = $Text(Some note).paragraphs(2) 

In the second example the current note's $Text would be set to the first 2 paragraphs of note "Some note".

To get a single given paragraph of a multi line/paragraph string, such as $Text, see String.split().

From v7.5.3, this functions respects existing rich text styling.