To learn more about using JavaScript in LeanFT, see Setting up and working with the JavaScript SDK.
For JavaScript code samples, see Code Samples - JavaScript.

SAPGUI

SAPGUI

SAPGUI namespace

Classes

APOGrid
APOGridCell
APOGridTO
Button
ButtonTO
Calendar
CalendarTO
CheckBox
CheckBoxTO
ComboBox
ComboBoxItem
ComboBoxTO
Edit
Editor
EditorTO
EditTO
Element
ElementTO
Grid
GridCell
GridTO
GuiSession
GuiSessionFactory
GuiSessionTO
Label
LabelTO
Menubar
MenubarTO
OKCode
OKCodeTO
RadioButton
RadioButtonTO
StatusBar
StatusBarTO
TabControl
TabControlTO
Table
TableCell
TableTO
ToolBar
ToolBarTO
TreeView
TreeViewNode
TreeViewTO
Window
WindowTO

Type Definitions

ComponentType

SAPGUI component types. Possible values for the 'ComponentType' type.
Type:
Properties:
Name Type Description
unknown string Unknown type.
component string Component type.
vComponent string Vcomponent type.
vContainer string Vcontainer type.
application string Application
connection string Connection type.
session string Session type.
frameWindow string Frame Window type.
mainWindow string Main Window type.
modalWindow string Modal Window type.
messageWindow string Message Window type.
label string Label type.
textField string Text Field type.
cTextField string Ctextfield type.
passwordField string Password Field type.
comboBox string Combobox type.
okCodeField string OKCode Field type.
button string Button type.
radioButton string Radio Button type.
checkBox string Checkbox type.
statusPane string Status Pane type.
customControl string Custom Control type.
containerShell string Container Shell type.
box string Box type.
container string Container type.
simpleContainer string Simple Container type.
scrollContainer string Scroll Container type.
listContainer string List Container type.
userArea string User Area type.
tableControl string Table Control type.
tableColumn string tablecolumn type.
tableRow string Tablerow type.
tabStrip string Tabstrip type.
tab string Tab type.
scrollbar string Scrollbar type.
toolBar string Toolbar type.
titlebar string Titlebar type.
statusbar string StatusBar type
menu string Menu type.
menubar string Menubar type.
collection string Collection type.
sessionInfo string Session Info type.
shell string Shell type.
gosShell string GOS Shell type.
splitterShell string Splitter Shell type.
dialogShell string Dialog Shell type.
dockShell string Dock Shell type.
contextMenu string Context Menu type.
componentCollection string Component Collection type.
ctrlTree string TreeView control type.
ctrlGridView string Grid View control type.
ctrlToolBar string toolbar control type.
ctrlTextArea string Editor control type.
gridToolBar string Grid toolbar type.
ctrlCalendar string Calendar control type.
fallbackComponent string Fallback Component type.
ctrlApoGrid string APOGrid control type.

SapFunctionKey

