hiGetCurrentTextSelectionLoc

hiGetCurrentTextSelectionLoc(
w_windowId
)
=> l_listofCoords / nil

Description

Returns the text coordinates of the text selected in the specified viewfile window. This is the text which has been selected using a mouse action, such as by double-clicking or drag-selecting. If no text is selected in the specified window, the function returns nil.

Argument

w_windowId

Specifies the ID of the viewfile window for which the location of the current text selection should be returned

Values Returned

l_listofCoords	Returns a list of two numbers, comprising of the first and last selected character indexes
nil	Returns nil if no text appears to be selected in the specified viewfile window

Examples

hiGetCurrentTextSelectionLoc( window(3) )

=> (1597 1602) ;; Text between 1597 and 1602 is selected in window(3)

hiGetCurrentTextSelection( window(3) )

=> nil  ;; No text is selected

Related Topics

Functions of Viewfile Window

Return to top