Enum sap_scripting::types::SAPComponent

pub enum SAPComponent {
    GuiAbapEditor(GuiVComponent),
    GuiApoGrid(GuiVComponent),
    GuiApplication(GuiApplication),
    GuiBarChart(GuiVComponent),
    GuiBox(GuiVComponent),
    GuiButton(GuiButton),
    GuiCalendar(GuiVComponent),
    GuiChart(GuiVComponent),
    GuiCheckBox(GuiVComponent),
    GuiColorSelector(GuiVComponent),
    GuiComboBox(GuiVComponent),
    GuiComboBoxControl(GuiVComponent),
    GuiComboBoxEntry(GuiVComponent),
    GuiComponent(GuiComponent),
    GuiContainer(GuiVComponent),
    GuiContainerShell(GuiVComponent),
    GuiCTextField(GuiVComponent),
    GuiCustomControl(GuiVComponent),
    GuiDialogShell(GuiVComponent),
    GuiEAIViewer2D(GuiVComponent),
    GuiEAIViewer3D(GuiVComponent),
    GuiFrameWindow(GuiFrameWindow),
    GuiGOSShell(GuiVComponent),
    GuiGraphAdapt(GuiVComponent),
    GuiGridView(GuiVComponent),
    GuiHTMLViewer(GuiVComponent),
    GuiInputFieldControl(GuiVComponent),
    GuiLabel(GuiVComponent),
    GuiMainWindow(GuiFrameWindow),
    GuiMap(GuiVComponent),
    GuiMenu(GuiVComponent),
    GuiMenubar(GuiVComponent),
    GuiModalWindow(GuiVComponent),
    GuiNetChart(GuiVComponent),
    GuiOfficeIntegration(GuiVComponent),
    GuiOkCodeField(GuiOkCodeField),
    GuiPasswordField(GuiVComponent),
    GuiPicture(GuiVComponent),
    GuiRadioButton(GuiVComponent),
    GuiSapChart(GuiVComponent),
    GuiScrollbar(GuiVComponent),
    GuiScrollContainer(GuiVComponent),
    GuiShell(GuiVComponent),
    GuiSimpleContainer(GuiVComponent),
    GuiSplit(GuiVComponent),
    GuiSplitterContainer(GuiVComponent),
    GuiStage(GuiVComponent),
    GuiStatusbar(GuiVComponent),
    GuiStatusPane(GuiVComponent),
    GuiTab(GuiVComponent),
    GuiTableControl(GuiVComponent),
    GuiTabStrip(GuiVComponent),
    GuiTextedit(GuiVComponent),
    GuiTitlebar(GuiVComponent),
    GuiToolbar(GuiVComponent),
    GuiTree(GuiVComponent),
    GuiUserArea(GuiVComponent),
    GuiVComponent(GuiVComponent),
    GuiVContainer(GuiVComponent),
    GuiVHViewSwitch(GuiVComponent),
}

SAPComponent wraps around all of the GuiComponent types, allowing a more Rust-y way of exporing components.

Variants

GuiAbapEditor(GuiVComponent)

The GuiAbapEditor object represents the new ABAP editor control available as of SAP_BASIS release 6.20 (see also SAP Note 930742). GuiAbapEditor extends GuiShell.

GuiApoGrid(GuiVComponent)

The GuiApoGrid is an object specifically created for SAP SCM applications. It implements a planning board, which is similar to a GuiGridView control. GuiApoGrid extends GuiShell.

GuiApplication(GuiApplication)

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.

GuiBarChart(GuiVComponent)

The GuiBarChart is a powerful tool to display and modify time scale diagrams.

GuiBox(GuiVComponent)

A GuiBox is a simple frame with a name (also called a “Group Box”). The items inside the frame are not children of the box. The type prefix is “box”.

GuiButton(GuiButton)

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.

GuiCalendar(GuiVComponent)

The calendar control can be used to select single dates or periods of time. GuiCalendar extends the GuiShell Object.

GuiChart(GuiVComponent)

The GuiChart object is of a very technical nature. It should only be used for recording and playback, as most of the parameters cannot be determined in any other way.

GuiCheckBox(GuiVComponent)

GuiCheckBox extends the GuiVComponent Object. The type prefix is chk, the name is the fieldname taken from the SAP data dictionary.

GuiColorSelector(GuiVComponent)

GuiColorSelector displays a set of colors for selection. It extends the GuiShell Object.

GuiComboBox(GuiVComponent)

The GuiComboBox looks somewhat similar to GuiCTextField, but has a completely different implementation. While pressing the combo box button of a GuiCTextField will open a new dynpro or control in which a selection can be made, GuiComboBox retrieves all possible choices on initialization from the server, so the selection is done solely on the client. GuiComboBox extends the GuiVComponent Object. The type prefix is cmb, the name is the fieldname taken from the SAP data dictionary. GuiComboBox inherits from the GuiVComponent Object.

GuiComboBoxControl(GuiVComponent)

GuiComboBoxEntry(GuiVComponent)

Members of the Entries collection of a GuiComboBox are of type GuiComBoxEntry.

