GuiContainer class

Base class for all SAP GUI containers.

Extends GuiComponent with children (a typed GuiComponentCollection) and 40+ type-safe find*() methods to locate child elements by their SAP GUI ID string.

Each finder validates the element type at runtime (raising an exception or returning null depending on the raise parameter), catching mismatches between SAP IDs and expected component types early.

Finding elements

// Safe — returns null if not found or wrong type (raise: false is default for typed finders)
GuiButton? btn = session.findButton('wnd[0]/tbar[0]/btn[0]');
btn?.press();

// Strict — throws on type mismatch or not found
GuiButton btn = session.findButton('wnd[0]/tbar[0]/btn[0]', raise: true);

// Any element by ID (returns ISapObject, no type check)
ISapObject? elem = container.findById('wnd[0]/usr/cntlSHELL');

Available finders

findButton, findCTextField, findTextField, findCheckBox, findComboBox, findGridView, findTableControl, findTableRow, findTableColumn, findTree, findToolbar, findToolbarControl, findStatusbar, findTitlebar, findMenu, findMenuBar, findMainWindow, findFrameWindow, findCalendar, findChart, findBarChart, findSapChart, findHTMLViewer, findPicture, findScrollBar, findTab, findTabStrip, findLabel, findRadioButton, findStatusPane, findShell, findBox, findContainerShell, findCustomControl, findSimpleContainer, findScrollContainer, findSplitterContainer, findUserArea, findDialogShell, findDockShell, findStage, findTextedit, findComboBoxEntry, findComboBoxControl, findEAIViewer2D, findEAIViewer3D, findGOSShell, findInputFieldControl, findNetChart, findOfficeIntegration, findOkCodeField, findSplitterShell, findStatusbarLink, findVHViewSwitch, findMessageWindow, findModalWindow, findComponent.

Inheritance

Object
GuiComponent
GuiContainer

Implementers

Constructors

GuiContainer(ISapObject obj)

Properties

children → GuiComponentCollection<GuiComponent>: no setter
containerType → bool: no setterinherited
handle → int: no setterinherited
hashCode → int: The hash code for this object.
no setterinherited
id → String: no setterinherited
name → String: no setterinherited
obj → ISapObject: finalinherited
parent → GuiComponent?: no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
type → String: no setterinherited
typeAsNumber → int: no setterinherited

Methods

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

Operators

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