Child pages
  • Menu
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Unknown macro: {sub-section}


Unknown macro: {table}

{column:width=80px}{column}{column}{column}

Unknown macro: {tr}
Unknown macro: {th}

Property Summary

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

text


Unknown macro: {table}

{column:width=80px}{column}{column}{column}

Unknown macro: {tr}
Unknown macro: {th}

Method Summary

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

CheckBox

Unknown macro: {td}

addCheckBox(index)
Add the Checkbox at the selected index (starting at 0) or add it at the end (empty).

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

MenuItem

Unknown macro: {td}

addItem(index)
Add the item at the selected index (starting at 0) or add it at the end (empty).

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

RadioButton

Unknown macro: {td}

addRadioButton(index)
Add the Radiobutton at the selected index (starting at 0) or add it at the end (empty).

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

addRadioGroup()
Add a Radiogroup for the Radiobuttons.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

addSeparator(index)
Add the separator at the selected index (starting at 0) or add it at the end (empty).

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Menu

Unknown macro: {td}

addSubMenu(index)
Add the submenu at the selected index (starting at 0) or add it at the end (empty).

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

doClick(click)
Script the selection (emulate a mouse click) of the menu.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

CheckBox

Unknown macro: {td}

getCheckBox(index)
Get the Checkbox at the selected index (starting at 0).

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

MenuItem

Unknown macro: {td}

getItem(index)
Get the item at the selected index (starting at 0).

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

getItemCount()
Get the number of items in the menu.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

getItemIndexByText(name)
Retrieve the index of the item by text.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

RadioButton

Unknown macro: {td}

getRadioButton(index)
Get the Radiobutton at the selected index (starting at 0).

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Menu

Unknown macro: {td}

getSubMenu(index)
Get the submenu at the selected index (starting at 0).

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

removeAllItems()
Remove all items from the menu.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

removeItem(index 1, index 2-n)
Remove the item(s) at the selected index/indices.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

set(text, mnemonic, enabled)
Set the menu with a text and optional mnemonic key.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

setEnabled(enabled)
Set the the selected menu enabled or disabled.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

setIcon(icon)
Set the icon of the menu.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

setMnemonic(mnemonic)
Set the mnemonic of the selected menu.


Unknown macro: {table}

{column:width=100%}{column}

Unknown macro: {tr}
Unknown macro: {th}

Property Details

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
text
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {sub-section}
Unknown macro: {sub-section}

Replace with description

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {sub-section}
Unknown macro: {sub-section}

String

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}


Unknown macro: {table}

{column:width=100%}{column}

Unknown macro: {tr}
Unknown macro: {th}

Method Details

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
addCheckBox
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

CheckBox

Unknown macro: {span}

addCheckBox

Unknown macro: {span}

(index)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {sub-section}
Unknown macro: {sub-section}

Add the Checkbox at the selected index (starting at 0) or add it at the end (empty)...

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}

[index]

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {sub-section}
Unknown macro: {sub-section}

CheckBox

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {sub-section}
Unknown macro: {sub-section}
// Add the Checkbox at the selected index (starting at 0) or add it at the end (empty)...
// get the menu at the last index
// indexes start at 0 (zero) so index 2 is in fact position 3
var menu = plugins.menubar.getMenu(plugins.menubar.getMenuCount() - 1);

// when you don't define an index the checkbox will be added at the last position
// this is what you usually do to build a new menu
var checkbox = menu.addCheckBox();

// create the settings for the specified menu item
// minimum settings are the text and method properties
// the method can be a global or form method
// be sure to enter the method WITHOUT '()' at the end
checkbox.set("checkbox with feedback",feedback_checkbox);

var checkbox = menu.addCheckBox();
// set the checkbox to selected
checkbox.set("checkbox selected",feedback_checkbox, true);

var checkbox = menu.addCheckBox();

// add an 'input' array. the array will be concatenated to the end of the arguments
// array which can be read out in the selected method
var input = [1,"is","the","added","input",false];

checkbox.set("checkbox with input",feedback_checkbox,false,input);

var checkbox = menu.addCheckBox();
// add an icon to the item
checkbox.set("checkbox with icon",feedback_checkbox,false,input,"media:///yourimage.gif");

var checkbox = menu.addCheckBox();
// add an accelerator key ('alt shift a' in the below example)
// REMARK: always test the accelerator key. sometimes they will not work because
// these keys already have an 'action' assigned to them via the operating system.
checkbox.set("checkbox with accelerator",feedback_checkbox,false,input,"media:///yourimage.gif","alt shift a");

