Programming with Reflection

image\rwnprg32.gif ShowHotlist method

 

Syntax object.ShowHotlist Name, Row, Column, Reserved, Length

 

Description

Displays a hotlist in the terminal window.

Some things to think about before using this method:

· ShowHotlist doesn't return until after the user selects one of the items in the hotlist—or until the user clicks the mouse somewhere else on the terminal screen or presses the Escape key.

· The actions specified for the item the user selects in the hotlist are not executed until after the macro containing ShowHotlist is finished.

For these reasons, it is usually better to use a different strategy for offering choices to the user—such as a dialog box—instead of a hotlist. The recorder does not record the display of a hotlist—instead, it records the actions associated with the user's selection from a hotlist.

The only situation where you should use ShowHotlist is when you're defining a toolbar button or hotspot. In this case, ShowHotlist is used as an argument to another method—such as DefineButton or DefineHotspot and the hotlist is not actually invoked while the macro is still running so that the cited limitations do not apply.

Arguments

Name Argument type: String
The hotlist to display.

Row Argument type: Integer
The row coordinate of the position where the hotlist is displayed. The default position is the upper-left corner of the terminal window. For hotlists that are displayed by clicking on a hotspot or with a mouse button, you can use one of the following enumeration values:

 rcHotspotRow

 Specifies that the hotlist is to be displayed in the row below that in which the most recently selected hotspot was displayed—use this value if the hotlist is to be displayed in response to selecting a hotspot.

 rcMouseRow

 Specifies that the hotlist is to be displayed at the row location where the mouse was last clicked in the terminal window.

Column Argument type: Integer
The column coordinate of the position where the hotlist is displayed. The default position is the upper-left corner of the terminal window. For hotlists that are displayed by clicking a hotspot or with a mouse button, you can use one of the following enumeration values:

 rcHotspotCol

 Specifies that the hotlist is to be displayed in the same column in which the most recently selected hotspot was displayed—use this value if the hotlist is to be displayed in response to selecting a hotspot.

 rcMouseCol

 Specifies that the hotlist is to be displayed at the column location where the mouse was last clicked in the terminal window.

Reserved Argument type: Integer
This argument is ignored but must be present. Always use 0 as the value of this argument.

Length Argument type: Integer
The number of rows used to display the hotlist. If there are more items in the hotlist than can be displayed in the specified number of rows, the contents of the hotlist carry over to additional columns. Use rcFullSize to automatically adjust the length of the hotlist to equal the number of items present.

 

image\jump.gif Example

image\jump.gif Keyword Index

image\popup.gif Related Topics

image\popup.gif Reflection products that use this command