GuiComponent(GuiComponent)

GuiComponent is the base class for most classes in the Scripting API. It was designed to allow generic programming, meaning you can work with objects without knowing their exact type.

GuiContainer(GuiVComponent)

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.

GuiContainerShell(GuiVComponent)

A GuiContainerShell is a wrapper for a set of the GuiShell Object. GuiContainerShell extends the GuiVContainer Object. The type prefix is shellcont, the name is the last part of the id, shellcont[n].

GuiCTextField(GuiVComponent)

If the cursor is set into a text field of type GuiCTextField a combo box button is displayed to the right of the text field. Pressing this button is equivalent to pressing the F4 key. The button is not represented in the scripting object model as a separate object; it is considered to be part of the text field.

There are no other differences between GuiTextField and GuiCTextField. GuiCTextField extends the GuiTextField. The type prefix is ctxt, the name is the Fieldname taken from the SAP data dictionary.

GuiCustomControl(GuiVComponent)

The GuiCustomControl is a wrapper object that is used to place ActiveX controls onto dynpro screens. While GuiCustomControl is a dynpro element itself, its children are of GuiContainerShell type, which is a container for controls. GuiCustomControl extends the GuiVContainer Object. The type prefix is cntl, the name is the fieldname taken from the SAP data dictionary.

GuiDialogShell(GuiVComponent)

The GuiDialogShell is an external window that is used as a container for other shells, for example a toolbar. GuiDialogShell extends the GuiVContainer Object. The type prefix is shellcont, the name is the last part of the id, shellcont[n].

GuiEAIViewer2D(GuiVComponent)

The GuiEAIViewer2D control is used to view 2-dimensional graphic images in the SAP system. The user can carry out redlining over the loaded image. The scripting wrapper for this control records all user actions during the redlining process and reproduces the same actions when the recorded script is replayed.

GuiEAIViewer3D(GuiVComponent)

The GuiEAIViewer3D control is used to view 3-dimensional graphic images in the SAP system.

GuiFrameWindow(GuiFrameWindow)

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.

GuiGOSShell(GuiVComponent)

The GuiGosShell is only available in New Visual Design mode. GuiGOSShell extends the GuiVContainer Object. The type prefix is shellcont, the name is the last part of the id, shellcont[n].

GuiGraphAdapt(GuiVComponent)

For the graphic adapter control only basic members from GuiShell are available. Recording and playback is not possible.

GuiGridView(GuiVComponent)

The grid view is similar to the dynpro table control, but significantly more powerful. GuiGridView extends the GuiShell Object.

GuiHTMLViewer(GuiVComponent)

The GuiHTMLViewer is used to display an HTML document inside SAP GUI. GuiHTMLViewer extends the GuiShell Object.

GuiInputFieldControl(GuiVComponent)

GuiLabel(GuiVComponent)

GuiLabel extends the GuiVComponent Object. The type prefix is lbl, the name is the fieldname taken from the SAP data dictionary.

GuiMainWindow(GuiFrameWindow)

This window represents the main window of an SAP GUI session.

GuiMap(GuiVComponent)

For the map control only basic members from GuiShell are available. Recording and playback is not possible.

GuiMenu(GuiVComponent)

A GuiMenu may have other GuiMenu objects as children. GuiMenu extends the GuiVContainer Object. The type prefix is menu, the name is the text of the menu item. If the item does not have a text, which is the case for separators, then the name is the last part of the id, menu[n].

GuiMenubar(GuiVComponent)

Only the main window has a menubar. The children of the menubar are menus. GuiMenubar extends the GuiVContainer Object. The type prefix and name are mbar.

GuiModalWindow(GuiVComponent)

A GuiModalWindow is a dialog pop-up.

GuiNetChart(GuiVComponent)

The GuiNetChart is a powerful tool to display and modify entity relationship diagrams. It is of a very technical nature and should only be used for recording and playback, as most of the parameters cannot be determined in any other way.

GuiOfficeIntegration(GuiVComponent)

GuiOkCodeField(GuiOkCodeField)

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.

GuiPasswordField(GuiVComponent)

There are some differences between GuiTextField and GuiPasswordField:

• The Text and DisplayedText properties cannot be read for a password field. The returned text is always empty. During recording the password is also not saved in the recorded script.
• The properties HistoryCurEntry, HistoryCurIndex, HistoryIsActive and HistoryList are not supported, because password fields do not offer an input history
• The property IsListElement is not supported, because password fields cannot be placed on ABAP lists

GuiPicture(GuiVComponent)

The picture control displays a picture on an SAP GUI screen. GuiPicture extends the GuiShell Object.

GuiRadioButton(GuiVComponent)

GuiRadioButton extends the GuiVComponent Object. The type prefix is rad, the name is the fieldname taken from the SAP data dictionary.

GuiSapChart(GuiVComponent)

For the SAP chart control only basic members from GuiShell are available. Recording and playback is not possible.

GuiScrollbar(GuiVComponent)

The GuiScrollbar class is a utility class used for example in GuiScrollContainer or GuiTableControl.