var checkbox = menu.addCheckBox();
// add a mnemonic key  ('i' in our example) which is the underlined shortkey on windows
// REMARK: setting the mnemonic key is platform dependent
checkbox.set("checkbox with mnemonic",feedback_checkbox,false,input,"media:///yourimage.gif","a","i");

var checkbox = menu.addCheckBox();
// disable the menu item
checkbox.set("checkbox disabled",feedback_checkbox,false,input,"media:///yourimage.gif","control 3","t",false);

var checkbox = menu.addCheckBox();
// set the menu item to be visible
checkbox.set("checkbox visible",feedback_checkbox,false,input,"media:///yourimage.gif","meta 4","e",true,true);

var checkbox = menu.addCheckBox();
// set the menu item disabled and NOT visible
checkbox.set("checkbox invisible",feedback_checkbox,false,input,"media:///yourimage.gif","alt 5","m",false,false);

// add a separator at the last position or at a given index
menu.addSeparator();

// WIZARD
// You can use the menubar wizard Tools/Plugins/IT2Be help/Menubar Wizzzard to create you menu
// The wizard will help you at least to learn how to use the plugin and will help you to find the correct
// accelerator key string
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
addItem
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

MenuItem

Unknown macro: {span}

addItem

Unknown macro: {span}

(index)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {sub-section}
Unknown macro: {sub-section}

Add the item at the selected index (starting at 0) or add it at the end (empty)...

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}

[index]

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {sub-section}
Unknown macro: {sub-section}

MenuItem

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {sub-section}
Unknown macro: {sub-section}
// Add the item at the selected index (starting at 0) or add it at the end (empty)...
// get the menu at the last index
// indexes start at 0 (zero) so index 2 is in fact position 3
var menu = plugins.menubar.getMenu(plugins.menubar.getMenuCount() - 1);

// when you don't define an index the item will be added at the last position
// this is what you usually do to build a new menu
var item = menu.addItem();

// create the settings for the specified menu item
// minimum settings are the text and method properties
// the method can be a global or form method
// be sure to enter the method WITHOUT '()' at the end
item.set("item with feedback",globals.feedback_item);

var item = menu.addItem();

// add an 'input' array. the array will be concatenated to the end of the arguments
// array which can be read out in the selected method
var input = [1,"is","the","added","input",false];

item.set("item with input",globals.feedback_item,input);

var item = menu.addItem();
// add an icon to the item
item.set("item with icon",globals.feedback_item,input,"media:///yourimage.gif");

var item = menu.addItem();
// add an accelerator key ('alt shift 2' in the below example)
// REMARK: always test the accelerator key. sometimes they will not work because
// these keys already have an 'action' assigned to them via the operating system.
item.set("item with accelerator",globals.feedback_item,input,"media:///yourimage.gif","alt shift 2");

var item = menu.addItem();
// add a mnemonic key  ('i' in our example) which is the underlined shortkey on windows
// REMARK: setting the mnemonic key is platform dependent
// the accelerator key will not work in this and the next example
item.set("item with mnemonic",globals.feedback_item,input,"media:///yourimage.gif","pressed COMMA","i");

var item = menu.addItem();
// disable the menu item
item.set("item disabled",globals.feedback_item,input,"media:///yourimage.gif","meta HOME","t",false);

var item = menu.addItem();
// set the menu item to be visible
// this accelerator key will work
item.set("item visible",globals.feedback_item,input,"media:///yourimage.gif","shift meta PAGE_DOWN","e",true,true);

var item = menu.addItem();
// now the item is enabled and NOT visible
item.set("item invisible",globals.feedback_item,input,"media:///yourimage.gif","A","m",true,false);

// add a separator at the last position or at a given index
menu.addSeparator();
return;
// when you don't define an index the checkbox will be added at the last position
// this is what you usually do to build a new menu
var checkbox = menu.addCheckBox();

// create the settings for the specified menu item
// minimum settings are the text and method properties
// the method can be a global or form method
// be sure to enter the method WITHOUT '()' at the end
checkbox.set("item 09",feedback_checkbox);
// ,false,input,"media:///yourimage.gif");

var checkbox = menu.addCheckBox();
checkbox.set("item 10",feedback_checkbox,true,null,"media:///yourimage.gif");

// add a separator at the last position or at a given index
menu.addSeparator();

