hiScrollWindowToName

hiScrollWindowToName(
w_hypertextWindow
t_linkName
)
=> t / nil

Description

Scrolls a hypertext window to a link and displays the text associated with the link. A hypertext window is a text window that can display text with hyperlinks in it.

Arguments

w_hypertextWindow

The hypertext window that you want to scroll.

You can create a hypertext window with hiCreateWindow or hiOpenWindow by specifying "hypertext" for the t_widgetType argument.

t_linkName

The link to which you want to scroll, specified as a string. For example: "myLink".

The link name is defined in the text file that you view in the hypertext window. It is defined with the NAME attribute of the HTML anchor tag. For example:

"<A name=myLink href=http://www.cadence.com> Cadence Design Systems</A>"

For more information on how to specify hyperlinks in a text file, see Viewfile Management.

Values Returned

`t`	The window is scrolled to the link.
`nil`	w_hypertextWindow or t_linkName is invalid.

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