Function keys and key combinations defined by SAPGUI.
Type:
Properties:
Name Type Description
enter string Enter key.
f1 string F1 key.
f2 string F2 key.
f3 string F3 key.
f4 string F4 key.
f5 string F5 key.
f6 string F6 key.
f7 string F7 key.
f8 string F8 key.
f9 string F9 key.
f10 string F10 key.
f11 string F11 key.
esc string F12 key.
shiftF1 string Shift + F1 key.
shiftF2 string Shift + F2 key.
shiftF3 string Shift + F3 key.
shiftF4 string Shift + F4 key.
shiftF5 string Shift + F5 key.
shiftF6 string Shift + F6 key.
shiftF7 string Shift + F7 key.
shiftF8 string Shift + F8 key.
shiftF9 string Shift + F9 key.
shiftF10 string Shift + F10 key.
shiftF11 string Shift + F11 key.
shiftF12 string Shift + F12 key.
ctrlF1 string Ctrl + F1 key.
ctrlF2 string Ctrl + F2 key.
ctrlF3 string Ctrl + F3 key.
ctrlF4 string Ctrl + F4 key.
ctrlF5 string Ctrl + F5 key.
ctrlF6 string Ctrl + F6 key.
ctrlF7 string Ctrl + F7 key.
ctrlF8 string Ctrl + F8 key.
ctrlF9 string Ctrl + F9 key.
ctrlF10 string Ctrl + F10 key.
ctrlF11 string Ctrl + F11 key.
ctrlF12 string Ctrl + F12 key.
ctrlShiftF1 string Ctrl + Shift + F1.
ctrlShiftF2 string Ctrl + Shift + F2.
ctrlShiftF3 string Ctrl + Shift + F3.
ctrlShiftF4 string Ctrl + Shift + F4.
ctrlShiftF5 string Ctrl + Shift + F5.
ctrlShiftF6 string Ctrl + Shift + F6.
ctrlShiftF7 string Ctrl + Shift + F7.
ctrlShiftF8 string Ctrl + Shift + F8.
ctrlShiftF9 string Ctrl + Shift + F9.
ctrlShiftF10 string Ctrl + Shift + F10.
ctrlShiftF11 string Ctrl + Shift + F11.
ctrlShiftF12 string Ctrl + Shift + F12.
pageDown string Page Down key.
pageUp string Page Up key.
ctrlF string Ctrl + F keys.
ctrlPageUp string Ctrl + PageUp keys.
ctrlPageDown string Ctrl + PageDown keys.
ctrlG string Ctrl + G keys.
ctrlP string Ctrl + P keys.

StatusBarMessageType

The type of message in the StatusBar.
Type:
Properties:
Name Type Description
success string Success
warning string Warning
error string Error

TableSelectionMode

The selections that are possible in a table.
Type:
Properties:
Name Type Description
noSelection string Cannot select
singleSelection string Only one can be selected.
multipleSelection string One or more can be selected.

TreeSelectionMode

The selections that are possible in a tree.
Type:
Properties:
Name Type Description
treeSelectNodeSingle string Can select a single node.
treeSelectNodeMultiple string Can select multiple nodes.
treeSelectItemSingle string Can select a single item.
treeSelectItemMultiple string Can select multiple items.

TreeType

The type of tree.
Type:
Properties:
Name Type Description
simpleTree string A tree without any items
listTree string A tree that includes various items
columnTree string A tree with columns

SAPGUI

SAPGUI namespace

Classes

APOGrid
APOGridCell
APOGridTO
Button
ButtonTO
Calendar
CalendarTO
CheckBox
CheckBoxTO
ComboBox
ComboBoxItem
ComboBoxTO
Edit
Editor
EditorTO
EditTO
Element
ElementTO
Grid
GridCell
GridTO
GuiSession
GuiSessionFactory
GuiSessionTO
Label
LabelTO
Menubar
MenubarTO
OKCode
OKCodeTO
RadioButton
RadioButtonTO
StatusBar
StatusBarTO
TabControl
TabControlTO
Table
TableCell
TableTO
ToolBar
ToolBarTO
TreeView
TreeViewNode
TreeViewTO
Window
WindowTO

Type Definitions

ComponentType

SAPGUI component types. Possible values for the 'ComponentType' type.
Type:
Properties:
Name Type Description
unknown string Unknown type.
component string Component type.
vComponent string Vcomponent type.
vContainer string Vcontainer type.
application string Application
connection string Connection type.
session string Session type.
frameWindow string Frame Window type.
mainWindow string Main Window type.
modalWindow string Modal Window type.
messageWindow string Message Window type.
label string Label type.
textField string Text Field type.
cTextField string Ctextfield type.
passwordField string Password Field type.
comboBox string Combobox type.
okCodeField string OKCode Field type.
button string Button type.
radioButton string Radio Button type.
checkBox string Checkbox type.
statusPane string Status Pane type.
customControl string Custom Control type.
containerShell string Container Shell type.
box string Box type.
container string Container type.
simpleContainer string Simple Container type.
scrollContainer string Scroll Container type.
listContainer string List Container type.
userArea string User Area type.
tableControl string Table Control type.
tableColumn string tablecolumn type.
tableRow string Tablerow type.
tabStrip string Tabstrip type.
tab string Tab type.
scrollbar string Scrollbar type.
toolBar string Toolbar type.
titlebar string Titlebar type.
statusbar string StatusBar type
menu string Menu type.
menubar string Menubar type.
collection string Collection type.
sessionInfo string Session Info type.
shell string Shell type.
gosShell string GOS Shell type.
splitterShell string Splitter Shell type.
dialogShell string Dialog Shell type.
dockShell string Dock Shell type.
contextMenu string Context Menu type.
componentCollection string Component Collection type.
ctrlTree string TreeView control type.
ctrlGridView string Grid View control type.
ctrlToolBar string toolbar control type.
ctrlTextArea string Editor control type.
gridToolBar string Grid toolbar type.
ctrlCalendar string Calendar control type.
fallbackComponent string Fallback Component type.
ctrlApoGrid string APOGrid control type.

