Separators, Titles and Layout Hints

The following hints are used with string parameters to provide separators, titles, and extended layout options for menus. Parameters using these widget hints are treated as read only and constant – they do not update live on the screen. Examples of each hint are shown below.

Widget Name

Value

Description

WIDGET_TITLE_LINE

5

displays the value of the String parameter as a label with all other parameter labels and a line across the content area of the menu page.

WIDGET_LINE_ONLY

6

displays a line across the content area of the menu page with no label on the left.

WIDGET_TITLE_ONLY

7

displays the value of the String parameter as a label with empty space in the content area of the menu page.

WIDGET_PAGE_TAB

8

creates a 3rd-level tab within the menu page. The value of the parameter is used as the tab label.

WIDGET_TITLE_HEADER

10

displays a title over the content area of the menu with the value of the parameter used as the header text.

WIDGET_TITLE_LINE (5)

This displays the value of the String parameter as a label aligned with all other parameter labels, and a line across the content area of the menu page. The name of the parameter is ignored.

 

Figure 5 - WIDGET_TITLE_LINE hint.


 

WIDGET_LINE_ONLY (6)

This displays a line across the content area of the menu page with no label on the left. The name and value of the parameter are ignored.

 

Figure 6 - WIDGET_LINE_ONLY hint.

WIDGET_TITLE_ONLY (7)

This displays the value of the String parameter as a label with empty space in the content area of the menu page. The name of the parameter is ignored.

 

Figure 7 - WIDGET_TITLE_ONLY hint

WIDGET_PAGE_TAB (8)

Whenever a new String parameter with a WIDGET_PAGE_TAB hint is found on a menu page, a new 3rd-level tab is created inside of that menu page. The label on that tab will be the value of the String parameter. All parameters listed after each WIDGET_PAGE_TAB String parameters (until the next such parameter) are placed on a menu page inside of that 3rd-level tab.

 

Figure 8 - A menu with WIDGET_PAGE_TAB hints.

Note             Whenever WIDGET_PAGE_TAB hints are used on a menu, the first OID in the menu should be for a String parameter with a widget hint defining the first tab’s label.

WIDGET_TITLE_HEADER (10)

Displays a title over the content area of the menu with the value of the parameter used as the header text. No label is shown on the left and the name of the parameter is ignored.

Figure 9 - WIDGET_TITLE_HEADER hint.