// add a new Radiobutton Group
// the Radiobutton Group 'binds' the added radiobuttons to each other
menu.addRadioGroup();

var radiobutton = menu.addRadioButton();
radiobutton.set("item 12",feedback_radiobutton,false,input,"media:///yourimage.gif");

var radiobutton = menu.addRadioButton();
radiobutton.set("item 13",feedback_radiobutton,true,null,"media:///yourimage.gif");

// add a new Radiobutton Group
menu.addRadioGroup();

var radiobutton = menu.addRadioButton();
radiobutton.set("item 14",feedback_radiobutton,false,null,null,"F6","i");

var radiobutton = menu.addRadioButton();
radiobutton.set("item 15",feedback_radiobutton,false,null,null,"meta F7","t");

// add a separator at the last position or at a given index
menu.addSeparator();

// and add some submenu's
var submenu1 = menu.addSubMenu();
submenu1.set("submenu 17");
submenu1.addItem().set("sub item 17-00",globals.sampleMenuExec);

var submenu2 = submenu1.addSubMenu();
submenu2.set("submenu 01");
submenu2.addItem().set("sub item 01-00",globals.sampleMenuExec);

var submenu3 = submenu1.addSubMenu();
submenu3.set("submenu 02");

// add a separator at the last position or at a given index
menu.addSeparator();

// WIZARD
// You can use the menubar wizard Tools/Plugins/IT2Be help/Menubar Wizzzard to create you menu
// The wizard will help you at least to learn how to use the plugin and will help you to find the correct
// accelerator key string
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
addRadioButton
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

RadioButton

Unknown macro: {span}

addRadioButton

Unknown macro: {span}

(index)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {sub-section}
Unknown macro: {sub-section}

Add the Radiobutton at the selected index (starting at 0) or add it at the end (empty)...

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}

[index]

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {sub-section}
Unknown macro: {sub-section}

RadioButton

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {sub-section}
Unknown macro: {sub-section}
// Add the Radiobutton at the selected index (starting at 0) or add it at the end (empty)...
// get the menu at the last index
// indexes start at 0 (zero) so index 2 is in fact position 3
var menu = plugins.menubar.getMenu(plugins.menubar.getMenuCount() - 1);

// add a new Radiobutton group
// a group will 'bind' all added radiobuttons after the group together
// as a result checking one item will uncheck the other
menu.addRadioGroup();

// when you don't define an index the radiobutton will be added at the last position
// this is what you usually do to build a new menu
var radiobutton = menu.addRadioButton();

// create the settings for the specified menu item
// minimum settings are the text and method properties
// the method can be a global or form method
// be sure to enter the method WITHOUT '()' at the end
radiobutton.set("radiobutton with feedback",feedback_radiobutton);

var radiobutton = menu.addRadioButton();
// set the radiobutton to selected
radiobutton.set("radiobutton selected",feedback_radiobutton, true);

var radiobutton = menu.addRadioButton();

// add an 'input' array. the array will be concatenated to the end of the arguments
// array which can be read out in the selected method
var input = [1,"is","the","added","input",false];

radiobutton.set("radiobutton with input",feedback_radiobutton,false,input);

var radiobutton = menu.addRadioButton();
// add an icon to the item
radiobutton.set("radiobutton with icon",feedback_radiobutton,false,input,"media:///yourimage.gif");

var radiobutton = menu.addRadioButton();
// add an accelerator key ('alt shift 3' in the below example)
// REMARK: always test the accelerator key. sometimes they will not work because
// these keys already have an 'action' assigned to them via the operating system.
radiobutton.set("radiobutton with accelerator",feedback_radiobutton,false,input,"media:///yourimage.gif","alt shift 3");

// add a separator at the last position or at a given index
menu.addSeparator();

// add a new Radiobutton group
menu.addRadioGroup();

var radiobutton = menu.addRadioButton();
// add a mnemonic key  ('i' in our example) which is the underlined shortkey on windows
// REMARK: setting the mnemonic key is platform dependent
radiobutton.set("radiobutton with mnemonic",feedback_radiobutton,false,input,"media:///yourimage.gif","a","i");

var radiobutton = menu.addRadioButton();
// disable the menu item
radiobutton.set("radiobutton disabled",feedback_radiobutton,false,input,"media:///yourimage.gif","control 3","t",false);