SapFunctionKey

Function keys and key combinations defined by SAPGUI.
Type:
Properties:
Name Type Description
enter string Enter key.
f1 string F1 key.
f2 string F2 key.
f3 string F3 key.
f4 string F4 key.
f5 string F5 key.
f6 string F6 key.
f7 string F7 key.
f8 string F8 key.
f9 string F9 key.
f10 string F10 key.
f11 string F11 key.
esc string F12 key.
shiftF1 string Shift + F1 key.
shiftF2 string Shift + F2 key.
shiftF3 string Shift + F3 key.
shiftF4 string Shift + F4 key.
shiftF5 string Shift + F5 key.
shiftF6 string Shift + F6 key.
shiftF7 string Shift + F7 key.
shiftF8 string Shift + F8 key.
shiftF9 string Shift + F9 key.
shiftF10 string Shift + F10 key.
shiftF11 string Shift + F11 key.
shiftF12 string Shift + F12 key.
ctrlF1 string Ctrl + F1 key.
ctrlF2 string Ctrl + F2 key.
ctrlF3 string Ctrl + F3 key.
ctrlF4 string Ctrl + F4 key.
ctrlF5 string Ctrl + F5 key.
ctrlF6 string Ctrl + F6 key.
ctrlF7 string Ctrl + F7 key.
ctrlF8 string Ctrl + F8 key.
ctrlF9 string Ctrl + F9 key.
ctrlF10 string Ctrl + F10 key.
ctrlF11 string Ctrl + F11 key.
ctrlF12 string Ctrl + F12 key.
ctrlShiftF1 string Ctrl + Shift + F1.
ctrlShiftF2 string Ctrl + Shift + F2.
ctrlShiftF3 string Ctrl + Shift + F3.
ctrlShiftF4 string Ctrl + Shift + F4.
ctrlShiftF5 string Ctrl + Shift + F5.
ctrlShiftF6 string Ctrl + Shift + F6.
ctrlShiftF7 string Ctrl + Shift + F7.
ctrlShiftF8 string Ctrl + Shift + F8.
ctrlShiftF9 string Ctrl + Shift + F9.
ctrlShiftF10 string Ctrl + Shift + F10.
ctrlShiftF11 string Ctrl + Shift + F11.
ctrlShiftF12 string Ctrl + Shift + F12.
pageDown string Page Down key.
pageUp string Page Up key.
ctrlF string Ctrl + F keys.
ctrlPageUp string Ctrl + PageUp keys.
ctrlPageDown string Ctrl + PageDown keys.
ctrlG string Ctrl + G keys.
ctrlP string Ctrl + P keys.

StatusBarMessageType

The type of message in the StatusBar.
Type:
Properties:
Name Type Description
success string Success
warning string Warning
error string Error

TableSelectionMode

The selections that are possible in a table.
Type:
Properties:
Name Type Description
noSelection string Cannot select
singleSelection string Only one can be selected.
multipleSelection string One or more can be selected.

TreeSelectionMode

The selections that are possible in a tree.
Type:
Properties:
Name Type Description
treeSelectNodeSingle string Can select a single node.
treeSelectNodeMultiple string Can select multiple nodes.
treeSelectItemSingle string Can select a single item.
treeSelectItemMultiple string Can select multiple items.

TreeType

The type of tree.
Type:
Properties:
Name Type Description
simpleTree string A tree without any items
listTree string A tree that includes various items
columnTree string A tree with columns