Product Documentation
Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023

hiGetTextSelByLoc

hiGetTextSelByLoc(
w_windowId
[ x_class ]
) 
=> l_locationPair / nil

Description

Returns a list of starting and ending location pairs of all selected text strings in the specified class.

Arguments

w_windowId

Text window you want the function to act on.

x_class

Group of selections. 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_locationPair

A list of the beginning and ending locations of all selected text strings of the class specified.

nil

w_windowId is invalid or no text is currently selected.

Related Topics

Functions of Viewfile Window

hiGetCurrentTextSelection

hiGetCurrentTextSelectionLoc

hiSetCurrentTextSelectionLoc


Return to top
 ⠀
X