var radiobutton = menu.addRadioButton();
// set the menu item to be visible
radiobutton.set("radiobutton visible",feedback_radiobutton,true,input,"media:///yourimage.gif","meta 4","e",true,true);

var radiobutton = menu.addRadioButton();
// now the item is enabled and NOT visible
radiobutton.set("radiobutton invisible",feedback_radiobutton,false,input,"media:///yourimage.gif","alt 5","m",true,false);

// add a separator at the last position or at a given index
menu.addSeparator();

// WIZARD
// You can use the menubar wizard Tools/Plugins/IT2Be help/Menubar Wizzzard to create you menu
// The wizard will help you at least to learn how to use the plugin and will help you to find the correct
// accelerator key string
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
addRadioGroup
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

addRadioGroup

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {sub-section}
Unknown macro: {sub-section}

Add a Radiogroup for the Radiobuttons...

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {sub-section}
Unknown macro: {sub-section}

void

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {sub-section}
Unknown macro: {sub-section}
// Add a Radiogroup for the Radiobuttons...
// get the menu at the last index
// indexes start at 0 (zero) so index 2 is in fact position 3
var menu = plugins.menubar.getMenu(plugins.menubar.getMenuCount() - 1);

// add a new Radiobutton group
// a group will 'bind' all added radiobuttons after the group together
// as a result checking one item will uncheck the other
menu.addRadioGroup();

// when you don't define an index the radiobutton will be added at the last position
// this is what you usually do to build a new menu
var radiobutton = menu.addRadioButton();

// create the settings for the specified menu item
// minimum settings are the text and method properties
// the method can be a global or form method
// be sure to enter the method WITHOUT '()' at the end
radiobutton.set("radiobutton with feedback",feedback_radiobutton);

var radiobutton = menu.addRadioButton();
// set the radiobutton to selected
radiobutton.set("radiobutton selected",feedback_radiobutton, true);

var radiobutton = menu.addRadioButton();

// add an 'input' array. the array will be concatenated to the end of the arguments
// array which can be read out in the selected method
var input = [1,"is","the","added","input",false];

radiobutton.set("radiobutton with input",feedback_radiobutton,false,input);

var radiobutton = menu.addRadioButton();
// add an icon to the item
radiobutton.set("radiobutton with icon",feedback_radiobutton,false,input,"media:///yourimage.gif");

var radiobutton = menu.addRadioButton();
// add an accelerator key ('alt shift 3' in the below example)
// REMARK: always test the accelerator key. sometimes they will not work because
// these keys already have an 'action' assigned to them via the operating system.
radiobutton.set("radiobutton with accelerator",feedback_radiobutton,false,input,"media:///yourimage.gif","alt shift 3");

// add a separator at the last position or at a given index
menu.addSeparator();

// add a new Radiobutton group
menu.addRadioGroup();

var radiobutton = menu.addRadioButton();
// add a mnemonic key  ('i' in our example) which is the underlined shortkey on windows
// REMARK: setting the mnemonic key is platform dependent
radiobutton.set("radiobutton with mnemonic",feedback_radiobutton,false,input,"media:///yourimage.gif","a","i");

var radiobutton = menu.addRadioButton();
// disable the menu item
radiobutton.set("radiobutton disabled",feedback_radiobutton,false,input,"media:///yourimage.gif","control 3","t",false);

var radiobutton = menu.addRadioButton();
// set the menu item to be visible
radiobutton.set("radiobutton visible",feedback_radiobutton,true,input,"media:///yourimage.gif","meta 4","e",true,true);

var radiobutton = menu.addRadioButton();
// now the item is enabled and NOT visible
radiobutton.set("radiobutton invisible",feedback_radiobutton,false,input,"media:///yourimage.gif","alt 5","m",true,false);

// add a separator at the last position or at a given index
menu.addSeparator();

// WIZARD
// You can use the menubar wizard Tools/Plugins/IT2Be help/Menubar Wizzzard to create you menu
// The wizard will help you at least to learn how to use the plugin and will help you to find the correct
// accelerator key string
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
addSeparator
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

addSeparator

Unknown macro: {span}

(index)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {sub-section}
Unknown macro: {sub-section}

Add the separator at the selected index (starting at 0) or add it at the end (empty)...

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}

[index]

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {sub-section}
Unknown macro: {sub-section}

void

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {sub-section}
Unknown macro: {sub-section}
// Add the separator at the selected index (starting at 0) or add it at the end (empty)...
plugins.menubar.getMenu(0).addSeparator();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
addSubMenu
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Menu

