Tinderbox v9 Icon

String.highlights([aColor])


Operator Type: 

Operator Scope of Action: 

Operator Purpose: 

Operator First Added: 

Operator Last Altered: 

Operator Has Optional Arguments: 

 Property  [other Property type actions]

 Item  [operators of similar scope]

 Data manipulation  [other Data manipulation operators]

 Baseline

 As at baseline

 [More on optional operator arguments]


String.highlights(aColor)

String.highlights

The expression returns a list of strings that have been highlighted in the $Text using Format ▸ Highlight.

$MyList = $Text.highlights;

String.highlights(aColor)

The result may be limited to strings highlighted in a specific colour by supplying aColor as an argument. aColor may be any of the currently supported highlight colours: "red", "green", "blue", "yellow", or "magenta". Thus:

$MyList = $Texthighlights("red");

would return only those highlighted $Text portions using a red highlight colour.