hiGetCurrentTextSelection

hiGetCurrentTextSelection(
w_windowId
)
=>t_selectedText / nil

Description

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

Argument

w_windowId

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

Values Returned

t_selectedText	Returns a string if text is selected in the specified viewfile window.
nil	Returns nil if no text appears to be selected in the specified viewfile window.

Examples

hiGetCurrentTextSelection( window(3) )

=> "some text" ;; The string "some text" has been selected in window(3)

hiGetCurrentTextSelection( window(3) )

=> nil  ;; No text is selected

Related Topics

Functions of Viewfile Window

Return to top