Unknown macro: {span}

addSubMenu

Unknown macro: {span}

(index)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {sub-section}
Unknown macro: {sub-section}

Add the submenu at the selected index (starting at 0) or add it at the end (empty)...

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}

[index]

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {sub-section}
Unknown macro: {sub-section}

Menu

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
doClick
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

doClick

Unknown macro: {span}

(click)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {sub-section}
Unknown macro: {sub-section}

Script the selection (emulate a mouse click) of the menu...

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}

click

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {sub-section}
Unknown macro: {sub-section}

void

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {sub-section}
Unknown macro: {sub-section}
// Script the selection (emulate a mouse click) of the menu...
plugins.menubar.getMenu(0).doClick();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getCheckBox
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

CheckBox

Unknown macro: {span}

getCheckBox

Unknown macro: {span}

(index)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {sub-section}
Unknown macro: {sub-section}

Get the Checkbox at the selected index (starting at 0)...

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}

index

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {sub-section}
Unknown macro: {sub-section}

CheckBox

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {sub-section}
Unknown macro: {sub-section}
// Get the Checkbox at the selected index (starting at 0)...
// get the menu at the last position
// indexes start at 0 (zero) so index 2 is in fact position 3
var menu = plugins.menubar.getMenu(plugins.menubar.getMenuCount() - 1);

var checkbox = menu.getCheckBox(0);

checkbox.setText("Changed menu item");

// REMARK: we actually changed an original menu (item)! As a result resetting the
// menubar will NOT reset the above changes. We need to reset the menu (item)
// manually the following way:

// get the menu
// var menu = plugins.menubar.getMenu(2);

// get the item
// var item = menu.getItem(0);

// reset the values to default
// notice we use an i18n message here the same way you would use it with
// standard Servoy methods and plugins
// item.setText("i18n:servoy.menuitem.viewAsRecord");
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getItem
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

MenuItem

Unknown macro: {span}

getItem

Unknown macro: {span}

(index)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {sub-section}
Unknown macro: {sub-section}

Get the item at the selected index (starting at 0)...

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}

index

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {sub-section}
Unknown macro: {sub-section}

MenuItem

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {sub-section}
Unknown macro: {sub-section}
// Get the item at the selected index (starting at 0)...
// get the menu at the last position
// indexes start at 0 (zero) so index 2 is in fact position 3
var menu = plugins.menubar.getMenu(plugins.menubar.getMenuCount() - 1);

var item = menu.getItem(0);

item.setText("Changed menu item");

// REMARK: we actually changed an original menu (item)! As a result resetting the
// menubar will NOT reset the above changes. We need to reset the menu (item)
// manually the following way:

// get the menu
// var menu = plugins.menubar.getMenu(2);

// get the item
// var item = menu.getItem(0);

// reset the values to default
// notice we use an i18n message here the same way you would use it with
// standard Servoy methods and plugins
// item.setText("i18n:servoy.menuitem.viewAsRecord");
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getItemCount
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

getItemCount

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {sub-section}
Unknown macro: {sub-section}

Get the number of items in the menu...

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {sub-section}
Unknown macro: {sub-section}

Number

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {sub-section}
Unknown macro: {sub-section}
// Get the number of items in the menu...
// REMARK: indexes start at 0, disabled items, non visible items and seperators are counted also
// REMARK: this is especially important when getting items by the index
application.output(plugins.menubar.getMenu(0).getItemCount());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getItemIndexByText
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

getItemIndexByText

Unknown macro: {span}

(name)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {sub-section}
Unknown macro: {sub-section}

Retrieve the index of the item by text...

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}

name

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {sub-section}
Unknown macro: {sub-section}

Number

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getRadioButton
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

RadioButton

Unknown macro: {span}

getRadioButton

Unknown macro: {span}

(index)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {sub-section}
Unknown macro: {sub-section}

Get the Radiobutton at the selected index (starting at 0)...

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}

index

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {sub-section}
Unknown macro: {sub-section}

RadioButton

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {sub-section}
Unknown macro: {sub-section}
// Get the Radiobutton at the selected index (starting at 0)...
// get the menu at the last position
// indexes start at 0 (zero) so index 2 is in fact position 3
var menu = plugins.menubar.getMenu(plugins.menubar.getMenuCount() - 1);

var checkbox = menu.getItem(0);

checkbox.setText("Changed menu item");

