Module sap_scripting::types
source · Expand description
The types from this library.
Structs
- The GuiApplication represents the process in which all SAP GUI activity takes place. If the scripting component is accessed by attaching to an SAP Logon process, then GuiApplication will represent SAP Logon. GuiApplication is a creatable class. However, there must be only one component of this type in any process. GuiApplication extends the GuiContainer Object.
- GuiButton represents all push buttons that are on dynpros, the toolbar or in table controls. GuiButton extends the GuiVComponent Object. The type prefix is btn, the name property is the fieldname taken from the SAP data dictionary There is one exception: For tabstrip buttons, it is the button id set in screen painter that is taken from the SAP data dictionary.
- This interface resembles GuiVContainer. The only difference is that it is not intended for visual objects but rather administrative objects such as connections or sessions. Objects exposing this interface will therefore support GuiComponent but not GuiVComponent. GuiContainer extends the GuiComponent Object.
- A GuiConnection represents the connection between SAP GUI and an application server. Connections can be opened from SAP Logon or from GuiApplication’s openConnection and openConnectionByConnectionString methods. GuiConnection extends the GuiContainer Object. The type prefix for GuiConnection is con, the name is con plus the connection number in square brackets.
- A GuiFrameWindow is a high level visual object in the runtime hierarchy. It can be either the main window or a modal popup window. See the GuiMainWindow and GuiModalWindow sections for examples. GuiFrameWindow itself is an abstract interface. GuiFrameWindow extends the GuiVContainer Object. The type prefix is wnd, the name is wnd plus the window number in square brackets.
- The GuiOkCodeField is placed on the upper toolbar of the main window. It is a combo box into which commands can be entered. Setting the text of GuiOkCodeField will not execute the command until server communication is started, for example by emulating the Enter key (VKey 0). GuiOkCodeField extends the GuiVComponent Object. The type prefix is okcd, the name is empty.
- The GuiSession provides the context in which a user performs a certain task such as working with a transaction. It is therefore the access point for applications, which record a user’s actions regarding a specific task or play back those actions. GuiSession extends GuiContainer. The type prefix is ses, the name is ses plus the session number in square brackets.
- The GuiVComponent interface is exposed by all visual objects, such as windows, buttons or text fields. Like GuiComponent, it is an abstract interface. Any object supporting the GuiVComponent interface also exposes the GuiComponent interface. GuiVComponent extends the GuiComponent Object.
- A wrapper over the SAP scripting engine, equivalent to CSapROTWrapper.
Enums
- SAPComponent wraps around all of the GuiComponent types, allowing a more Rust-y way of exporing components.