Page History

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
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 welldisplaynamethe 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
sIndentSmartClient,WebClient,NGClientsam
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
sIndentSmartClient,WebClient,NGClientsam
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
sIndentSmartClient,WebClient,NGClientsam
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
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcancelFormPopupaddToolBarname
cancelFormPopup()
addToolBar(name, displayname, row)dessIndent
Close the current form popup panel without assigning
Add a value to the configured data provider
toolbar.clientsprs
Supported Clients
Parameters
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 providerthe 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
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcreatePopupMenucancelFormPopupname
createPopupMenu
cancelFormPopup()dessIndent
Creates
Close the a
current new
form popup menu
panel that
without can
assigning be
a populated
value with
to items
the configured and
data displayed
provider.retReturns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcreateShortcutcloseFormPopupname
createShortcut
closeFormPopup(shortcut, methodName
retval)dessIndent
Create a shortcut
Close the current form popup panel and assign the value to the configured data provider.prs
Parameters
sIndentshortcut ;methodNamescopes.scopename.methodname or formname.methodname String to target the method to executeret
Returns
sIndentclientsretvalreturn value for data providerclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcreateShortcutcreateFormPopupname
createShortcut(shortcut, methodName, arguments
createFormPopup(form)dessIndent
Create a shortcutarguments ;ret
 form popup that can be filled with data and shown.prs
Parameters
sIndentshortcut ;methodNamescopes.scopename.methodname or formname.methodname String to target the method to executeformthe form to showret
Returns
sIndent FormPopupclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcreateShortcutcreatePopupMenuname
createShortcut
createPopupMenu(shortcut, methodName, contextFilter
)dessIndent
Create
Creates a shortcut
new popup menu that can be populated with items and displayed.prsret
ParameterssIndentshortcut ;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
Returns
sIndentclientsSupported 
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcreateShortcutname
createShortcut(shortcut,  method, contextFilter, argumentsarguments ;
methodName)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/elementmethodNamescopes.scopename.methodname or formname.methodname String to target the method to executeret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcreateShortcutname
createShortcut(shortcut, methodName,  contextFilter, 
 arguments, consumeEventarguments ;consumeEventif true then the shotcut will consume the event and the default browser behavior will not be executed (default false)ret
Returns
)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 ;ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcreateShortcutname
createShortcut(shortcut, methodName,  method
contextFilter)dessIndent
Create a shortcut.prs
Parameters
sIndentshortcut ;methodthe method/function that needs to be called when the shortcut is hitmethodNamescopes.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
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcreateShortcutname
createShortcut(shortcut, method, contextFilter, arguments)dessIndent
Create a shortcut.prs
Parameters
sIndentshortcut ;methodthe method/function that needs to be called when the shortcut is hitarguments ;retcontextFilterform or element name ( ng only - specified by formName.elementName); only triggers the shortcut when on this form/elementarguments ;ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcreateShortcutname
createShortcut(shortcut,  method
methodName, contextFilter, arguments, consumeEvent)dessIndent
Create a shortcut.prs
Parameters
sIndentshortcut ;methodmethodNamescopes.scopename.methodname or formname.methodname String to target the method /function that needs to be called when the shortcut is hit
Returns
sIndentclientsSupported Clientsto executecontextFilterform or element name ( ng only - specified by formName.elementName); only triggers the shortcut when on this form/elementretarguments ;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, contextFilter, argumentsarguments ;
)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
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcreateShortcutname
createShortcut(shortcut, method,  contextFilter, 
 arguments, consumeEventarguments ;consumeEventif true then the shotcut will consume the event and the default browser behavior will not be executed (default false)
)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
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetMenuBarcreateShortcutname
getMenuBar
createShortcut(shortcut, method, contextFilter)dessIndent
Get
Create the menubar of the main window, or of a named window.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetMenuBarname
getMenuBar(windowName)dessIndent
Get the menubar of the main window, or of a named window.prs
Parameters
sIndentwindowNamethe name of the window
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
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetToolBarcreateShortcutname
getToolBar(window, name
createShortcut(shortcut, method, contextFilter, arguments)dessIndent
Get the toolbar of
Create a specific window from the toolbar panel by nameReturns
shortcut.prs
Parameters
sIndentwindow ;name ;retshortcut ;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
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetToolBarcreateShortcutname
getToolBar(name
createShortcut(shortcut, method, contextFilter, arguments, consumeEvent)dessIndent
Get
Create the toolbar from the toolbar panel by name
a shortcut.prs
Parameters
sIndentname ;ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetToolbarNamesname
getToolbarNames()dessIndent
Get all toolbar names from the toolbar panel.shortcut ;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
sIdentjavascriptlastDetailRowgetToolbarNamesgetMenuBarname
getToolbarNames
getMenuBar(window
)dessIndent
Get all
the toolbar
menubar names
of from
the the
main toolbar
window, panel
or of a specific
Parameters
sIndentwindow ;retReturns
named window.prsret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowmaximizegetMenuBarname
maximize
getMenuBar(windowName)dessIndent
Maximize
Get the current
menubar window
of or
the the
main window, with
or the
of specified
a name (Smart client only).sam
named window.prs
Parameters
sIndentwindowNamethe name of the windowret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowmaximizegetToolBarname
maximize
getToolBar(windowName
window, name)dessIndent
Maximize
Get the current
toolbar window
of or
a the
specific window with
from the specified
toolbar name
panel (Smart client only)
by name.prs
Parameters
sIndentwindowName ;window ;name ;ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowremoveShortcutgetToolBarname
removeShortcut
getToolBar(shortcut
name)dessIndent
Remove
Get the a shortcut
toolbar from the toolbar panel by name.prs
Parameters
sIndentshortcutname ;ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowremoveShortcutgetToolbarNamesname
removeShortcut
getToolbarNames(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
sIdentjavascriptlastDetailRowremoveToolBarnameremoveToolBar(window, name
Get all toolbar names from the toolbar panel.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowgetToolbarNamesname
getToolbarNames(window)dessIndent
Remove
Get the
all toolbar names from the toolbar panel of a specific window.prs
Parameters
sIndentwindow ;name ;ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowremoveToolBarmaximizename
removeToolBar
maximize(name
)dessIndent
Remove
Maximize the current window or the toolbar
window from
with the toolbar panel.prs
Parameters
sIndentname ;
 specified name (Smart client only).clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowsetFullScreenmaximizename
setFullScreen
maximize(full
windowName)dessIndent
Bring
Maximize the current window or into/out
the of
window fullsceen mode.
with the specified name (Smart client only).prs
Parameters
sIndentfullwindowName ;clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowsetStatusBarVisibleremoveShortcutname
setStatusBarVisible
removeShortcut(visible
shortcut)dessIndent
Show
Remove or hide the statusbar
a shortcut.prs
Parameters
sIndentvisibleshortcut ;ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowsetToolBarAreaVisibleremoveShortcutname
setToolBarAreaVisible
removeShortcut(visible
shortcut, contextFilter)dessIndent
Show
Remove or hide the toolbar area
a shortcut.prs
Parameters
sIndentvisible ;shortcut ;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
sIdentjavascriptlastDetailRowshowFormPopupremoveToolBarname
showFormPopup
removeToolBar(elementToShowRelatedTo, form, scope, dataproviderID
window, name)dessIndent
Show
Remove the a
toolbar form
from as
the popup
toolbar panel,
 where
of the
a closeFormPopup can pass return a value to a dataprovider in the specified scope
specific window.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 fillwindow ;name ;clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowshowFormPopupremoveToolBarname
showFormPopup(elementToShowRelatedTo, form, scope, dataproviderID, width, height
removeToolBar(name)dessIndent
Show a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scopeheightpopup height
Remove the toolbar from the toolbar panel.prs
Parameters
sIndentname ;clients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowsetFullScreenname
setFullScreen(full)dessIndent
Bring the window into/out of fullsceen mode.prs
Parameters
sIndentfull ;clients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowsetStatusBarVisiblename
setStatusBarVisible(visible)dessIndent
Show or hide the statusbar.prs
Parameters
sIndentvisible ;clients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowsetToolBarAreaVisiblename
setToolBarAreaVisible(visible)dessIndent
Show or hide the toolbar area.prs
Parameters
sIndentvisible ;clients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowshowFormPopupname
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 fillclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowshowFormPopupname
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 heightclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowshowFormPopupname
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 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 widthwidthpopup widthheightpopup heightxpopup x locationypopup y locationshowBackdropwhatever to show a dimmed backdrop under the popupdoNotCloseOnClickOutsidewhether to close on not close the popup on clicking outsideclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowshowFormPopupname
showFormPopup(elementToShowRelatedTo, form, scope, dataproviderID, width, height, x, y, showBackdrop, doNotCloseOnClickOutside, onClose)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 popupdoNotCloseOnClickOutsidewhether to close on not close the popup on clicking outsideonClosea callback function that is being triggered once the formpopup window is being closedclients
Supported Clients
sIndentNGClientsam
Sample
sIdentjavascriptlastDetailRow