// REMARK: we actually changed an original menu (item)! As a result resetting the
// menubar will NOT reset the above changes. We need to reset the menu (item)
// manually the following way:

// get the menu
// var menu = plugins.menubar.getMenu(2);

// get the item
// var item = menu.getItem(0);

// reset the values to default
// notice we use an i18n message here the same way you would use it with
// standard Servoy methods and plugins
// item.setText("i18n:servoy.menuitem.viewAsRecord");
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getSubMenu
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Menu

Unknown macro: {span}

getSubMenu

Unknown macro: {span}

(index)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {sub-section}
Unknown macro: {sub-section}

Get the submenu at the selected index (starting at 0)...

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}

index

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {sub-section}
Unknown macro: {sub-section}

Menu

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
removeAllItems
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

removeAllItems

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {sub-section}
Unknown macro: {sub-section}

Remove all items from the menu...

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {sub-section}
Unknown macro: {sub-section}

void

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {sub-section}
Unknown macro: {sub-section}
// Remove all items from the menu...
// get the menu at the last index
// indexes start at 0 (zero) so index 2 is in fact position 3
var menu = plugins.menubar.getMenu(plugins.menubar.getMenuCount() - 1);

// remove all menu items from the selected menu
menu.removeAllItems();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
removeItem
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

removeItem

Unknown macro: {span}

(index 1, index 2-n)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {sub-section}
Unknown macro: {sub-section}

Remove the item(s) at the selected index/indices...

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}

index 1
[index 2-n]

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {sub-section}
Unknown macro: {sub-section}

void

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {sub-section}
Unknown macro: {sub-section}
// Remove the item(s) at the selected index/indices...
// get the menu at the last index
// indexes start at 0 (zero) so index 2 is in fact position 3
var menu = plugins.menubar.getMenu(plugins.menubar.getMenuCount() - 1);

// remove only one item at the selected index
// from the selected menu
// menu.removeItem(0);

// remove more than one item at the selected indices
// from the selected menu
menu.removeItem(1,2);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
set
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

set

Unknown macro: {span}

(text, mnemonic, enabled)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {sub-section}
Unknown macro: {sub-section}

Set the menu with a text and optional mnemonic key. The menu is enabled by default...

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}

text
[mnemonic]
[enabled]

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {sub-section}
Unknown macro: {sub-section}

void

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {sub-section}
Unknown macro: {sub-section}
// add a menu at the given index
// when you don't define an index the menu will be added at the last
// positon of the menubar
var menu = plugins.menubar.addMenu();

// set the text of the menu at the chose position
menu.setText("add menu");

// set the mnemonic key
menu.setMnemonic("a");

// disable the menu
menu.setEnabled(true);

// another way of doing the same thing would have been to use
// the set() method
menu.set("add menu", "a", true);

// REMARK: normally you would add menu items, checkboxes etc in the same method
// this example will show no menu items for now!

// IMPORTANT: Working with menu's on developer and client can differ

// WIZARD
// You can use the menubar wizard Tools/Plugins/IT2Be help/Menubar Wizzzard to create you menu
// The wizard will help you at least to learn how to use the plugin and will help you to find the correct
// accelerator key string
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
setEnabled
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

setEnabled

Unknown macro: {span}

(enabled)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {sub-section}
Unknown macro: {sub-section}

Set the the selected menu enabled or disabled...

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}

enabled

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {sub-section}
Unknown macro: {sub-section}

void

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {sub-section}
Unknown macro: {sub-section}
// Set the the selected menu enabled or disabled...
var menu = plugins.menubar.getMenu(0);
menu.setText("Hello");
menu.setMnemonic("H");
menu.setEnabled(false);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
setIcon
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

setIcon

Unknown macro: {span}

(icon)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {sub-section}
Unknown macro: {sub-section}

Set the icon of the menu...

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}

icon

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {sub-section}
Unknown macro: {sub-section}

void

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
setMnemonic
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

setMnemonic

Unknown macro: {span}

(mnemonic)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {sub-section}
Unknown macro: {sub-section}

Set the mnemonic of the selected menu...

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}

mnemonic

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {sub-section}
Unknown macro: {sub-section}

void

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {sub-section}
Unknown macro: {sub-section}
// Set the mnemonic of the selected menu...
var menu = plugins.menubar.getMenu(0);
menu.setText("Hello");
menu.setMnemonic("H");
menu.setEnabled(false);
Unknown macro: {tr}
Unknown macro: {td}
  • No labels