GuiSession class

Represents an SAP GUI session — the primary user-facing class.

Extends GuiContainer with session-specific operations: startTransaction, endTransaction, sendCommand, createSession, info, and activeWindow.

This is the object you receive inside runScriptSafely:

await runScriptSafely<String>(msg, (session, args) async {
  session.startTransaction('XD03');
  session.findCTextField('wnd[0]/usr/ctxtRF02D-KUNNR')?.text = '10025';
  session.findButton('wnd[0]/tbar[0]/btn[0]')?.press();
  session.endTransaction();
  return 'done';
});

See also:

Inheritance

Constructors

GuiSession(ISapObject obj)

Properties

accEnhancedTabChain ↔ bool
getter/setter pair
accSymbolReplacement ↔ bool
getter/setter pair
activeWindow → GuiMainWindow?
no setter
busy → bool
no setter
children → GuiComponentCollection<GuiComponent>
no setterinherited
containerType → bool
no setterinherited
errorList → dynamic
no setter
handle → int
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
id → String
no setterinherited
info → GuiSessionInfo
no setter
isActive → bool
no setter
isListBoxActive → bool
no setter
listBoxCurrEntry → int
no setter
listBoxCurrEntryHeight → int
no setter
listBoxCurrEntryLeft → int
no setter
listBoxCurrEntryTop → int
no setter
listBoxCurrEntryWidth → int
no setter
listBoxHeight → int
no setter
listBoxLeft → int
no setter
listBoxTop → int
no setter
listBoxWidth → int
no setter
name → String
no setterinherited
obj → ISapObject
finalinherited
parent → GuiComponent?
no setterinherited
passportPreSystemId ↔ String
getter/setter pair
passportSystemId ↔ String
getter/setter pair
passportTransactionId ↔ String
getter/setter pair
progressPercent → int
no setter
progressText → String
no setter
record ↔ bool
getter/setter pair
recordFile ↔ String
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
saveAsUnicode ↔ bool
getter/setter pair
showDropdownKeys ↔ bool
getter/setter pair
suppressBackendPopups ↔ bool
getter/setter pair
testToolMode ↔ int
getter/setter pair
type → String
no setterinherited
typeAsNumber → int
no setterinherited

Methods

asStdNumberFormat(String number) → String
clearErrorList() → void
createSession() → void
enableJawsEvents() → void
endTransaction() → void
findBarChart(String id, {bool raise = true}) → GuiBarChart?
inherited
findBox(String id, {bool raise = true}) → GuiBox?
inherited
findButton(String id, {bool raise = true}) → GuiButton?
inherited
findById(String id, {bool raise = true}) → ISapObject?
inherited
findByPosition(int x, int y, {bool raise = true}) → List<String>
findCalendar(String id, {bool raise = true}) → GuiCalendar?
inherited
findChart(String id, {bool raise = true}) → GuiChart?
inherited
findCheckBox(String id, {bool raise = true}) → GuiCheckBox?
inherited
findComboBox(String id, {bool raise = true}) → GuiComboBox?
inherited
findComboBoxControl(String id, {bool raise = true}) → GuiComboBoxControl?
inherited
findComboBoxEntry(String id, {bool raise = true}) → GuiComboBoxEntry?
inherited
findComponent(String id, {bool raise = true}) → GuiComponent?
inherited
findContainerShell(String id, {bool raise = true}) → GuiContainerShell?
inherited
findCTextField(String id, {bool raise = true}) → GuiCTextField?
inherited
findCustomControl(String id, {bool raise = true}) → GuiCustomControl?
inherited
findDialogShell(String id, {bool raise = true}) → GuiDialogShell?
inherited
findDockShell(String id, {bool raise = true}) → GuiDockShell?
inherited
findEAIViewer2D(String id, {bool raise = true}) → GuiEAIViewer2D?
inherited
findEAIViewer3D(String id, {bool raise = true}) → GuiEAIViewer3D?
inherited
findFrameWindow(String id, {bool raise = true}) → GuiFrameWindow?
inherited
findGOSShell(String id, {bool raise = true}) → GuiGOSShell?
inherited
findGridView(String id, {bool raise = true}) → GuiGridView?
inherited
findHTMLViewer(String id, {bool raise = true}) → GuiHTMLViewer?
inherited
findInputFieldControl(String id, {bool raise = true}) → GuiInputFieldControl?
inherited
findLabel(String id, {bool raise = true}) → GuiLabel?
inherited
findMainWindow(String id, {bool raise = true}) → GuiMainWindow?
inherited
findMenu(String id, {bool raise = true}) → GuiMenu?
inherited
findMenuBar(String id, {bool raise = true}) → GuiMenuBar?
inherited
findMessageWindow(String id, {bool raise = true}) → GuiMessageWindow?
inherited
findNetChart(String id, {bool raise = true}) → GuiNetChart?
inherited
findOfficeIntegration(String id, {bool raise = true}) → GuiOfficeIntegration?
inherited
findOkCodeField(String id, {bool raise = true}) → GuiOkCodeField?
inherited
findPicture(String id, {bool raise = true}) → GuiPicture?
inherited
findRadioButton(String id, {bool raise = true}) → GuiRadioButton?
inherited
findSapChart(String id, {bool raise = true}) → GuiSapChart?
inherited
findScrollBar(String id, {bool raise = true}) → GuiScrollbar?
inherited
findScrollContainer(String id, {bool raise = true}) → GuiScrollContainer?
inherited
findShell(String id, {bool raise = true}) → GuiShell?
inherited
findSimpleContainer(String id, {bool raise = true}) → GuiSimpleContainer?
inherited
findSplitterContainer(String id, {bool raise = true}) → GuiSplitterContainer?
inherited
findSplitterShell(String id, {bool raise = true}) → GuiSplit?
inherited
findStage(String id, {bool raise = true}) → GuiStage?
inherited
findStatusbar(String id, {bool raise = true}) → GuiStatusbar?
inherited
inherited
findStatusPane(String id, {bool raise = true}) → GuiStatusPane?
inherited
findTab(String id, {bool raise = true}) → GuiTab?
inherited
findTableControl(String id, {bool raise = true}) → GuiTableControl?
inherited
findTabStrip(String id, {bool raise = true}) → GuiTabStrip?
inherited
findTextedit(String id, {bool raise = true}) → GuiTextedit?
inherited
findTextField(String id, {bool raise = true}) → GuiTextField?
inherited
findTitlebar(String id, {bool raise = true}) → GuiTitlebar?
inherited
findToolbar(String id, {bool raise = true}) → GuiToolbar?
inherited
findToolbarControl(String id, {bool raise = true}) → GuiToolbarControl?
inherited
findTree(String id, {bool raise = true}) → GuiTree?
inherited
findUserArea(String id, {bool raise = true}) → GuiUserArea?
inherited
findVHViewSwitch(String id, {bool raise = true}) → GuiVHViewSwitch?
inherited
getIconResourceName(String iconText) → String
getObjectTree(String id, {List<String> properties = const []}) → String
getVKeyDescription(int vkey) → String
lockSessionUI() → void
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
sendCommand(String command) → void
sendCommandAsync(String command) → void
sendVKey(int vkey) → void
startTransaction(String tcode) → void
toString() → String
A string representation of this object.
inherited
unlockSessionUI() → void

Operators

operator ==(Object other) → bool
The equality operator.
inherited