hiGetTextSelection
hiGetTextSelection(
w_windowId
[ x_class ]
)
=> l_text / nil
Description
Retrieves the currently selected text strings from within a specified class.
Arguments
|
w_windowId
|
Text window you want the function to act on.
|
|
x_class
|
The group class that the selections should belong to. Possible values range from 0 to MAX_INT. The default is 0.
The class 0 corresponds to the Edit – Find command and returns the coordinates of the text found using this command. If you select the Scan the whole file check box in the Search dialog box, it returns a list of multiple coordinates based on the text highlighted using the search operation.
|
Value Returned
|
l_text
|
A list of all the selected text strings of the class specified.
|
|
nil
|
w_windowId is invalid or no text is currently selected for the specified class.
|
Related Topics
Functions of Viewfile Window
hiGetCurrentTextSelection
hiGetCurrentTextSelectionLoc
hiSetCurrentTextSelectionLoc
Return to top
