The Text Object functions allow you to use a script to manipulate Text objects on a page in your publication. For example, you can use the OpusScript functions listed below to create a hypertext link on a piece of text in a Text object or to play an Autonarration for a Text object.
Hierarchy:
As well as the specific functions listed under the Functions: heading below, you can also use the following OpusScript functions:
Class Hierarchy:
Text Objects
Graphical Objects
Basic Objects
Functions:
Get the character at a given position | |
Create a hypertext link and action for a selection | |
Find a string of text in a specified Text object | |
Find a string of text only in the selected part of a Text object | |
Get the first hypertext link in a specified text object | |
Get the number of lines | |
Get the next hypertext link in a specified text object | |
Get the total number of links in a specified text object | |
Get the number of paragraphs in a Text object | |
Gets the position of the selected characters | |
Get the paragraph style of selected text | |
Get the formatting style of selected text | |
Gets the selected text as a string | |
Get a string containing the text in the hyperlink | |
Get the number of characters | |
Get the number of words | |
Check if an autonarrate is currently playing | |
Get the line index of a character position | |
Get the character index of the first character in a line | |
Get the number of characters in a line | |
Return the index number of a paragraph in a Text object | |
Return the number of characters in a paragraph | |
Begin the autonarration on this text | |
Get the position of a character | |
Remove all hypertext links for this text | |
Replaces the current selection with a specified string | |
Scroll the text by line, paragraph or page | |
Set the colour of the text | |
Set the highlighted area in a Listbox object to a new line | |
Selects a range of characters in the text object | |
Set the paragraph style of selected text | |
Set the formatting style of selected text | |
End the autonarration on this text |