This version is out of date, covering development from v9.0.0 to v9.3.0. It is maintained here only for inbound reference links from elsewhere. It is no longer actively updated.

Jump to the current version of aTbRef

Tinderbox v9 Icon

String.highlights[("colourName")]


Operator Type: 

Operator Scope of Action: 

Operator Purpose: 

Operator First Added: 

Operator Altered: 

 Property   [other Property type actions]

 Item   [operators of similar scope]

 Data manipulation   [other Data manipulation operators]

 9.1.0

 


String.highlights

but in effect this is only used as $Text.highlights. The expression returns a list of strings that have been highlighted in the $Text using Format ▸ Highlight.

$MyList = $Text.highlights;

String.highlights("colourName")

The result may be limited to strings highlighted in a specific colour by supplying colourName as a parameter. colourName 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.



A Tinderbox Reference File : Actions & Rules : Operators : Full Operator List : String.highlights[("colourName")]