Configuring Siebel Open UI > Siebel Open UI Application Programming Interface > Methods of the Siebel Open UI Application Programming Interface >

Presentation Model Class for Menus

This topic describes the methods that Siebel Open UI uses with the presentation models that it uses to display menus. It includes the following information:

• Properties of the Presentation Model for Menus
• GetMenuPS Method
• OnMenuInvoke Method
• ProcessMenuCommand Method
• ShowMenu Method

Properties of the Presentation Model for Menus

Table 30 describes the properties of the presentation model that Siebel Open UI uses for menus.

GetMenuPS Method

The GetMenuPS method returns a property set that includes information about a menu and the menu items that this menu contains. It uses the following syntax:

GetMenuPS()

It includes no arguments.

For example:

var menuPS = this.ExecuteMethod("GetMenuPS");

The following example includes a typical property set that the GetMenuPS method returns:

childArray
  [0]
    - childArray
    - propArray
      - Caption : "Undo Record [Ctrl+U]"
      - Command : "*Browser Applet* *UndoRecord*SIS Account List Applet* "
      - Enabled : [True|False]
      - Type : "Command\|Separator"

OnMenuInvoke Method

The OnMenuInvoke method creates a menu. It returns nothing. It uses the following syntax:

OnMenuInvoke(consts.get("APPLET_NAME")

The applicationcontext.js file includes the following code:

activeAplt.GetMenu().OnMenuInvoke(consts.get("APPLET_NAME")

You can use the following code:

this.ExecuteMethod("OnMenuInvoke", consts.get("APPLET_NAME"), consts.get("SWE_PREPARE_APPLET_MENU"), consts.get("SWE_MENU_APPLET"), true);

ProcessMenuCommand Method

The ProcessMenuCommand method runs when the user chooses a menu item. It returns nothing. It uses the following syntax:

this.ExecuteMethod("ProcessMenuCommand", menuItemCommand);

It includes no arguments.

ShowMenu Method

The ShowMenu method displays a menu. It exists only for binding purposes. It makes sure Siebel Open UI finishes all processing related to the menu property set. It returns nothing. It uses the following syntax:

this.AttachPMBinding("ShowMenu", ShowMenuUI, this};
  function ShowMenuUI(){
    // Include here code that displays the menu control.
  }

It includes no arguments.

Siebel Open UI finishes running the ShowMenu method in the proxy, and then immediately runs the ShowMenuUI method.

You must not configure Siebel Open UI to call the ShowMenu method from an external application.