{hidden}
DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE{hidden}
{sub-section:description|text=}{sub-section}\\
{table:class=servoy sReturnTypes}{tr:style=height: 30px;}{th}Return Types{th}{tr}{tr}{td}{span:class=sWordList}[CheckBox]{span}{span:class=sWordList}[JSMenuItem]{span}{span:class=sWordList}[Menu]{span}{span:class=sWordList}[MenuItem]{span}{span:class=sWordList}[Popup]{span}{span:class=sWordList}[RadioButton]{span}{span:class=sWordList}[ToolBar]{span}{td}{tr}{table}\\
{table:class=servoy sSummery}{colgroup}{column:width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[Menu]{td}{td}[#addMenu]\(index)
Add the menu at the selected index (starting at 0) or add it at the end (empty).{td}{tr}{tbody}{tbody}{tr}{td}[ToolBar]{td}{td}[#addToolBar]\(name, displayname, row)
Add a toolbar by name and optional displayname and row.{td}{tr}{tbody}{tbody}{tr}{td}[Popup]{td}{td}[#createPopupMenu]\()
{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#createShortcut]\(shortcut, method, form_name)
Create a shortcut.{td}{tr}{tbody}{tbody}{tr}{td}[Menu]{td}{td}[#getMenu]\(index)
Get the menu at the selected index (starting at 0).{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getMenuCount]\()
Get the number of (top level) menu's.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getMenuIndexByText]\(menuName)
Retrieve the index of the item by text.{td}{tr}{tbody}{tbody}{tr}{td}[ToolBar]{td}{td}[#getToolBar]\(name)
Get the toolbar from the toolbar panel by name.{td}{tr}{tbody}{tbody}{tr}{td}[String]\[]{td}{td}[#getToolbarNames]\()
Get all toolbar names from the toolbar panel.{td}{tr}{tbody}{tbody}{tr}{td}[Menu]{td}{td}[#removeAllMenus]\()
Remove all menus from the menubar.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#removeMenu]\(index 1, index 2-n)
Remove the menu(s) at the selected index/indices.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#removeShortcut]\(shortcut, form_name)
Remove a shortcut.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#removeToolBar]\(name)
Remove the toolbar from the toolbar panel.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#resetMenuBar]\()
Reset the menubar to the default.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setFullScreen]\()
{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setMenuVisible]\()
{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setStatusBarVisible]\()
{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setToolBarVisible]\()
{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#validateMenuBar]\()
Use this when your add/remove/edit operation won't refresh.{td}{tr}{tbody}{table}\\
{table:class=servoy sDetail}{colgroup}{column:width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=90FDAB7D-71C9-4D81-92A7-907E1679B33F}{tr:id=name}{td}h6.addMenu{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Menu]{span}{span:id=iets|style=float: left; font-weight: bold;}addMenu{span}{span:id=iets|style=float: left;}\(index){span}{td}{tr}{tr:id=des}{td}{sub-section:90FDAB7D-71C9-4D81-92A7-907E1679B33F_des|text=|trigger=button}{sub-section}{sub-section:90FDAB7D-71C9-4D81-92A7-907E1679B33F_des|trigger=none|class=sIndent}Add the menu at the selected index (starting at 0) or add it at the end (empty).{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:90FDAB7D-71C9-4D81-92A7-907E1679B33F_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:90FDAB7D-71C9-4D81-92A7-907E1679B33F_prs|trigger=none}\[index\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:90FDAB7D-71C9-4D81-92A7-907E1679B33F_ret|text=|trigger=button}{sub-section}{sub-section:90FDAB7D-71C9-4D81-92A7-907E1679B33F_ret|trigger=none|class=sIndent}[Menu]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:90FDAB7D-71C9-4D81-92A7-907E1679B33F_see|text=|trigger=button}{sub-section}{sub-section:90FDAB7D-71C9-4D81-92A7-907E1679B33F_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:90FDAB7D-71C9-4D81-92A7-907E1679B33F_see|text=|trigger=button}{sub-section}{sub-section:90FDAB7D-71C9-4D81-92A7-907E1679B33F_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:90FDAB7D-71C9-4D81-92A7-907E1679B33F_sam|text=|trigger=button}{sub-section}{sub-section:90FDAB7D-71C9-4D81-92A7-907E1679B33F_sam|class=sIndent|trigger=none}{code:language=javascript}
// Note: method addMenu only works in the smart client.
// Add the menu at the selected index (starting at 0) or add it at the end (empty).
// 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.window.addMenu();
// set the text of the menu at the chose position
menu.setText("add menu");
// set the mnemonic key
menu.setMnemonic("a");
// enable the menu
menu.setEnabled(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
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=AE6DCC33-6063-48CD-83E4-CB68F4DE0F0B}{tr:id=name}{td}h6.addToolBar{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[ToolBar]{span}{span:id=iets|style=float: left; font-weight: bold;}addToolBar{span}{span:id=iets|style=float: left;}\(name, displayname, row){span}{td}{tr}{tr:id=des}{td}{sub-section:AE6DCC33-6063-48CD-83E4-CB68F4DE0F0B_des|text=|trigger=button}{sub-section}{sub-section:AE6DCC33-6063-48CD-83E4-CB68F4DE0F0B_des|trigger=none|class=sIndent}Add a toolbar by name and optional displayname and row.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:AE6DCC33-6063-48CD-83E4-CB68F4DE0F0B_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:AE6DCC33-6063-48CD-83E4-CB68F4DE0F0B_prs|trigger=none}name
\[displayname\]
\[row\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:AE6DCC33-6063-48CD-83E4-CB68F4DE0F0B_ret|text=|trigger=button}{sub-section}{sub-section:AE6DCC33-6063-48CD-83E4-CB68F4DE0F0B_ret|trigger=none|class=sIndent}[ToolBar]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:AE6DCC33-6063-48CD-83E4-CB68F4DE0F0B_see|text=|trigger=button}{sub-section}{sub-section:AE6DCC33-6063-48CD-83E4-CB68F4DE0F0B_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:AE6DCC33-6063-48CD-83E4-CB68F4DE0F0B_see|text=|trigger=button}{sub-section}{sub-section:AE6DCC33-6063-48CD-83E4-CB68F4DE0F0B_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:AE6DCC33-6063-48CD-83E4-CB68F4DE0F0B_sam|text=|trigger=button}{sub-section}{sub-section:AE6DCC33-6063-48CD-83E4-CB68F4DE0F0B_sam|class=sIndent|trigger=none}{code:language=javascript}
// Note: method addToolBar only works in the smart client.
// Add a toolbar by name and optional displayname and row.
// add a toolbar with only a name
var toolbar = plugins.window.addToolBar("toolbar_0");
// add a toolbar with a name and internal name
// var toolbar = plugins.window.addToolBar("toolbar_1", "toolbar_1");
// add a toolbar with a name, internal name and the row you want the
// toolbar to show at. rownumber starts at 0
// var toolbar = plugins.window.addToolBar("toolbar_2", "toolbar_2", 3);
// REMARK: normally you would add buttons, checkboxes etc in the same method
// this example will show no buttons for now!
// we will add them via the other methods on this form.
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=D5A019BA-02DB-4F2D-A30C-FF6428DF8D6F}{tr:id=name}{td}h6.createPopupMenu{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Popup]{span}{span:id=iets|style=float: left; font-weight: bold;}createPopupMenu{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:D5A019BA-02DB-4F2D-A30C-FF6428DF8D6F_des|text=|trigger=button}{sub-section}{sub-section:D5A019BA-02DB-4F2D-A30C-FF6428DF8D6F_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:D5A019BA-02DB-4F2D-A30C-FF6428DF8D6F_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D5A019BA-02DB-4F2D-A30C-FF6428DF8D6F_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:D5A019BA-02DB-4F2D-A30C-FF6428DF8D6F_ret|text=|trigger=button}{sub-section}{sub-section:D5A019BA-02DB-4F2D-A30C-FF6428DF8D6F_ret|trigger=none|class=sIndent}[Popup]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:D5A019BA-02DB-4F2D-A30C-FF6428DF8D6F_see|text=|trigger=button}{sub-section}{sub-section:D5A019BA-02DB-4F2D-A30C-FF6428DF8D6F_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:D5A019BA-02DB-4F2D-A30C-FF6428DF8D6F_see|text=|trigger=button}{sub-section}{sub-section:D5A019BA-02DB-4F2D-A30C-FF6428DF8D6F_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:D5A019BA-02DB-4F2D-A30C-FF6428DF8D6F_sam|text=|trigger=button}{sub-section}{sub-section:D5A019BA-02DB-4F2D-A30C-FF6428DF8D6F_sam|class=sIndent|trigger=none}{code:language=javascript}
var popupmenu = plugins.window.createPopupMenu()
var menuitem1 = popupmenu.addMenuItem('A',myMethod)
var menuitem2 = popupmenu.addRadioButton('B',myMethod)
var menuitem3 = popupmenu.addRadioButton('C',myMethod)
var menuitem4 = popupmenu.addSeparator()
var menuitem5 = popupmenu.addMenuItem('<html><b>Hello</b></html>',myMethod)
var menuitem6 = popupmenu.addMenuItem('G', globals.myGlobalMethod)
var submenu = popupmenu.addMenu('SubMenu')
var subitem1 = submenu.addCheckBox('i18n:bla_bla',myMethod)
var subitem2 = submenu.addCheckBox('he' , globals.myOtherGlobalMethod , 'media:///day_obj.gif')
var subitem3 = submenu.addCheckBox('more' , globals.myOtherGlobalMethod ,null, 'm') //last parameter is mnemonic-key
menuitem2.setSelected(true);
menuitem6.setEnabled(false)
subitem2.setSelected(true);
var source = event.getSource()
if (source != null)
{
popupmenu.show(source);
//or you can set the coordinates popupmenu.show(10, 10);
}
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=8CD39777-1D25-49BD-B8A4-BD6DD7FB11FF}{tr:id=name}{td}h6.createShortcut{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}createShortcut{span}{span:id=iets|style=float: left;}\(shortcut, method, form_name){span}{td}{tr}{tr:id=des}{td}{sub-section:8CD39777-1D25-49BD-B8A4-BD6DD7FB11FF_des|text=|trigger=button}{sub-section}{sub-section:8CD39777-1D25-49BD-B8A4-BD6DD7FB11FF_des|trigger=none|class=sIndent}Create a shortcut.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:8CD39777-1D25-49BD-B8A4-BD6DD7FB11FF_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:8CD39777-1D25-49BD-B8A4-BD6DD7FB11FF_prs|trigger=none}shortcut
method
\[form_name\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:8CD39777-1D25-49BD-B8A4-BD6DD7FB11FF_ret|text=|trigger=button}{sub-section}{sub-section:8CD39777-1D25-49BD-B8A4-BD6DD7FB11FF_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:8CD39777-1D25-49BD-B8A4-BD6DD7FB11FF_see|text=|trigger=button}{sub-section}{sub-section:8CD39777-1D25-49BD-B8A4-BD6DD7FB11FF_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:8CD39777-1D25-49BD-B8A4-BD6DD7FB11FF_see|text=|trigger=button}{sub-section}{sub-section:8CD39777-1D25-49BD-B8A4-BD6DD7FB11FF_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:8CD39777-1D25-49BD-B8A4-BD6DD7FB11FF_sam|text=|trigger=button}{sub-section}{sub-section:8CD39777-1D25-49BD-B8A4-BD6DD7FB11FF_sam|class=sIndent|trigger=none}{code:language=javascript}
// Create a shortcut.
// this plugin uses the java keystroke parser
// see http://java.sun.com/j2se/1.5.0/docs/api/javax/swing/KeyStroke.html#getKeyStroke(java.lang.String)
// global shortcut (on all forms) on 'apple 1' on a mac client and 'control 1' on other client platforms
plugins.window.createShortcut('menu 1', 'globals.handleShortcut');
// global handler, only triggered when on form frm_orders
plugins.window.createShortcut('control shift I', globals.handleOrdersShortcut, 'frm_orders');
// form method called when shortcut is used
plugins.window.createShortcut('control LEFT', 'frm_products.handleShortcut', 'frm_products');
// same, but use method in stead of string
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut, 'frm_contacts');
// remove global shortcut and form-level shortcut
plugins.window.createShortcut('menu 1');
plugins.window.removeShortcut('control RIGHT', 'frm_contacts');
// shortcut handlers are called with an jsevent argument
///**
//* Handle keyboard shortcut.
//*
//* @param {JSEvent} event the event that triggered the action
//*/
//function handleShortcut(event)
//{
// application.output(event.getType()) // returns 'menu 1'
// application.output(event.getFormName()) // returns 'frm_contacts'
// application.output(event.getElementName()) // returns 'contact_name_field' or null when no element is selected
//}
// NOTE: shortcuts will not override existing operating system or browser shortcuts,
// choose your shortcuts careful to make sure they work in all clients.
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=04F078EB-4029-45BA-B746-A42C0C02F2ED}{tr:id=name}{td}h6.getMenu{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Menu]{span}{span:id=iets|style=float: left; font-weight: bold;}getMenu{span}{span:id=iets|style=float: left;}\(index){span}{td}{tr}{tr:id=des}{td}{sub-section:04F078EB-4029-45BA-B746-A42C0C02F2ED_des|text=|trigger=button}{sub-section}{sub-section:04F078EB-4029-45BA-B746-A42C0C02F2ED_des|trigger=none|class=sIndent}Get the menu at the selected index (starting at 0).{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:04F078EB-4029-45BA-B746-A42C0C02F2ED_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:04F078EB-4029-45BA-B746-A42C0C02F2ED_prs|trigger=none}index
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:04F078EB-4029-45BA-B746-A42C0C02F2ED_ret|text=|trigger=button}{sub-section}{sub-section:04F078EB-4029-45BA-B746-A42C0C02F2ED_ret|trigger=none|class=sIndent}[Menu]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:04F078EB-4029-45BA-B746-A42C0C02F2ED_see|text=|trigger=button}{sub-section}{sub-section:04F078EB-4029-45BA-B746-A42C0C02F2ED_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:04F078EB-4029-45BA-B746-A42C0C02F2ED_see|text=|trigger=button}{sub-section}{sub-section:04F078EB-4029-45BA-B746-A42C0C02F2ED_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:04F078EB-4029-45BA-B746-A42C0C02F2ED_sam|text=|trigger=button}{sub-section}{sub-section:04F078EB-4029-45BA-B746-A42C0C02F2ED_sam|class=sIndent|trigger=none}{code:language=javascript}
// Note: method getMenu only works in the smart client.
// Get the menu at the selected index (starting at 0).
// get the menu from at index 2
// indexes start at 0 (zero) so index 2 is in fact position 3
var menu = plugins.window.getMenu(2);
// set the text of the menu at the chose position
menu.setText("get menu");$
// set the mnemonic key
menu.setMnemonic("g");
// disable the menu
menu.setEnabled(false);
// REMARK: we actually changed an original menu! As a result resetting the
// menubar will NOT reset the above changes. We need to reset the menu
// manually the following way:
// get the menu
// var menu = plugins.window.getMenu(2);
// 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
// menu.setText("i18n:servoy.menuitem.showAll");// menu.setEnabled(true);
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=75C40F94-7517-4AE5-8F30-B55752197FC4}{tr:id=name}{td}h6.getMenuCount{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getMenuCount{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:75C40F94-7517-4AE5-8F30-B55752197FC4_des|text=|trigger=button}{sub-section}{sub-section:75C40F94-7517-4AE5-8F30-B55752197FC4_des|trigger=none|class=sIndent}Get the number of (top level) menu's.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:75C40F94-7517-4AE5-8F30-B55752197FC4_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:75C40F94-7517-4AE5-8F30-B55752197FC4_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:75C40F94-7517-4AE5-8F30-B55752197FC4_ret|text=|trigger=button}{sub-section}{sub-section:75C40F94-7517-4AE5-8F30-B55752197FC4_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:75C40F94-7517-4AE5-8F30-B55752197FC4_see|text=|trigger=button}{sub-section}{sub-section:75C40F94-7517-4AE5-8F30-B55752197FC4_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:75C40F94-7517-4AE5-8F30-B55752197FC4_see|text=|trigger=button}{sub-section}{sub-section:75C40F94-7517-4AE5-8F30-B55752197FC4_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:75C40F94-7517-4AE5-8F30-B55752197FC4_sam|text=|trigger=button}{sub-section}{sub-section:75C40F94-7517-4AE5-8F30-B55752197FC4_sam|class=sIndent|trigger=none}{code:language=javascript}
// Note: method getMenuCount only works in the smart client.
// Get the number of (top level) menu's.
plugins.window.getMenuCount()
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=F5B88141-6426-450B-9262-CAB4C904539F}{tr:id=name}{td}h6.getMenuIndexByText{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getMenuIndexByText{span}{span:id=iets|style=float: left;}\(menuName){span}{td}{tr}{tr:id=des}{td}{sub-section:F5B88141-6426-450B-9262-CAB4C904539F_des|text=|trigger=button}{sub-section}{sub-section:F5B88141-6426-450B-9262-CAB4C904539F_des|trigger=none|class=sIndent}Retrieve the index of the item by text.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:F5B88141-6426-450B-9262-CAB4C904539F_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:F5B88141-6426-450B-9262-CAB4C904539F_prs|trigger=none}menuName
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:F5B88141-6426-450B-9262-CAB4C904539F_ret|text=|trigger=button}{sub-section}{sub-section:F5B88141-6426-450B-9262-CAB4C904539F_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:F5B88141-6426-450B-9262-CAB4C904539F_see|text=|trigger=button}{sub-section}{sub-section:F5B88141-6426-450B-9262-CAB4C904539F_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:F5B88141-6426-450B-9262-CAB4C904539F_see|text=|trigger=button}{sub-section}{sub-section:F5B88141-6426-450B-9262-CAB4C904539F_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:F5B88141-6426-450B-9262-CAB4C904539F_sam|text=|trigger=button}{sub-section}{sub-section:F5B88141-6426-450B-9262-CAB4C904539F_sam|class=sIndent|trigger=none}{code:language=javascript}
// Retrieve the index of the item by text.
plugins.window.getMenuIndexByText()
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=224F66AA-8E4C-40DB-98C8-9DCA68BEB953}{tr:id=name}{td}h6.getToolBar{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[ToolBar]{span}{span:id=iets|style=float: left; font-weight: bold;}getToolBar{span}{span:id=iets|style=float: left;}\(name){span}{td}{tr}{tr:id=des}{td}{sub-section:224F66AA-8E4C-40DB-98C8-9DCA68BEB953_des|text=|trigger=button}{sub-section}{sub-section:224F66AA-8E4C-40DB-98C8-9DCA68BEB953_des|trigger=none|class=sIndent}Get the toolbar from the toolbar panel by name.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:224F66AA-8E4C-40DB-98C8-9DCA68BEB953_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:224F66AA-8E4C-40DB-98C8-9DCA68BEB953_prs|trigger=none}name
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:224F66AA-8E4C-40DB-98C8-9DCA68BEB953_ret|text=|trigger=button}{sub-section}{sub-section:224F66AA-8E4C-40DB-98C8-9DCA68BEB953_ret|trigger=none|class=sIndent}[ToolBar]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:224F66AA-8E4C-40DB-98C8-9DCA68BEB953_see|text=|trigger=button}{sub-section}{sub-section:224F66AA-8E4C-40DB-98C8-9DCA68BEB953_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:224F66AA-8E4C-40DB-98C8-9DCA68BEB953_see|text=|trigger=button}{sub-section}{sub-section:224F66AA-8E4C-40DB-98C8-9DCA68BEB953_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:224F66AA-8E4C-40DB-98C8-9DCA68BEB953_sam|text=|trigger=button}{sub-section}{sub-section:224F66AA-8E4C-40DB-98C8-9DCA68BEB953_sam|class=sIndent|trigger=none}{code:language=javascript}
// Note: method getToolBar only works in the smart client.
// Get the toolbar from the toolbar panel by name.
// get the toolbar at the panel by name
var toolbar = plugins.window.getToolBar("toolbar_0");
// add a button with a text and a method
toolbar.addButton("button", feedback_button);
// add an input array to the button for feedback in the selected method
toolbar.addButton("button", feedback_button, [1, "2", "three"]);
// add an icon to the button
toolbar.addButton("button", feedback_button, [1, "2", "three"], "media:///yourimage.gif");
// add a tooltip to the button
toolbar.addButton("button", feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip.");
// show only an icon on the button and disable the button
toolbar.addButton(null, feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip.", false);
// add a separator
toolbar.addSeparator();
// make the button non visible
toolbar.addButton(null, feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip.",true, false);
// and validate the changes
// to make them know to the user interface)
toolbar.validate();
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=812BC191-599C-4616-AE24-1CA2A31A74DF}{tr:id=name}{td}h6.getToolbarNames{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]\[]{span}{span:id=iets|style=float: left; font-weight: bold;}getToolbarNames{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:812BC191-599C-4616-AE24-1CA2A31A74DF_des|text=|trigger=button}{sub-section}{sub-section:812BC191-599C-4616-AE24-1CA2A31A74DF_des|trigger=none|class=sIndent}Get all toolbar names from the toolbar panel.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:812BC191-599C-4616-AE24-1CA2A31A74DF_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:812BC191-599C-4616-AE24-1CA2A31A74DF_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:812BC191-599C-4616-AE24-1CA2A31A74DF_ret|text=|trigger=button}{sub-section}{sub-section:812BC191-599C-4616-AE24-1CA2A31A74DF_ret|trigger=none|class=sIndent}[String]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:812BC191-599C-4616-AE24-1CA2A31A74DF_see|text=|trigger=button}{sub-section}{sub-section:812BC191-599C-4616-AE24-1CA2A31A74DF_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:812BC191-599C-4616-AE24-1CA2A31A74DF_see|text=|trigger=button}{sub-section}{sub-section:812BC191-599C-4616-AE24-1CA2A31A74DF_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:812BC191-599C-4616-AE24-1CA2A31A74DF_sam|text=|trigger=button}{sub-section}{sub-section:812BC191-599C-4616-AE24-1CA2A31A74DF_sam|class=sIndent|trigger=none}{code:language=javascript}
// Note: method getToolbarNames only works in the smart client.
// Get all toolbar names from the toolbar panel.
// create an array of toolbar names
var names = plugins.window.getToolbarNames();
// create an empty message variable
var message = "";
// loop through the array
for (var i = 0 ; i < names.length ; i++) {
//add the name(s) to the message
message += names[i] + "\n";
}
// show the message
plugins.dialogs.showInfoDialog("toolbar names", message);
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=BA79C893-F82F-46F6-9BAE-37E931B1E80A}{tr:id=name}{td}h6.removeAllMenus{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Menu]{span}{span:id=iets|style=float: left; font-weight: bold;}removeAllMenus{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:BA79C893-F82F-46F6-9BAE-37E931B1E80A_des|text=|trigger=button}{sub-section}{sub-section:BA79C893-F82F-46F6-9BAE-37E931B1E80A_des|trigger=none|class=sIndent}Remove all menus from the menubar.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:BA79C893-F82F-46F6-9BAE-37E931B1E80A_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:BA79C893-F82F-46F6-9BAE-37E931B1E80A_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:BA79C893-F82F-46F6-9BAE-37E931B1E80A_ret|text=|trigger=button}{sub-section}{sub-section:BA79C893-F82F-46F6-9BAE-37E931B1E80A_ret|trigger=none|class=sIndent}[Menu]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:BA79C893-F82F-46F6-9BAE-37E931B1E80A_see|text=|trigger=button}{sub-section}{sub-section:BA79C893-F82F-46F6-9BAE-37E931B1E80A_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:BA79C893-F82F-46F6-9BAE-37E931B1E80A_see|text=|trigger=button}{sub-section}{sub-section:BA79C893-F82F-46F6-9BAE-37E931B1E80A_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:BA79C893-F82F-46F6-9BAE-37E931B1E80A_sam|text=|trigger=button}{sub-section}{sub-section:BA79C893-F82F-46F6-9BAE-37E931B1E80A_sam|class=sIndent|trigger=none}{code:language=javascript}
// Note: method removeAllMenus only works in the smart client.
// Remove all menus from the menubar.
// Remove all menus from the menubar.
// Potentially dangerous because all accelerator (short) keys
// will be deleted also (including the quit item)
plugins.window.removeAllMenus();
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=F214159B-33AF-4C29-A1AD-F29143AF78B8}{tr:id=name}{td}h6.removeMenu{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}removeMenu{span}{span:id=iets|style=float: left;}\(index 1, index 2-n){span}{td}{tr}{tr:id=des}{td}{sub-section:F214159B-33AF-4C29-A1AD-F29143AF78B8_des|text=|trigger=button}{sub-section}{sub-section:F214159B-33AF-4C29-A1AD-F29143AF78B8_des|trigger=none|class=sIndent}Remove the menu(s) at the selected index/indices.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:F214159B-33AF-4C29-A1AD-F29143AF78B8_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:F214159B-33AF-4C29-A1AD-F29143AF78B8_prs|trigger=none}index 1
\[index 2-n\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:F214159B-33AF-4C29-A1AD-F29143AF78B8_ret|text=|trigger=button}{sub-section}{sub-section:F214159B-33AF-4C29-A1AD-F29143AF78B8_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:F214159B-33AF-4C29-A1AD-F29143AF78B8_see|text=|trigger=button}{sub-section}{sub-section:F214159B-33AF-4C29-A1AD-F29143AF78B8_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:F214159B-33AF-4C29-A1AD-F29143AF78B8_see|text=|trigger=button}{sub-section}{sub-section:F214159B-33AF-4C29-A1AD-F29143AF78B8_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:F214159B-33AF-4C29-A1AD-F29143AF78B8_sam|text=|trigger=button}{sub-section}{sub-section:F214159B-33AF-4C29-A1AD-F29143AF78B8_sam|class=sIndent|trigger=none}{code:language=javascript}
// Note: method removeMenu only works in the smart client.
// Remove the menu(s) at the selected index/indices.
// To remove the last menu in the menubar we count the number of menu's in the menubar
// because the index starts at 0 we have to substract 1 from the counted menu's
// to actually remove the last menu from the menubar
plugins.window.removeMenu(plugins.window.getMenuCount() - 1);
// To remove the last 3 (three) menu's from the menubar we
// can do that by adding additional indexes to the method
// and delimit them with a comma.
var index = plugins.window.getMenuCount() - 1;
// remove the last item
plugins.window.removeMenu(index);
// remove 3 (three) items
// plugins.window.removeMenu(this.index, index-1, 2);
// For 'security' reasons it is best to ALWAYS remove the menu with the last index
// first to avoid index out of range issues and other issues
// EXAMPLE: when you first remove the menu at index 2 and then the menu at index 4
// you actually remove the menu at index 2 and index 5
// after removing the menu at index 2 all other menu's moved one index to the left
// so the menu at index 4 moved to index 3 and the menu at index 5 moved to index 4 etc.
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=0BAF2BDD-9C10-48A8-8BD5-F25D5FEB67FC}{tr:id=name}{td}h6.removeShortcut{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}removeShortcut{span}{span:id=iets|style=float: left;}\(shortcut, form_name){span}{td}{tr}{tr:id=des}{td}{sub-section:0BAF2BDD-9C10-48A8-8BD5-F25D5FEB67FC_des|text=|trigger=button}{sub-section}{sub-section:0BAF2BDD-9C10-48A8-8BD5-F25D5FEB67FC_des|trigger=none|class=sIndent}Remove a shortcut.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:0BAF2BDD-9C10-48A8-8BD5-F25D5FEB67FC_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:0BAF2BDD-9C10-48A8-8BD5-F25D5FEB67FC_prs|trigger=none}shortcut
\[form_name\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:0BAF2BDD-9C10-48A8-8BD5-F25D5FEB67FC_ret|text=|trigger=button}{sub-section}{sub-section:0BAF2BDD-9C10-48A8-8BD5-F25D5FEB67FC_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:0BAF2BDD-9C10-48A8-8BD5-F25D5FEB67FC_see|text=|trigger=button}{sub-section}{sub-section:0BAF2BDD-9C10-48A8-8BD5-F25D5FEB67FC_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:0BAF2BDD-9C10-48A8-8BD5-F25D5FEB67FC_see|text=|trigger=button}{sub-section}{sub-section:0BAF2BDD-9C10-48A8-8BD5-F25D5FEB67FC_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:0BAF2BDD-9C10-48A8-8BD5-F25D5FEB67FC_sam|text=|trigger=button}{sub-section}{sub-section:0BAF2BDD-9C10-48A8-8BD5-F25D5FEB67FC_sam|class=sIndent|trigger=none}{code:language=javascript}
// Remove a shortcut.
// this plugin uses the java keystroke parser
// see http://java.sun.com/j2se/1.5.0/docs/api/javax/swing/KeyStroke.html#getKeyStroke(java.lang.String)
// global shortcut (on all forms) on 'apple 1' on a mac client and 'control 1' on other client platforms
plugins.window.createShortcut('menu 1', 'globals.handleShortcut');
// global handler, only triggered when on form frm_orders
plugins.window.createShortcut('control shift I', globals.handleOrdersShortcut, 'frm_orders');
// form method called when shortcut is used
plugins.window.createShortcut('control LEFT', 'frm_products.handleShortcut', 'frm_products');
// same, but use method in stead of string
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut, 'frm_contacts');
// remove global shortcut and form-level shortcut
plugins.window.createShortcut('menu 1');
plugins.window.removeShortcut('control RIGHT', 'frm_contacts');
// shortcut handlers are called with an jsevent argument
///**
//* Handle keyboard shortcut.
//*
//* @param {JSEvent} event the event that triggered the action
//*/
//function handleShortcut(event)
//{
// application.output(event.getType()) // returns 'menu 1'
// application.output(event.getFormName()) // returns 'frm_contacts'
// application.output(event.getElementName()) // returns 'contact_name_field' or null when no element is selected
//}
// NOTE: shortcuts will not override existing operating system or browser shortcuts,
// choose your shortcuts careful to make sure they work in all clients.
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=926C017C-CF22-46E3-9AC5-4F73B5585567}{tr:id=name}{td}h6.removeToolBar{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}removeToolBar{span}{span:id=iets|style=float: left;}\(name){span}{td}{tr}{tr:id=des}{td}{sub-section:926C017C-CF22-46E3-9AC5-4F73B5585567_des|text=|trigger=button}{sub-section}{sub-section:926C017C-CF22-46E3-9AC5-4F73B5585567_des|trigger=none|class=sIndent}Remove the toolbar from the toolbar panel.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:926C017C-CF22-46E3-9AC5-4F73B5585567_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:926C017C-CF22-46E3-9AC5-4F73B5585567_prs|trigger=none}name
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:926C017C-CF22-46E3-9AC5-4F73B5585567_ret|text=|trigger=button}{sub-section}{sub-section:926C017C-CF22-46E3-9AC5-4F73B5585567_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:926C017C-CF22-46E3-9AC5-4F73B5585567_see|text=|trigger=button}{sub-section}{sub-section:926C017C-CF22-46E3-9AC5-4F73B5585567_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:926C017C-CF22-46E3-9AC5-4F73B5585567_see|text=|trigger=button}{sub-section}{sub-section:926C017C-CF22-46E3-9AC5-4F73B5585567_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:926C017C-CF22-46E3-9AC5-4F73B5585567_sam|text=|trigger=button}{sub-section}{sub-section:926C017C-CF22-46E3-9AC5-4F73B5585567_sam|class=sIndent|trigger=none}{code:language=javascript}
// Note: method removeToolBar only works in the smart client.
// Remove the toolbar from the toolbar panel.
// removing a toolbar from the toolbar panel is done by name
// the plugin checks the existence of the toolbar
// when the toolbar does not exist it will not throw an error though.
plugins.window.removeToolBar("toolbar_0");
plugins.window.removeToolBar("toolbar_1");
plugins.window.removeToolBar("toolbar_2");
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=D7E15631-2F74-4A60-8F8E-5833A5EF8CCA}{tr:id=name}{td}h6.resetMenuBar{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}resetMenuBar{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:D7E15631-2F74-4A60-8F8E-5833A5EF8CCA_des|text=|trigger=button}{sub-section}{sub-section:D7E15631-2F74-4A60-8F8E-5833A5EF8CCA_des|trigger=none|class=sIndent}Reset the menubar to the default.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:D7E15631-2F74-4A60-8F8E-5833A5EF8CCA_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D7E15631-2F74-4A60-8F8E-5833A5EF8CCA_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:D7E15631-2F74-4A60-8F8E-5833A5EF8CCA_ret|text=|trigger=button}{sub-section}{sub-section:D7E15631-2F74-4A60-8F8E-5833A5EF8CCA_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:D7E15631-2F74-4A60-8F8E-5833A5EF8CCA_see|text=|trigger=button}{sub-section}{sub-section:D7E15631-2F74-4A60-8F8E-5833A5EF8CCA_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:D7E15631-2F74-4A60-8F8E-5833A5EF8CCA_see|text=|trigger=button}{sub-section}{sub-section:D7E15631-2F74-4A60-8F8E-5833A5EF8CCA_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:D7E15631-2F74-4A60-8F8E-5833A5EF8CCA_sam|text=|trigger=button}{sub-section}{sub-section:D7E15631-2F74-4A60-8F8E-5833A5EF8CCA_sam|class=sIndent|trigger=none}{code:language=javascript}
// Note: method resetMenuBar only works in the smart client.
// Reset the menubar to the default.
// When the menubar settings are solution specific it is advised to reset
// the bar to its default settings when closing the solution.
// Another reason is that when a client/developer is started first the
// plugin will save the current settings in memory
// REMARK: Don't manipulate standard Servoy menuitems but remove
// them and create new ones! Due to the way menuitems are managed by java it is not
// possible to reset a menuitem anymore.
plugins.window.resetMenuBar();
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=3ADDD3D6-8ABF-4FEE-B106-32FAC073552F}{tr:id=name}{td}h6.setFullScreen{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setFullScreen{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:3ADDD3D6-8ABF-4FEE-B106-32FAC073552F_des|text=|trigger=button}{sub-section}{sub-section:3ADDD3D6-8ABF-4FEE-B106-32FAC073552F_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:3ADDD3D6-8ABF-4FEE-B106-32FAC073552F_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:3ADDD3D6-8ABF-4FEE-B106-32FAC073552F_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:3ADDD3D6-8ABF-4FEE-B106-32FAC073552F_ret|text=|trigger=button}{sub-section}{sub-section:3ADDD3D6-8ABF-4FEE-B106-32FAC073552F_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:3ADDD3D6-8ABF-4FEE-B106-32FAC073552F_see|text=|trigger=button}{sub-section}{sub-section:3ADDD3D6-8ABF-4FEE-B106-32FAC073552F_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:3ADDD3D6-8ABF-4FEE-B106-32FAC073552F_see|text=|trigger=button}{sub-section}{sub-section:3ADDD3D6-8ABF-4FEE-B106-32FAC073552F_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:3ADDD3D6-8ABF-4FEE-B106-32FAC073552F_sam|text=|trigger=button}{sub-section}{sub-section:3ADDD3D6-8ABF-4FEE-B106-32FAC073552F_sam|class=sIndent|trigger=none}{code:language=javascript}
plugins.window.setFullScreen(true)
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=4B5C86CE-82A5-4DED-9D63-20A45292316E}{tr:id=name}{td}h6.setMenuVisible{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setMenuVisible{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:4B5C86CE-82A5-4DED-9D63-20A45292316E_des|text=|trigger=button}{sub-section}{sub-section:4B5C86CE-82A5-4DED-9D63-20A45292316E_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:4B5C86CE-82A5-4DED-9D63-20A45292316E_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:4B5C86CE-82A5-4DED-9D63-20A45292316E_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:4B5C86CE-82A5-4DED-9D63-20A45292316E_ret|text=|trigger=button}{sub-section}{sub-section:4B5C86CE-82A5-4DED-9D63-20A45292316E_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:4B5C86CE-82A5-4DED-9D63-20A45292316E_see|text=|trigger=button}{sub-section}{sub-section:4B5C86CE-82A5-4DED-9D63-20A45292316E_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:4B5C86CE-82A5-4DED-9D63-20A45292316E_see|text=|trigger=button}{sub-section}{sub-section:4B5C86CE-82A5-4DED-9D63-20A45292316E_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:4B5C86CE-82A5-4DED-9D63-20A45292316E_sam|text=|trigger=button}{sub-section}{sub-section:4B5C86CE-82A5-4DED-9D63-20A45292316E_sam|class=sIndent|trigger=none}{code:language=javascript}
plugins.window.setMenuVisible(false)
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=3D092CF4-D553-47B9-BA7B-91A841326C12}{tr:id=name}{td}h6.setStatusBarVisible{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setStatusBarVisible{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:3D092CF4-D553-47B9-BA7B-91A841326C12_des|text=|trigger=button}{sub-section}{sub-section:3D092CF4-D553-47B9-BA7B-91A841326C12_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:3D092CF4-D553-47B9-BA7B-91A841326C12_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:3D092CF4-D553-47B9-BA7B-91A841326C12_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:3D092CF4-D553-47B9-BA7B-91A841326C12_ret|text=|trigger=button}{sub-section}{sub-section:3D092CF4-D553-47B9-BA7B-91A841326C12_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:3D092CF4-D553-47B9-BA7B-91A841326C12_see|text=|trigger=button}{sub-section}{sub-section:3D092CF4-D553-47B9-BA7B-91A841326C12_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:3D092CF4-D553-47B9-BA7B-91A841326C12_see|text=|trigger=button}{sub-section}{sub-section:3D092CF4-D553-47B9-BA7B-91A841326C12_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:3D092CF4-D553-47B9-BA7B-91A841326C12_sam|text=|trigger=button}{sub-section}{sub-section:3D092CF4-D553-47B9-BA7B-91A841326C12_sam|class=sIndent|trigger=none}{code:language=javascript}
plugins.window.setStatusBarVisible()
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=B5685DA1-619D-4B51-86C1-825CDBF5F0DC}{tr:id=name}{td}h6.setToolBarVisible{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setToolBarVisible{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:B5685DA1-619D-4B51-86C1-825CDBF5F0DC_des|text=|trigger=button}{sub-section}{sub-section:B5685DA1-619D-4B51-86C1-825CDBF5F0DC_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:B5685DA1-619D-4B51-86C1-825CDBF5F0DC_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B5685DA1-619D-4B51-86C1-825CDBF5F0DC_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:B5685DA1-619D-4B51-86C1-825CDBF5F0DC_ret|text=|trigger=button}{sub-section}{sub-section:B5685DA1-619D-4B51-86C1-825CDBF5F0DC_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:B5685DA1-619D-4B51-86C1-825CDBF5F0DC_see|text=|trigger=button}{sub-section}{sub-section:B5685DA1-619D-4B51-86C1-825CDBF5F0DC_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:B5685DA1-619D-4B51-86C1-825CDBF5F0DC_see|text=|trigger=button}{sub-section}{sub-section:B5685DA1-619D-4B51-86C1-825CDBF5F0DC_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:B5685DA1-619D-4B51-86C1-825CDBF5F0DC_sam|text=|trigger=button}{sub-section}{sub-section:B5685DA1-619D-4B51-86C1-825CDBF5F0DC_sam|class=sIndent|trigger=none}{code:language=javascript}
plugins.window.setToolBarVisible(false)
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=D7B1B2A8-5F85-42EB-9C64-9F590041802A}{tr:id=name}{td}h6.validateMenuBar{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}validateMenuBar{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:D7B1B2A8-5F85-42EB-9C64-9F590041802A_des|text=|trigger=button}{sub-section}{sub-section:D7B1B2A8-5F85-42EB-9C64-9F590041802A_des|trigger=none|class=sIndent}Use this when your add/remove/edit operation won't refresh.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:D7B1B2A8-5F85-42EB-9C64-9F590041802A_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D7B1B2A8-5F85-42EB-9C64-9F590041802A_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:D7B1B2A8-5F85-42EB-9C64-9F590041802A_ret|text=|trigger=button}{sub-section}{sub-section:D7B1B2A8-5F85-42EB-9C64-9F590041802A_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:D7B1B2A8-5F85-42EB-9C64-9F590041802A_see|text=|trigger=button}{sub-section}{sub-section:D7B1B2A8-5F85-42EB-9C64-9F590041802A_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:D7B1B2A8-5F85-42EB-9C64-9F590041802A_see|text=|trigger=button}{sub-section}{sub-section:D7B1B2A8-5F85-42EB-9C64-9F590041802A_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:D7B1B2A8-5F85-42EB-9C64-9F590041802A_sam|text=|trigger=button}{sub-section}{sub-section:D7B1B2A8-5F85-42EB-9C64-9F590041802A_sam|class=sIndent|trigger=none}{code:language=javascript}
// Note: method validateMenuBar only works in the smart client.
// Use this when your add/remove/edit operation won't refresh.
plugins.window.validateMenuBar();
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
Cache
index
true
refresh
100d
showRefresh
true
id
doc
title
Refresh page
showDate
true
retry
Enable
servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientservoy sSummary12%30%58%height: 30px;3Methods SummaryCreates and returns a toolbar for a specific window.Creates and returns a toolbar for a specific window.Creates and returns a toolbar for a specific window.Creates and returns a toolbar for a specific window.Add a toolbar.Add a toolbar.Add a toolbar.Add a toolbar.voidClose the current form popup panel without assigning a value to the configured data provider.voidClose the current form popup panel and assign the value to the configured data provider.Create a form popup that can be filled with data and shown.Creates a new popup menu that can be populated with items and displayed.Create a shortcut.Create a shortcut.Create a shortcut.Create a shortcut.Create a shortcut.Create a shortcut.Create a shortcut.Create a shortcut.Create a shortcut.Create a shortcut.Get the menubar of the main window, or of a named window.Get the menubar of the main window, or of a named window.Get the toolbar of a specific window from the toolbar panel by name.Get the toolbar from the toolbar panel by name.Get all toolbar names from the toolbar panel.Get all toolbar names from the toolbar panel of a specific window.voidMaximize the current window or the window with the specified name (Smart client only).voidMaximize the current window or the window with the specified name (Smart client only).Remove a shortcut.Remove a shortcut.voidRemove the toolbar from the toolbar panel of a specific window.voidRemove the toolbar from the toolbar panel.voidBring the window into/out of fullsceen mode.voidShow or hide the statusbar.voidShow or hide the toolbar area.voidShow a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scope.voidShow a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scope.voidShow a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scope.voidShow a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scope.voidShow a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scope.voidShow a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scope.functionservoy sDetail2100%height:30px2Methods DetailsaddToolBarname
addToolBar(window, name)
dessIndent
Creates and returns a toolbar for a specific window.
prs
Parameters
sIndentwindow ;namethe name by which this toolbar is identified in code. If display name is missing, name will be used as displayName as well.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowaddToolBarname
addToolBar(window, name, row)
dessIndent
Creates and returns a toolbar for a specific window.
prs
Parameters
sIndentwindow ;namethe name by which this toolbar is identified in code. If display name is missing, name will be used as displayName as well.rowthe row inside the toolbar panel where this toolbar is to be added.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowaddToolBarname
addToolBar(window, name, displayname)
dessIndent
Creates and returns a toolbar for a specific window.
prs
Parameters
sIndentwindow ;namethe name by which this toolbar is identified in codedisplaynamethe name by which this toolbar will be identified in the UI. (for example in the toolbar panel's context menu)ret
Returns
sIndentclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowaddToolBarname
addToolBar(window, name, displayname, row)
dessIndent
Creates and returns a toolbar for a specific window.
prs
Parameters
sIndentwindow ;namethe name by which this toolbar is identified in code.displaynamethe name by which this toolbar will be identified in the UI. (for example in the toolbar panel's context menu)rowthe row inside the toolbar panel where this toolbar is to be added.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowaddToolBarname
addToolBar(name)
dessIndent
Add a toolbar.
prs
Parameters
sIndentnamethe name by which this toolbar is identified in code. If display name is missing, name will be used as displayName as well.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowaddToolBarname
addToolBar(name, row)
dessIndent
Add a toolbar.
prs
Parameters
sIndentnamethe name by which this toolbar is identified in code. If display name is missing, name will be used as displayName as well.rowthe row inside the toolbar panel where this toolbar is to be added.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowaddToolBarname
addToolBar(name, displayname)
dessIndent
Add a toolbar.
prs
Parameters
sIndentnamethe name by which this toolbar is identified in code. If display name is missing, name will be used as displayName as well.displaynamethe name by which this toolbar will be identified in the UI. (for example in the toolbar panel's context menu)ret
Returns
sIndentclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowaddToolBarname
addToolBar(name, displayname, row)
dessIndent
Add a toolbar.
prs
Parameters
sIndentnamethe name by which this toolbar is identified in code. If display name is missing, name will be used as displayName as well.displaynamethe name by which this toolbar will be identified in the UI. (for example in the toolbar panel's context menu)rowthe row inside the toolbar panel where this toolbar is to be added.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowcancelFormPopupname
cancelFormPopup()
dessIndent
Close the current form popup panel without assigning a value to the configured data provider.
clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcloseFormPopupname
closeFormPopup(retval)
dessIndent
Close the current form popup panel and assign the value to the configured data provider.
prs
Parameters
sIndentretvalreturn value for data providerclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcreateFormPopupname
createFormPopup(form)
dessIndent
Create a form popup that can be filled with data and shown.
prs
Parameters
sIndentformthe form to showret
Returns
sIndent FormPopupclients
Supported Clients
sIndentNGClientsam
Sample
sIdentjavascriptlastDetailRowcreatePopupMenuname
createPopupMenu()
dessIndent
Creates a new popup menu that can be populated with items and displayed.
ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcreateShortcutname
createShortcut(shortcut, methodName)
dessIndent
Create a shortcut.
prs
Parameters
sIndentshortcut ;methodNamescopes.scopename.methodname or formname.methodname String to target the method to executeret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcreateShortcutname
createShortcut(shortcut, methodName, arguments)
dessIndent
Create a shortcut.
prs
Parameters
sIndentshortcut ;methodNamescopes.scopename.methodname or formname.methodname String to target the method to executearguments ;ret
sIndentshortcut ;methodNamescopes.scopename.methodname or formname.methodname String to target the method to executecontextFilterform or element name ( ng only - specified by formName.elementName); only triggers the shortcut when on this form/elementret
sIndentshortcut ;methodthe method/function that needs to be called when the shortcut is hitcontextFilterform or element name ( ng only - specified by formName.elementName); only triggers the shortcut when on this form/elementarguments ;ret
sIndentshortcut ;methodNamescopes.scopename.methodname or formname.methodname String to target the method to executecontextFilterform or element name ( ng only - specified by formName.elementName); only triggers the shortcut when on this form/elementarguments ;consumeEventif true then the shotcut will consume the event and the default browser behavior will not be executed (default false)ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcreateShortcutname
createShortcut(shortcut, method)
dessIndent
Create a shortcut.
prs
Parameters
sIndentshortcut ;methodthe method/function that needs to be called when the shortcut is hitret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcreateShortcutname
createShortcut(shortcut, method, arguments)
dessIndent
Create a shortcut.
prs
Parameters
sIndentshortcut ;methodthe method/function that needs to be called when the shortcut is hitarguments ;ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcreateShortcutname
createShortcut(shortcut, method, contextFilter)
dessIndent
Create a shortcut.
prs
Parameters
sIndentshortcut ;methodthe method/function that needs to be called when the shortcut is hitcontextFilterform or element name ( ng only - specified by formName.elementName); only triggers the shortcut when on this form/elementret
sIndentshortcut ;methodthe method/function that needs to be called when the shortcut is hitcontextFilterform or element name ( ng only - specified by formName.elementName); only triggers the shortcut when on this form/elementarguments ;ret
sIndentshortcut ;methodthe method/function that needs to be called when the shortcut is hitcontextFilterform or element name ( ng only - specified by formName.elementName); only triggers the shortcut when on this form/elementarguments ;consumeEventif true then the shotcut will consume the event and the default browser behavior will not be executed (default false)ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetMenuBarname
getMenuBar()
dessIndent
Get the menubar of the main window, or of a named window.
ret
Returns
sIndentclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowgetMenuBarname
getMenuBar(windowName)
dessIndent
Get the menubar of the main window, or of a named window.
prs
Parameters
sIndentwindowNamethe name of the windowret
Returns
sIndentclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowgetToolBarname
getToolBar(window, name)
dessIndent
Get the toolbar of a specific window from the toolbar panel by name.
prs
Parameters
sIndentwindow ;name ;ret
Returns
sIndentclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowgetToolBarname
getToolBar(name)
dessIndent
Get the toolbar from the toolbar panel by name.
prs
Parameters
sIndentname ;ret
Returns
sIndentclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowgetToolbarNamesname
getToolbarNames()
dessIndent
Get all toolbar names from the toolbar panel.
ret
Returns
sIndentclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowgetToolbarNamesname
getToolbarNames(window)
dessIndent
Get all toolbar names from the toolbar panel of a specific window.
prs
Parameters
sIndentwindow ;ret
Returns
sIndentclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowmaximizename
maximize()
dessIndent
Maximize the current window or the window with the specified name (Smart client only).
clients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowmaximizename
maximize(windowName)
dessIndent
Maximize the current window or the window with the specified name (Smart client only).
prs
Parameters
sIndentwindowName ;clients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowremoveShortcutname
removeShortcut(shortcut)
dessIndent
Remove a shortcut.
prs
Parameters
sIndentshortcut ;ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowremoveShortcutname
removeShortcut(shortcut, contextFilter)
dessIndent
Remove a shortcut.
prs
Parameters
sIndentshortcut ;contextFilterform or element name ( ng only - specified by formName.elementName); only triggers the shortcut when on this form/elementret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowremoveToolBarname
removeToolBar(window, name)
dessIndent
Remove the toolbar from the toolbar panel of a specific window.
Show a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scope.
prs
Parameters
sIndentelementToShowRelatedToelement to show related to or null to center in screenformthe form to showscopethe scope to put retval intodataproviderIDthe dataprovider of scope to fillclients
Show a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scope.
prs
Parameters
sIndentelementToShowRelatedToelement to show related to or null to center in screenformthe form to showscopethe scope to put retval intodataproviderIDthe dataprovider of scope to fillwidthpopup widthheightpopup heightclients
Show a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scope. Can show relative to a component or at specified coordinates.
Show on specified location is only supported in NGClient.
prs
Parameters
sIndentelementToShowRelatedToelement to show related to or null to center in screenformthe form to showscopethe scope to put retval intodataproviderIDthe dataprovider of scope to fillwidthpopup widthheightpopup heightxpopup x locationypopup y locationclients
Supported Clients
sIndentNGClientsam
Sample
sIdentjavascriptlastDetailRowshowFormPopupname
showFormPopup(elementToShowRelatedTo, form, scope, dataproviderID, width, height, x, y, showBackdrop)
dessIndent
Show a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scope. Can show relative to a component or at specified coordinates.
Show on specified location and backdrop is only supported in NGClient.
prs
Parameters
sIndentelementToShowRelatedToelement to show related to or null to center in screenformthe form to showscopethe scope to put retval intodataproviderIDthe dataprovider of scope to fillwidthpopup widthheightpopup heightxpopup x locationypopup y locationshowBackdropwhatever to show a dimmed backdrop under the popupclients
Supported Clients
sIndentNGClientsam
Sample
sIdentjavascriptlastDetailRowshowFormPopupname
showFormPopup(elementToShowRelatedTo, form, scope, dataproviderID, width, height, x, y, showBackdrop, doNotCloseOnClickOutside)
dessIndent
Show a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scope. Can show relative to a component or at specified coordinates.
Show on specified location and backdrop is only supported in NGClient.
By setting the @param doNotCloseOnClickOutside as true, one can ensure that the popup will not be closed when clicking outside this popup.
prs
Parameters
sIndentelementToShowRelatedToelement to show related to or null to center in screenformthe form to showscopethe scope to put retval intodataproviderIDthe dataprovider of scope to fillwidthpopup widthheightpopup heightxpopup x locationypopup y locationshowBackdropwhatever to show a dimmed backdrop under the popupdoNotCloseOnClickOutsidewhether to close on not close the popup on clicking outsideclients
Show a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scope. Can show relative to a component or at specified coordinates.
Show on specified location and backdrop is only supported in NGClient.
prs
Parameters
sIndentelementToShowRelatedToelement to show related to or null to center in screenformthe form to showscopethe scope to put retval intodataproviderIDthe dataprovider of scope to fillwidthpopup widthheightpopup heightxpopup x locationypopup y locationshowBackdropwhatever to show a dimmed backdrop under the popupdoNotCloseOnClickOutsidewhether to close on not close the popup on clicking outsideonClosea callback function that is being triggered once the formpopup window is being closedclients