peoplecodeapi - GenHTMLMenu

Syntax

GenHTMLMenu(list[, fldr_img_class_ID] [, element_label])

Description

Note: SmartNavigation has been deprecated. This function remains for backward compatibility only.

Use this function to generate an HTML code fragment that will be rendered in the browser as menu drop-downs, fly-outs, and breadcrumbs. Typically, this function is used when the SmartNavigation data source is a tree. The <li> elements in the input string are created by the GenRelatedActions function, the GenABNMenuElement method of the Node class, and the GenABNMenuElement method of the Leaf class.

Parameters

Field or Control	Definition
`list`	Specifies the list of <li> elements as a string.
`fldr_img_class_ID`	Specifies the class ID for a custom folder icon as a string. This class must be defined in a style sheet, and the style sheet must be assigned to the SmartNavigation folder. This is an optional parameter. To use the default folder icon, you can omit this parameter or specify the null string "". However, to ensure forward compatibility or to use the default folder icon while specifying the `element_label` parameter, you must specify the null string.
`element_label`	Specifies a label for a drop-down menu item as an array with two numeric elements, which represents a message catalog entry. The first element is the message set number and the second element is the message number. This label is applied to a drop-down menu item that is generated for the SmartNavigation breadcrumb on which the user has clicked, allowing the user to view the chart associated with that breadcrumb. The complete label is the word âViewâ with the `element_label` message appended. This is an optional parameter. If the `element_label` is not provided or if the message set or number is undefined, then a default message catalog entry (95, 9109) is used, which includes the default message, âUser Profile Page,â in the label for the drop-down menu item.

Field or Control

Definition

list

Specifies the list of <li> elements as a string.

fldr_img_class_ID

Specifies the class ID for a custom folder icon as a string. This class must be defined in a style sheet, and the style sheet must be assigned to the SmartNavigation folder.

This is an optional parameter. To use the default folder icon, you can omit this parameter or specify the null string "". However, to ensure forward compatibility or to use the default folder icon while specifying the element_label parameter, you must specify the null string.

element_label

Specifies a label for a drop-down menu item as an array with two numeric elements, which represents a message catalog entry. The first element is the message set number and the second element is the message number.

This label is applied to a drop-down menu item that is generated for the SmartNavigation breadcrumb on which the user has clicked, allowing the user to view the chart associated with that breadcrumb. The complete label is the word âViewâ with the element_label message appended.

This is an optional parameter.

If the element_label is not provided or if the message set or number is undefined, then a default message catalog entry (95, 9109) is used, which includes the default message, âUser Profile Page,â in the label for the drop-down menu item.

Returns

None.