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

hiTextDisplayString

hiTextDisplayString(
w_windowId 
t_text
g_erase
[ g_dontScrollTop ]
) 
=> t / nil 

Description

Displays a text string in a window.

The current cursor index and the corresponding cursor position are modified by this function.

Arguments

w_windowId

Specifies the window ID.

t_text

Text string to display.

g_erase

Determines how the string should be displayed. If g_erase is t, the content of the window is erased and the text string is displayed beginning at the first character position in the window. If g_erase is nil, the text string is displayed following the last character position of the current text.

g_dontScrollTop

Determines whether the window should be scrolled. If g_dontScrollTop is not specified or is nil, the window is scrolled back to display the first character position of the window, and the current cursor index position is set to zero. If g_dontScrollTop is t, the window is scrolled to display the last character position of the window, and the current cursor index position is set to the last character position of the window.

Values Returned

t

The string is displayed.

nil

w_windowId is invalid or t_text is null.

Related Topics

Functions of Viewfile Window

Text Customization Functions


Return to top
 ⠀
X