Operator Type:
Operator Scope of Action:
Operator Purpose:
Operator First Added:
Operator in Current Baseline:
Operator Last Altered:
Operator Has Optional Arguments:
Property [other Property type actions]
Item [operators of similar scope]
Data manipulation [other Data manipulation operators]
v9.1.0
Baseline
As at baseline
Syntax note: Operators without any defined mandatory arguments may omit their empty closing parentheses
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;
Note: aColor can only be the value of a named colour as listing in the menu Format ▸ Style ▸ Highlight.
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 = $Text.highlights("red");
would return only those highlighted $Text portions using a red highlight colour.