Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy 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.

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

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRowaddToolBarname

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

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
addToolBarname

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

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
addToolBarname

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

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
addToolBarname

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

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
addToolBarname

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

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
addToolBarname

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

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
addToolBarname

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

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
cancelFormPopupname

cancelFormPopup()

dessIndent
Close the current form popup panel without assigning a value to the configured data provider.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
closeFormPopupname

closeFormPopup(retval)

dessIndent
Close the current form popup panel and assign the value to the configured data provider.
prs

Parameters

sIndentretvalreturn value for data provider
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createFormPopupname

createFormPopup(form)

dessIndent
Create a form popup that can be filled with data and shown.
prs

Parameters

sIndentformthe form to show
ret

Returns

sIndent FormPopup
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
createPopupMenuname

createPopupMenu()

dessIndent
Creates a new popup menu that can be populated with items and displayed.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createShortcutname

createShortcut(shortcut, methodName)

dessIndent
Create a shortcut.
prs

Parameters

sIndentshortcut ;methodNamescopes.scopename.methodname or formname.methodname String to target the method to execute
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createShortcutname

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createShortcutname

createShortcut(shortcut, methodName, contextFilter)

dessIndent
Create a shortcut.
prs

Parameters

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/element
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createShortcutname

createShortcut(shortcut, method, contextFilter, arguments)

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/elementarguments ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createShortcutname

createShortcut(shortcut, methodName, contextFilter, arguments, consumeEvent)

dessIndent
Create a shortcut.
prs

Parameters

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

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createShortcutname

createShortcut(shortcut, method)

dessIndent
Create a shortcut.
prs

Parameters

sIndentshortcut ;methodthe method/function that needs to be called when the shortcut is hit
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createShortcutname

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

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createShortcutname

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/element
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createShortcutname

createShortcut(shortcut, method, contextFilter, arguments)

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/elementarguments ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createShortcutname

createShortcut(shortcut, method, contextFilter, arguments, consumeEvent)

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/elementarguments ;consumeEventif true then the shotcut will consume the event and the default browser behavior will not be executed (default false)
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getMenuBarname

getMenuBar()

dessIndent
Get the menubar of the main window, or of a named window.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
getMenuBarname

getMenuBar(windowName)

dessIndent
Get the menubar of the main window, or of a named window.
prs

Parameters

sIndentwindowNamethe name of the window
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
getToolBarname

getToolBar(window, name)

dessIndent
Get the toolbar of a specific window from the toolbar panel by name.
prs

Parameters

sIndentwindow ;name ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
getToolBarname

getToolBar(name)

dessIndent
Get the toolbar from the toolbar panel by name.
prs

Parameters

sIndentname ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
getToolbarNamesname

getToolbarNames()

dessIndent
Get all toolbar names from the toolbar panel.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
getToolbarNamesname

getToolbarNames(window)

dessIndent
Get all toolbar names from the toolbar panel of a specific window.
prs

Parameters

sIndentwindow ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
maximizename

maximize()

dessIndent
Maximize the current window or the window with the specified name (Smart client only).
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
maximizename

maximize(windowName)

dessIndent
Maximize the current window or the window with the specified name (Smart client only).
prs

Parameters

sIndentwindowName ;
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
removeShortcutname

removeShortcut(shortcut)

dessIndent
Remove a shortcut.
prs

Parameters

sIndentshortcut ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
removeShortcutname

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/element
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
removeToolBarname

removeToolBar(window, name)

dessIndent
Remove the toolbar from the toolbar panel of a specific window.
prs

Parameters

sIndentwindow ;name ;
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
removeToolBarname

removeToolBar(name)

dessIndent
Remove the toolbar from the toolbar panel.
prs

Parameters

sIndentname ;
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
setFullScreenname

setFullScreen(full)

dessIndent
Bring the window into/out of fullsceen mode.
prs

Parameters

sIndentfull ;
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
setStatusBarVisiblename

setStatusBarVisible(visible)

dessIndent
Show or hide the statusbar.
prs

Parameters

sIndentvisible ;
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
setToolBarAreaVisiblename

setToolBarAreaVisible(visible)

dessIndent
Show or hide the toolbar area.
prs

Parameters

sIndentvisible ;
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
showFormPopupname

showFormPopup(elementToShowRelatedTo, form, scope, dataproviderID)

dessIndent
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 fill
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showFormPopupname

showFormPopup(elementToShowRelatedTo, form, scope, dataproviderID, width, height)

dessIndent
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 height
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showFormPopupname

showFormPopup(elementToShowRelatedTo, form, scope, dataproviderID, width, height, x, y)

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 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 location
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
showFormPopupname

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 popup
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow