Open topic with navigation

IGuiSession Interface
A SAP GUI for Windows session.

C# Syntax

    public interface IGuiSession : HP.LFT.SDK.ISupportsNativeObject, HP.LFT.SDK.ITestObject, HP.LFT.SDK.ITestObjectDescriber

Public Properties

| Name | Description
--- | --- | ---
| ActiveWindow | The name of the window that has focus.
| ApplicationServer | The name of the application server. Applies only when the connection specifies an application server and is not using load balancing.
| Client | The client selected on the login screen.
| CodePage | The code page for this session.
| DisplayName | The object display name defined in the Application Model. (Inherited from HP.LFT.SDK.ITestObject)
| Flushes | The number of flushes or passes of data during server communication to the client.
| Group | Login group information. Applies only when connection is using load balancing.
| Id | The session's unique identifier in text format.
| InterpretationTime | The time, in milliseconds, it takes for the client to interpret the information received from the server.
| Language | The language the user is working in.
| MessageServer | The name of the message server. Applies only when connection is using load balancing.
| Name | The name of the session.
| NativeObject | Returns the native application object that is represented by this test object instance, enabling you to access the native properties and methods provided by that object. (Inherited from HP.LFT.SDK.ISupportsNativeObject)
| Parent | The parent test object of this test object. The child object must be obtained using the Describe method, otherwise, it returns null. (Inherited from HP.LFT.SDK.ITestObject)
| Program | The name of the SAP source program that is executing.
| ResponseTime | The server response time in milliseconds.
| RoundTrips | The number of communications between client and server while the client is locked and waiting for data from the server.
| ScreenNumber | The number of the displayed screen.
| SystemName | The name of the SAP system.
| SystemNumber | The system number. Applies only when connection specifies an application server and is not using load balancing.
| Transaction | The transaction the user is executing.
| Type | The GUI component type.
| User | The user name.

Top
Public Methods

| Name | Description
--- | --- | ---
| Close | Closes the SAP GUI for Windows session without displaying a warning message.
| Describe<TChild> | Creates a child test object of this test object. (Inherited from HP.LFT.SDK.ITestObjectDescriber)
| Exists | Returns true if object is detected; false if the method times out. (Inherited from HP.LFT.SDK.ITestObject)
| FindChildren<TChild> | Returns all the child test objects that match the specified test object type and description filter. For example, you can use this method to retrieve all Web buttons on a Page with type="submit". (Inherited from HP.LFT.SDK.ITestObject)
| GetDescription | Returns a clone of the description for this test object. The test object must be obtained using the Describe method, otherwise, this method returns null. (Inherited from HP.LFT.SDK.ITestObject)
| GetSnapshot | Captures a bitmap of this test object and returns a System.Drawing.Image of it. (Inherited from HP.LFT.SDK.ITestObject)
| GetTextLocations | Returns all rectangle areas containing the specified text within this object (Windows only). (Inherited from HP.LFT.SDK.ITestObject)
| GetVisibleText | Returns all visible text from this object. (Inherited from HP.LFT.SDK.ITestObject)
| Highlight | Highlights this object in the AUT. (Inherited from HP.LFT.SDK.ITestObject)
| HighlightMatches<TChild> | Highlights all children that match the specified test object type and description filter. (Inherited from HP.LFT.SDK.ITestObject)
| Reset | Overloaded. Navigates to the session's initial screen or to the specified transaction.
| SetDescription | Replaces this test object's description with the supplied description. (Inherited from HP.LFT.SDK.ITestObject)
| Sync | Overloaded. Suspends execution until the session is available.
| VerifyImageExists | Checks whether a snapshot of this object contains the supplied image. (Inherited from HP.LFT.SDK.ITestObject)
| VerifyImageMatch | Checks whether a snapshot of this object and the supplied image are a match, given the specified pixel and RGB tolerance values. (Inherited from HP.LFT.SDK.ITestObject)

Top