ISapObject class abstract interface

Abstract interface for a SAP GUI Scripting COM object handle.

Exposes the full SAP GUI Scripting object model: ~200 properties (id, name, text, type, dimensions, session info, etc.) and ~150 methods (press, select, setFocus, startTransaction, etc.).

Implement this interface (or use Mock) to unit-test GUI component wrappers without a live SAP connection.

Properties

accDescription → String: no setter
accEnhancedTabChain ↔ bool: getter/setter pair
accLabelCollection → ISapObject?: no setter
accSymbolReplacement ↔ bool: getter/setter pair
accText → String: no setter
accTextOnRequest → String: no setter
accTooltip → String: no setter
activeSession → ISapObject?: no setter
activeWindow → ISapObject?: no setter
allowSystemMessages ↔ bool: getter/setter pair
altText → String: no setter
annotationEnabled ↔ bool: getter/setter pair
annotationMode ↔ int: getter/setter pair
applicationServer → String: no setter
browserHandle → Object?: no setter
busy → bool: no setter
buttonbarVisible ↔ bool: getter/setter pair
buttonCount → int: no setter
buttonTooltip → String: no setter
caretPosition ↔ int: getter/setter pair
changeable → bool: no setter
charHeight → int: no setter
charLeft → int: no setter
chartCount → int: no setter
charTop → int: no setter
charWidth → int: no setter
children → ISapObject?: no setter
client → String: no setter
colorIndex → int: no setter
colorIntensified → bool: no setter
colorInverse → bool: no setter
colSelectMode → int: no setter
columnCount → int: no setter
columnOrder ↔ List<String>?: getter/setter pair
columns → dynamic: no setter
connectionErrorText → String: no setter
connections → ISapObject?: no setter
connectionString → String: no setter
containerType → bool: no setter
count → int: no setter
curListBoxEntry → ISapObject?: no setter
currentCellColumn ↔ String: getter/setter pair
currentCellRow ↔ int: getter/setter pair
currentCol → int: no setter
currentColumn → int: no setter
currentLine → int: no setter
currentRow → int: no setter
defaultTooltip → String: no setter
description → String: no setter
disabledByServer → bool: no setter
displayedText → String: no setter
displayMode → String: no setter
dockerIsVertical → bool: no setter
dockerPixelSize → int: no setter
document → Object?: no setter
documentComplete → int: no setter
dragDropSupported → bool: no setter
elementVisualizationMode ↔ bool: getter/setter pair
emphasized → bool: no setter
entries → ISapObject?: no setter
errorList → ISapObject?: no setter
findButtonActivated → bool: no setter
firstVisibleColumn ↔ String: getter/setter pair
firstVisibleLine ↔ int: getter/setter pair
firstVisibleRow ↔ int: getter/setter pair
fixed → bool: no setter
flushes → int: no setter
flushing → bool: no setter
focusedButton → int: no setter
focusedHorizontalSash → int: no setter
focusedVerticalSash → int: no setter
frozenColumnCount → int: no setter
gridColumnCount → int: no setter
gridRowCount → int: no setter
group → String: no setter
groupCount → int: no setter
groupMembers → ISapObject?: no setter
groupPos → int: no setter
guiCodepage → int: no setter
guiFocus → ISapObject?: no setter
handle → int: no setter
hashCode → int: The hash code for this object.
no setterinherited
height → int: no setter
helpButtonHelpText → String: no setter
helpButtonText → String: no setter
hierarchyHeaderWidth ↔ int: getter/setter pair
highlighted → bool: no setter
historyCurEntryFromInputFieldControl → String: no setter
historyCurEntryProp → String: no setter
historyCurIndexFromInputFieldControl → int: no setter
historyCurIndexProp → int: no setter
historyEnabled ↔ bool: getter/setter pair
historyIsActiveFromInputFieldControl → bool: no setter
historyIsActiveProp → bool: no setter
historyListProp → List<String>?: no setter
horizontalScrollbar → ISapObject?: no setter
hostedApplication → int: no setter
icon → String: no setter
iconic → bool: no setter
iconName → String: no setter
id → String: no setter
info → ISapObject?: no setter
isActive → bool: no setter
isHotspot → bool: no setter
isInvalid → bool: no setter
isLeftLabel → bool: no setter
isListAdapter → bool: no setter
isListBoxActive → bool: no setter
isListElement → bool: no setter
isLowSpeedConnection → bool: no setter
isOField → bool: no setter
isOTFPreview → bool: no setter
isPopupDialog ↔ bool: getter/setter pair
isRightLabel → bool: no setter
isStepLoop → bool: no setter
isStepLoopInTableStructure → bool: no setter
isSymbolFont → bool: no setter
isValid → bool: no setter
isVertical → bool: no setter
isVerticalInt → int: no setter
key ↔ String: getter/setter pair
labelText → String: no setter
language → String: no setter
lastVisibleLine → int: no setter
left → int: no setter
leftLabel → ISapObject?: no setter
leftTab → ISapObject?: no setter
length → int: no setter
lineCount → int: no setter
linkCountProperty → int: no setter
listBoxCurrEntry → int: no setter
listBoxCurrEntryHeight → int: no setter
listBoxCurrEntryLeft → int: no setter
listBoxCurrEntryTop → int: no setter
listBoxCurrEntryWidth → int: no setter
listBoxEntries → ISapObject?: no setter
listBoxHeight → int: no setter
listBoxLeft → int: no setter
listBoxTop → int: no setter
listBoxWidth → int: no setter
loopColCount → int: no setter
loopCurrentCol → int: no setter
loopCurrentColCount → int: no setter
loopCurrentRow → int: no setter
loopRowCount → int: no setter
majorVersion → int: no setter
maximum → int: no setter
maxLength → int: no setter
messageAsPopup → bool: no setter
messageHasLongText → int: no setter
messageId → String: no setter
messageNumber → String: no setter
messageOptionOk → int: no setter
messageOptionOkCancel → int: no setter
messageParameter → String: no setter
messageServer → String: no setter
messageText → String: no setter
messageType → int: no setter
messageTypeRetunString → String: no setter
minimum → int: no setter
minorVersion → int: no setter
modified ↔ bool: getter/setter pair
name → String: no setter
newVisualDesign → bool: no setter
nodeCount → int: no setter
numberOfUnprotectedTextParts → int: no setter
numerical → bool: no setter
ocxEvents → ISapObject?: no setter
okButtonText → String: no setter
opened → bool: no setter
pageSize → int: no setter
parent → ISapObject?: no setter
parentFrame → ISapObject?: no setter
passport ↔ String: getter/setter pair
passportPreSystemId ↔ String: getter/setter pair
passportSystemId ↔ String: getter/setter pair
passportTransactionId ↔ String: getter/setter pair
patchlevel → int: no setter
popupDialog ↔ String: getter/setter pair
pos → int: no setter
position ↔ int: getter/setter pair
program → String: no setter
progressPercent → int: no setter
progressText → String: no setter
promptText → String: no setter
range → int: no setter
record ↔ bool: getter/setter pair
recordFile ↔ String: getter/setter pair
recording ↔ bool: getter/setter pair
redliningStream ↔ String: getter/setter pair
required → bool: no setter
responseTime → int: no setter
revision → int: no setter
rightLabel → ISapObject?: no setter
roundTrips → int: no setter
rowCount → int: no setter
rows → ISapObject?: no setter
rowSelectMode → int: no setter
rowText → String: no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
sashPosition ↔ int: getter/setter pair
saveAsUnicode ↔ bool: getter/setter pair
screenLeft ↔ int: getter/setter pair
screenNumber → int: no setter
screenTop ↔ int: getter/setter pair
scriptingModeReadOnly → bool: no setter
selectable → bool: no setter
selected ↔ bool: getter/setter pair
selectedCells ↔ List<String>?: getter/setter pair
selectedColumns ↔ List<String>?: getter/setter pair
selectedInComboBox ↔ String: getter/setter pair
selectedNode ↔ String: getter/setter pair
selectedRows ↔ String: getter/setter pair
selectedTab → ISapObject?: no setter
selectedText → String: no setter
selectionEndColumn → int: no setter
selectionEndLine → int: no setter
selectionIndexEnd → int: no setter
selectionIndexStart → int: no setter
selectionMode → String: no setter
selectionStartColumn → int: no setter
selectionStartLine → int: no setter
sessionNumber → int: no setter
sessions → ISapObject?: no setter
shellHandle → int: no setter
showDropdownKeys ↔ bool: getter/setter pair
showKey → bool: no setter
statusbarVisible ↔ bool: getter/setter pair
subType → String: no setter
suppressBackendPopups ↔ bool: getter/setter pair
systemFocus → ISapObject?: no setter
systemName → String: no setter
systemNumber → int: no setter
systemSessionId → String: no setter
tableFieldName → String: no setter
testToolMode ↔ int: getter/setter pair
text ↔ String: getter/setter pair
title → String: no setter
titlebarVisible ↔ bool: getter/setter pair
toolbarButtonCount → int: no setter
toolbarVisible ↔ bool: getter/setter pair
tooltip → String: no setter
top ↔ int: getter/setter pair
topNode ↔ String: getter/setter pair
transaction → String: no setter
type → String: no setter
typeAsNumber → int: no setter
uiGuideline → String: no setter
url → String: no setter
user → String: no setter
utils → ISapObject?: no setter
value ↔ String: getter/setter pair
verticalScrollbar → ISapObject?: no setter
visible → bool: no setter
visibleRowCount → int: no setter
width → int: no setter
workingPaneHeight → int: no setter
workingPaneWidth → int: no setter