GuiScrollContainer(GuiVComponent)

This container represents scrollable subscreens. A subscreen may be scrollable without actually having a scrollbar, because the existence of a scrollbar depends on the amount of data displayed and the size of the GuiUserArea. GuiScrollContainer extend sthe GuiVContainer Object. The type prefix is ssub, the name is generated from the data dictionary settings.

GuiShell(GuiVComponent)

GuiShell is an abstract object whose interface is supported by all the controls. GuiShell extends the GuiVContainer Object. The type prefix is shell, the name is the last part of the id, shell[n].

GuiSimpleContainer(GuiVComponent)

This container represents non-scrollable subscreens. It does not have any functionality apart from to the inherited interfaces. GuiSimpleContainer extends the GuiVContainer Object. The type prefix is sub, the name is is generated from the data dictionary settings.

GuiSplit(GuiVComponent)

GuiSplit extends the GuiShell Object.

GuiSplitterContainer(GuiVComponent)

The GuiSplitterContainer represents the dynpro splitter element, which was introduced in the Web Application Server ABAP in NetWeaver 7.1. The dynpro splitter element is similar to the activeX based splitter control, but it is a plain dynpro element.

GuiStage(GuiVComponent)

For the stage control only basic members from GuiShell are available. Recording and playback is not possible.

GuiStatusbar(GuiVComponent)

GuiStatusbar represents the message displaying part of the status bar on the bottom of the SAP GUI window. It does not include the system and login information displayed in the rightmost area of the status bar as these are available from the GuiSessionInfo object. GuiStatusbar extends the GuiVComponent Object. The type prefix is sbar.

GuiStatusPane(GuiVComponent)

The parent of the GuiStatusPane objects is the status bar (see also GuiStatusbar Object). The GuiStatusPane objects reflect the individual areas of the status bar, for example “pane[0]” refers to the section of the status bar where the messages are displayed. See also GuiStatusbar Object. The first pane of the GuiStatusBar (pane[0]) can have a child of type GuiStatusBarLink, if a service request link is displayed.

GuiTab(GuiVComponent)

The GuiTab objects are the children of a GuiTabStrip object. GuiTab extends the GuiVContainer Object. The type prefix is tabp, the name is the id of the tab’s button taken from SAP data dictionary.

GuiTableControl(GuiVComponent)

The table control is a standard dynpro element, in contrast to the GuiCtrlGridView, which looks similar. GuiTableControl extends the GuiVContainer Object. The type prefix is tbl, the name is the fieldname taken from the SAP data dictionary.

GuiTabStrip(GuiVComponent)

A tab strip is a container whose children are of type GuiTab. GuiTabStrip extends the GuiVContainer Object. The type prefix is tabs, the name is the fieldname taken from the SAP data dictionary.

GuiTextedit(GuiVComponent)

The TextEdit control is a multiline edit control offering a number of possible benefits. With regard to scripting, the possibility of protecting text parts against editing by the user is especially useful. GuiTextedit extends the GuiShell Object.

GuiTitlebar(GuiVComponent)

The titlebar is only displayed and exposed as a separate object in New Visual Design mode. GuiTitlebar extends the GuiVContainer Object. The type prefix and name of GuiTitlebar are titl.

GuiToolbar(GuiVComponent)

Every GuiFrameWindow has a GuiToolbar. The GuiMainWindow has two toolbars unless the second has been turned off by the ABAP application. In classical SAP GUI themes, the upper toolbar is called “system toolbar” or “GUI toolbar” , while the second toolbar is called “application toolbar”. In SAP GUI themes as of Belize and in integration scenarios (like embedded into SAP Business Client), only a single toolbar (“merged toolbar“) is displayed. Additionally, a footer also containing buttons originally coming from the system or application toolbar may be displayed.

GuiTree(GuiVComponent)

A Tree view.

GuiUserArea(GuiVComponent)

The GuiUserArea comprises the area between the toolbar and status bar for windows of GuiMainWindow type and the area between the titlebar and toolbar for modal windows, and may also be limited by docker controls. The standard dynpro elements can be found only in this area, with the exception of buttons, which are also found in the toolbars.

GuiVComponent(GuiVComponent)

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.

GuiVContainer(GuiVComponent)

An object exposes the GuiVContainer interface if it is both visible and can have children. It will then also expose GuiComponent and GuiVComponent. Examples of this interface are windows and subscreens, toolbars or controls having children, such as the splitter control. GuiVContainer extends the GuiContainer Object and the GuiVComponent Object.

GuiVHViewSwitch(GuiVComponent)

GuiVHViewSwitch represents the “View Switch” object that was introduced with the Belize theme in SAP GUI. The View Switch is placed in the header area of the SAP GUI main window and can be used to select different views within an application. Many screens can be displayed in different ways (for example, as a tree or list). To switch from one view to another in a comfortable way, these screens may make use of the View Switch:

Trait Implementations

impl From<GuiComponent> for SAPComponent

fn from(value: GuiComponent) -> Self

Converts to this type from the input type.