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:
NameTypeDescription
unknownstringUnknown type.
componentstringComponent type.
vComponentstringVcomponent type.
vContainerstringVcontainer type.
applicationstringApplication
connectionstringConnection type.
sessionstringSession type.
frameWindowstringFrame Window type.
mainWindowstringMain Window type.
modalWindowstringModal Window type.
messageWindowstringMessage Window type.
labelstringLabel type.
textFieldstringText Field type.
cTextFieldstringCtextfield type.
passwordFieldstringPassword Field type.
comboBoxstringCombobox type.
okCodeFieldstringOKCode Field type.
buttonstringButton type.
radioButtonstringRadio Button type.
checkBoxstringCheckbox type.
statusPanestringStatus Pane type.
customControlstringCustom Control type.
containerShellstringContainer Shell type.
boxstringBox type.
containerstringContainer type.
simpleContainerstringSimple Container type.
scrollContainerstringScroll Container type.
listContainerstringList Container type.
userAreastringUser Area type.
tableControlstringTable Control type.
tableColumnstringtablecolumn type.
tableRowstringTablerow type.
tabStripstringTabstrip type.
tabstringTab type.
scrollbarstringScrollbar type.
toolBarstringToolbar type.
titlebarstringTitlebar type.
statusbarstringStatusBar type
menustringMenu type.
menubarstringMenubar type.
collectionstringCollection type.
sessionInfostringSession Info type.
shellstringShell type.
gosShellstringGOS Shell type.
splitterShellstringSplitter Shell type.
dialogShellstringDialog Shell type.
dockShellstringDock Shell type.
contextMenustringContext Menu type.
componentCollectionstringComponent Collection type.
ctrlTreestringTreeView control type.
ctrlGridViewstringGrid View control type.
ctrlToolBarstringtoolbar control type.
ctrlTextAreastringEditor control type.
gridToolBarstringGrid toolbar type.
ctrlCalendarstringCalendar control type.
fallbackComponentstringFallback Component type.
ctrlApoGridstringAPOGrid control type.

SapFunctionKey

Function keys and key combinations defined by SAPGUI.
Type:
Properties:
NameTypeDescription
enterstringEnter key.
f1stringF1 key.
f2stringF2 key.
f3stringF3 key.
f4stringF4 key.
f5stringF5 key.
f6stringF6 key.
f7stringF7 key.
f8stringF8 key.
f9stringF9 key.
f10stringF10 key.
f11stringF11 key.
escstringF12 key.
shiftF1stringShift + F1 key.
shiftF2stringShift + F2 key.
shiftF3stringShift + F3 key.
shiftF4stringShift + F4 key.
shiftF5stringShift + F5 key.
shiftF6stringShift + F6 key.
shiftF7stringShift + F7 key.
shiftF8stringShift + F8 key.
shiftF9stringShift + F9 key.
shiftF10stringShift + F10 key.
shiftF11stringShift + F11 key.
shiftF12stringShift + F12 key.
ctrlF1stringCtrl + F1 key.
ctrlF2stringCtrl + F2 key.
ctrlF3stringCtrl + F3 key.
ctrlF4stringCtrl + F4 key.
ctrlF5stringCtrl + F5 key.
ctrlF6stringCtrl + F6 key.
ctrlF7stringCtrl + F7 key.
ctrlF8stringCtrl + F8 key.
ctrlF9stringCtrl + F9 key.
ctrlF10stringCtrl + F10 key.
ctrlF11stringCtrl + F11 key.
ctrlF12stringCtrl + F12 key.
ctrlShiftF1stringCtrl + Shift + F1.
ctrlShiftF2stringCtrl + Shift + F2.
ctrlShiftF3stringCtrl + Shift + F3.
ctrlShiftF4stringCtrl + Shift + F4.
ctrlShiftF5stringCtrl + Shift + F5.
ctrlShiftF6stringCtrl + Shift + F6.
ctrlShiftF7stringCtrl + Shift + F7.
ctrlShiftF8stringCtrl + Shift + F8.
ctrlShiftF9stringCtrl + Shift + F9.
ctrlShiftF10stringCtrl + Shift + F10.
ctrlShiftF11stringCtrl + Shift + F11.
ctrlShiftF12stringCtrl + Shift + F12.
pageDownstringPage Down key.
pageUpstringPage Up key.
ctrlFstringCtrl + F keys.
ctrlPageUpstringCtrl + PageUp keys.
ctrlPageDownstringCtrl + PageDown keys.
ctrlGstringCtrl + G keys.
ctrlPstringCtrl + P keys.

StatusBarMessageType

The type of message in the StatusBar.
Type:
Properties:
NameTypeDescription
successstringSuccess
warningstringWarning
errorstringError

TableSelectionMode

The selections that are possible in a table.
Type:
Properties:
NameTypeDescription
noSelectionstringCannot select
singleSelectionstringOnly one can be selected.
multipleSelectionstringOne or more can be selected.

TreeSelectionMode

The selections that are possible in a tree.
Type:
Properties:
NameTypeDescription
treeSelectNodeSinglestringCan select a single node.
treeSelectNodeMultiplestringCan select multiple nodes.
treeSelectItemSinglestringCan select a single item.
treeSelectItemMultiplestringCan select multiple items.

TreeType

The type of tree.
Type:
Properties:
NameTypeDescription
simpleTreestringA tree without any items
listTreestringA tree that includes various items
columnTreestringA tree with columns