Methods

add(String item) → void
addHistoryEntry(String fieldName, String value) → bool
annotationTextRequest(String strText) → void
appendRow(String name, String row) → void
asStdNumberFormat(String number) → String
barCount(int chartId) → int
changeCheckbox(String nodeKey, String itemName, bool checked) → void
changeSelection(int indexPosition) → void
clearErrorList() → void
clearSelection() → void
click(int row, String col) → void
clickControlArea(int x, int y) → void
clickCurrentCell() → void
clickInPicture() → void
clickLink(String nodeKey, String itemName) → void
clickPictureArea(int x, int y) → void
close() → void
closeConnection() → void
closeDocument(int cookie, bool everChanged, bool changedAfterSave) → void
closeFile(int file) → void
closeSession(String id) → void
collapseNode(String nodeKey) → void
compBitmap(String filename1, String filename2) → int
configureLayout() → void
contextMenu() → void
contextMenuCalendar(int ctxMenuId, int ctxMenuCellRow, int ctxMenuCellCol, String dateBegin, String dateEnd) → void
contextMenuInPicture(int x, int y) → void
contextMenuInStage(String strId) → void
createGuiCollection() → ISapObject?
createSession() → void
createSupportMessageClick() → void
currentCellMoved() → void
customEvent(int cookie, String eventName, int paramCount, [String? p1, String? p2, String? p3, String? p4, String? p5, String? p6, String? p7, String? p8, String? p9, String? p10, String? p11, String? p12]) → void
defaultContextMenu() → void
deleteRows(String rows) → void
deselectAllColumns() → void
deselectColumn(String col) → void
doubleClick(int row, String col) → void
doubleClickControlArea(int x, int y) → void
doubleClickCurrentCell() → void
doubleClickInPicture() → void
doubleClickInStage(String strId) → void
doubleClickItem(String nodeKey, String itemName) → void
doubleClickNoArgs() → void
doubleClickNode(String nodeKey) → void
doubleClickPictureArea(int x, int y) → void
dropHistory() → bool
dumpState(String innerObject) → ISapObject?
duplicateRows(String rows) → void
elementAt(int index) → ISapObject?
enableJawsEvents() → void
endTransaction() → void
ensureVisibleHorizontalItem(String nodeKey, String itemName) → void
expandNode(String nodeKey) → void
findAllByName(String name, String type) → ISapObject?
findAllByNameEx(String name, int typeAsNumber) → ISapObject?
findById(String id) → ISapObject?
findByLabel(String text, String type) → ISapObject?
findByName(String name, String type) → ISapObject?
findByNameEx(String name, int typeAsNumber) → ISapObject?
findByPosition(int x, int y, {bool raise = true}) → List<String>?
fireSelected() → void
getAbsoluteRow(int index) → ISapObject?
getAllNodeKeys() → List<String>?
getBarContent(int chartId, int barId, int textId) → String
getBrowerControlType() → int
getButtonChecked(int buttonPos) → bool
getButtonEnabled(int buttonPos) → bool
getButtonIcon(int buttonPos) → String
getButtonId(int buttonPos) → String
getButtonText(int buttonPos) → String
getButtonTooltip(int buttonPos) → String
getButtonType(int buttonPos) → String
getCell(int row, int col) → ISapObject?
getCellChangeable(int row, String col) → bool
getCellCheckBoxChecked(int row, String col) → bool
getCellColor(int row, String col) → int
getCellHeight(int row, String col) → int
getCellHotspotType(int row, String col) → String
getCellIcon(int row, String col) → String
getCellLeft(int row, String col) → int
getCellListBoxCount(int row, String col) → int
getCellListBoxCurIndex(int row, String column) → String
getCellMaxLength(int row, String col) → int
getCellState(int row, String col) → String
getCellTooltip(int row, String col) → String
getCellTop(int row, String col) → int
getCellType(int row, String col) → String
getCellValue(int row, String col) → String
getCellWidth(int row, String col) → int
getCheckBoxState(String nodeKey, String itemName) → bool
getColorInfo(int color) → String
getColSize(int id) → int
getColumnDataType(String col) → String
getColumnHeaders() → List<String>?
getColumnNames() → List<String>?
getColumnOperationType(String column) → String
getColumnPosition(String col) → int
getColumnSortType(String column) → String
getColumnTitles(String column) → List<String>?
getColumnTooltip(String col) → String
getColumnTotalType(String column) → String
getDisplayedColumnTitle(String col) → String
getGridLineContent(int chartId, int gridlineId, int lineId) → String
getIconResourceName(String iconText) → String
getItemText(String key, String name) → String
getLineText(int nLine) → String
getLinkContent(int linkId, int textId) → String
getListProperty(String property) → String
getListPropertyNonRec(String property) → String
getMenuItemIdFromPosition(int pos) → String
getNodeContent(int nodeId, int textId) → String
getNodeTextByKey(String key) → String
getNodeTextByPath(String path) → String
getObjectTree(String id, {List<String> properties = const []}) → String
getRowSize(int id) → int
getRowTotalLevel(int row) → int
getSelectedNodes() → List<String>?
getSymbolInfo(String symbol) → String
getToolbarButtonChecked(int buttonPos) → bool
getToolbarButtonEnabled(int pos) → bool
getToolbarButtonIcon(int buttonPos) → String
getToolbarButtonId(int pos) → String
getToolbarButtonText(int pos) → String
getToolbarButtonTooltip(int buttonPos) → String
getToolbarButtonType(int buttonPos) → String
getToolbarFocusButton() → int
getTreeType() → int
getUnprotectedTextPart(int part) → String
getVKeyDescription(int vkey) → String
gridCount(int chartId) → int
hardCopy(String filename) → String
hardCopyToMemory() → Uint8List
hasCellF4Help(int row, String col) → bool
headerContextMenu(String headerName) → void
historyCurEntry(int row, String column) → String
historyCurIndex(int row, String column) → int
historyIsActive(int row, String column) → bool
historyList(int row, String column) → ISapObject?
iconify() → void
ignore(int windowHandle) → void
insertRows(String rows) → void
isBreakpointLine(int nLine) → bool
isCellHotspot(int row, String col) → bool
isCellSymbol(int row, String col) → bool
isCellTotalExpander(int row, String col) → bool
isColumnFiltered(String col) → bool
isColumnKey(String col) → bool
isCommentLine(int nLine) → bool
isFolder(String nodeKey) → bool
isFolderExpandable(String nodeKey) → bool
isFolderExpanded(String nodeKey) → bool
isHighlightedLine(int nLine) → bool
isProtectedLine(int nLine) → bool
isSelectedLine(int nLine) → bool
isTotalRowExpanded(int row) → bool
isVKeyAllowed(int vKey) → bool
item(int index) → ISapObject?
itemContextMenu(String nodeKey, String itemName) → void
jumpBackward() → void
jumpForward() → void
linkCount(int chartId) → int
listNavigate(String navType) → void
lockSessionUI() → void
maximize() → void
modifiedStatusChanged(bool status) → void
modifyCell(int row, String col, String value) → void
modifyCheckBox(int row, String col, bool checked) → void
moveRows(int from, int to, int dest) → void
multipleFilesDropped() → void
nodeContextMenu(String nodeKey) → void
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
openConnection(String description, {bool sync = true, bool raise = true}) → ISapObject?
openConnectionByConnectionString(String connectString, {bool sync = true, bool raise = true}) → ISapObject?
openFile(String filename) → int
press() → void
pressButton(String nodeKey, String itemName) → void
pressButtonCurrentCell() → void
pressButtonInGrid(int row, String column) → void
pressButtonToolBarControl(String id) → void
pressColumnHeader(String col) → void
pressContextButton(String id) → void
pressEnter() → void
pressF1() → void
pressF4() → void
pressKey(String key) → void
pressToolbarButton(String id) → void
pressToolbarContextButton(String id) → void
pressTotalRow(int row, String col) → void
pressTotalRowCurrentCell() → void
registerROT() → bool
release() → void
removeContent(String name) → void
reorderTable(String permutation) → void
resizeWorkingPane(int width, int height, bool throwOnFail) → void
resizeWorkingPaneEx(int width, int height, bool throwOnFail) → void
restore() → void
revokeROT() → void
sapEvent(String frameName, String postData, String url) → void
saveDocument(int cookie, bool changed) → void
scrollToLeft() → void
select() → void
selectAll() → void
selectAllColumns() → void
selectColumn(String col) → void
selectContextMenuItem(String functionCode) → void
selectContextMenuItemByPosition(String positionDesc) → void
selectContextMenuItemByText(String text) → void
selectionChanged() → void
selectItem(String nodeKey, String itemName) → void
selectItemsInStage(String strItems) → void
selectMenuItem(String id) → void
selectMenuItemByText(String text) → void
selectNode(String nodeKey) → void
selectToolbarMenuItem(String id) → void
sendCommand(String command) → void
sendCommandAsync(String command) → void
sendData(String data) → void
sendVKey(int vkey) → void
serviceRequestClick() → void
setColSize(int id, int size) → void
setColumnWidth(String col, int width) → void
setCurrentCell(int row, String col) → void
setDocument(int index, String document) → void
setFocus() → void
setKeySpace() → void
setRowSize(int id, int size) → void
setSelectionIndexes(int start, int end) → void
setUnprotectedTextPart(int part, String text) → bool
showMessageBox(String title, String text, int msgIcon, int msgType) → int
singleFileDropped(String filename) → void
startTransaction(String tcode) → void
submit() → void
tabBackward() → void
tabForward() → void
toString() → String: A string representation of this object.
inherited
triggerModified() → void
unlockSessionUI() → void
unselectAll() → void
unselectNode(String nodeKey) → void
valueChange(int series, int point, String xValue, String yValue, bool dataChange, String id, String zValue, int changeFlag) → void
visualize(bool on, String innerObject) → int
write(int file, String text) → void
writeLine(int file, String text) → void

Operators

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

ISapObject class abstract interface

Properties

Methods

Operators

i_sap_object library