MainMenu - SuperOffice

Used to control the main (left-side) menu of SuperOffice CRM. Customizing the main menu means modifying the corresponding trigger.

Constructors

MainMenu()

MainMenu

Initializes a new instance of the MainMenu class.

Methods

addGroup(String,String)

Adds a group to the main menu (navigator) with the given label and image. By default, it appends the item to the bottom of the main menu. Use one of the other addGroup variants to specify the exact position or on-click JavaScript code.

Void addGroup(String label, String image)

Returns: CRMScript.Global.Void

The image is specified by the URL to the actual file.

Example:

MainMenu menu = getMainMenu();
menu.addGroup("My label", "http://..../graphics/picture.png");

addGroup(String,String,Integer)

Void addGroup(String label, String image, Integer position)

Returns: CRMScript.Global.Void

The image is specified by the URL to the actual file.

Example:

MainMenu menu = getMainMenu();
menu.addGroup("My label2", "http://..../graphics/picture.png", 3);

addGroup(String,String,Integer,String)

Adds a group to the main menu (navigator) with the given label and image in a specific position. This will shift the index of all subsequent groups. Thus, you should not make assumptions about which slot a group is in. In addition, you can specify on-click JavaScript code. Use this to create clickable menu groups.

Void addGroup(String label, String image, Integer position, String onClick)

Returns: CRMScript.Global.Void

The image is specified by the URL to the actual file.

Example:

MainMenu menu = getMainMenu();
menu.addGroup("My label", "http://..../graphics/picture.png");
menu.addGroup("My label2", "http://..../graphics/picture.png", 3, "window.location='http://www.superoffice.com'");

addItem(String,String)

Adds an item to the SuperOffice main menu (navigator).

Void addItem(String label, String url)

Returns: CRMScript.Global.Void Example:

MainMenu menu = getMainMenu();
menu.addItem("List equipment", getProgram(1) + "&action=listExtraTable&extraTable=y_equipment");
menu.addItem("New unit", getProgram(1) + "&action=editExtraTableEntry&extraTable=y_equipment", 1, 1);

addItem(String,String,Integer,Integer)

Adds an item to the SuperOffice main menu (navigator).

Void addItem(String label, String url, Integer group, Integer position)

Returns: CRMScript.Global.Void Example:

MainMenu menu = getMainMenu();
menu.addItem("List equipment", getProgram(1) + "&action=listExtraTable&extraTable=y_equipment");
menu.addItem("New unit", getProgram(1) + "&action=editExtraTableEntry&extraTable=y_equipment", 1, 1);

addItem(String,String,Integer,Integer,String,String,String)

Adds an item to the SuperOffice main menu (navigator).

Void addItem(String label, String url, Integer group, Integer position, String onClick, String itemId, String target)

Returns: CRMScript.Global.Void Example:

MainMenu menu = getMainMenu();
menu.addItem("List equipment", getProgram(1) + "&action=listExtraTable&extraTable=y_equipment");
menu.addItem("New unit", getProgram(1) + "&action=editExtraTableEntry&extraTable=y_equipment", 1, 1);

addItem(String,String,Integer,Integer,String,String,String,String)

Adds an item to the SuperOffice main menu (navigator).

Void addItem(String label, String url, Integer group, Integer position, String onClick, String itemId, String target, String iconUrl)

Returns: CRMScript.Global.Void

The image is specified by the URL to the actual file.

Example:

MainMenu menu = getMainMenu();
menu.addItem("List equipment", getProgram(1) + "&action=listExtraTable&extraTable=y_equipment");
menu.addItem("New unit", getProgram(1) + "&action=editExtraTableEntry&extraTable=y_equipment", 1, 1);

clear()

Clears all the contents of the menu.

Void clear()

Returns: CRMScript.Global.Void

deleteGroup(Integer)

Removes the group at the given index (starts at 0) from the main menu.

Void deleteGroup(Integer index)

Returns: CRMScript.Global.Void

Verify that you’re removing the correct group by checking with getGroupId() what’s in that slot first.

Example:

Integer pos = 3;
MainMenu menu = getMainMenu();
if (menu.getGroupId(pos) == "my label") {
  menu.deleteGroup(pos);
}

deleteItem(Integer,Integer)

Removes the item at the given index from the group.

Void deleteItem(Integer group, Integer index)

Returns: CRMScript.Global.Void

getGroupId(Integer)

Returns the label (ID) of a group in the main menu given its position.

String getGroupId(Integer group)

Returns: CRMScript.Global.String

The IDs are unique strings starting at zero.

Example:

MainMenu menu = getMainMenu();
String label = menu.getGroupId(4);

getGroupIndex()

Returns the position of a specific group in the main menu given its label (ID)

Integer getGroupIndex(String label)

Returns: CRMScript.Global.Integer - The position of a specific group in the main menu. Example:

MainMenu menu = getMainMenu();
Integer pos = menu.getGroupIndex("my MITs");

getItemId(Integer,Integer)

Returns the label (ID) of an item in a group given its position.

String getItemId(Integer group, Integer pos)

Returns: CRMScript.Global.String - The label (ID) of an item. Example:

MainMenu menu = getMainMenu();
String label = menu.getItemId(4,1);

getItemIndex(Integer,String)

Returns the position of a specific item in the group given its label (ID).

Integer getItemIndex(Integer group, String label)

Returns: CRMScript.Global.Integer - The position of a specific item. Example:

MainMenu menu = getMainMenu();
Integer pos = menu.getItemIndex(2,"secret company");

getNumGroups()

Returns the current number of groups in the main menu.

Integer getNumGroups()

Returns: CRMScript.Global.Integer Example:

MainMenu menu = getMainMenu();
Integer nGroups = menu.getNumGroups();

getNumItems(Integer)

Returns the current number of items in the group.

Integer getNumItems(Integer group)

Returns: CRMScript.Global.Integer - The number of items in the group. Example:

MainMenu menu = getMainMenu();
Integer nItems = menu.getNumItems(2);

​Constructors

​MainMenu()

​Methods

​addGroup(String,String)

​addGroup(String,String,Integer)

​addGroup(String,String,Integer,String)

​addItem(String,String)

​addItem(String,String,Integer,Integer)

​addItem(String,String,Integer,Integer,String,String,String)

​addItem(String,String,Integer,Integer,String,String,String,String)

​clear()

​deleteGroup(Integer)

​deleteItem(Integer,Integer)

​getGroupId(Integer)

​getGroupIndex()

​getItemId(Integer,Integer)

​getItemIndex(Integer,String)

​getNumGroups()

​getNumItems(Integer)

Constructors

MainMenu()

Methods

addGroup(String,String)

addGroup(String,String,Integer)

addGroup(String,String,Integer,String)

addItem(String,String)

addItem(String,String,Integer,Integer)

addItem(String,String,Integer,Integer,String,String,String)

addItem(String,String,Integer,Integer,String,String,String,String)

clear()

deleteGroup(Integer)

deleteItem(Integer,Integer)

getGroupId(Integer)

getGroupIndex()

getItemId(Integer,Integer)

getItemIndex(Integer,String)

getNumGroups()

getNumItems(Integer)