UFT Pro (LeanFT) .NET SDK Reference, Version 14.03
IGuiSession Interface
A SAP GUI for Windows session.
Syntax
Public Properties
 NameDescription
 PropertyActiveWindowThe name of the window that has focus.  
 PropertyApplicationServerThe name of the application server. Applies only when the connection specifies an application server and is not using load balancing.  
 PropertyClientThe client selected on the login screen.  
 PropertyCodePageThe code page for this session.  
 PropertyDisplayNameThe object display name defined in the Application Model. (Inherited from HP.LFT.SDK.ITestObject)
 PropertyFlushesThe number of flushes or passes of data during server communication to the client.  
 PropertyGroupLogin group information. Applies only when connection is using load balancing.  
 PropertyIdThe session's unique identifier in text format.  
 PropertyInterpretationTimeThe time, in milliseconds, it takes for the client to interpret the information received from the server.  
 PropertyLanguageThe language the user is working in.  
 PropertyMessageServerThe name of the message server. Applies only when connection is using load balancing.  
 PropertyNameThe name of the session.  
 PropertyNativeObjectReturns 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)
 PropertyParentThe 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)
 PropertyProgramThe name of the SAP source program that is executing.  
 PropertyResponseTimeThe server response time in milliseconds.  
 PropertyRoundTripsThe number of communications between client and server while the client is locked and waiting for data from the server.  
 PropertyScreenNumberThe number of the displayed screen.  
 PropertySystemNameThe name of the SAP system.  
 PropertySystemNumberThe system number. Applies only when connection specifies an application server and is not using load balancing.  
 PropertyTransactionThe transaction the user is executing.  
 PropertyTypeThe GUI component type.  
 PropertyUserThe user name.  
Top
Public Methods
 NameDescription
 MethodCloseCloses the SAP GUI for Windows session without displaying a warning message.  
 MethodDescribe<TChild>Creates a child test object of this test object. (Inherited from HP.LFT.SDK.ITestObjectDescriber)
 MethodExistsReturns true if object is detected; false if the method times out. (Inherited from HP.LFT.SDK.ITestObject)
 MethodFindChildren<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)
 MethodGetDescriptionReturns 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)
 MethodGetSnapshotCaptures a bitmap of this test object and returns a System.Drawing.Image of it. (Inherited from HP.LFT.SDK.ITestObject)
 MethodGetTextLocationsReturns all rectangle areas containing the specified text within this object (Windows only). (Inherited from HP.LFT.SDK.ITestObject)
 MethodGetVisibleTextReturns all visible text from this object. (Inherited from HP.LFT.SDK.ITestObject)
 MethodHighlightHighlights this object in the AUT. (Inherited from HP.LFT.SDK.ITestObject)
 MethodHighlightMatches<TChild>Highlights all children that match the specified test object type and description filter. (Inherited from HP.LFT.SDK.ITestObject)
 MethodResetOverloaded. Navigates to the session's initial screen or to the specified transaction.  
 MethodSetDescriptionReplaces this test object's description with the supplied description. (Inherited from HP.LFT.SDK.ITestObject)
 MethodSyncOverloaded. Suspends execution until the session is available.  
 MethodVerifyImageExistsChecks whether a snapshot of this object contains the supplied image. (Inherited from HP.LFT.SDK.ITestObject)
 MethodVerifyImageMatchChecks 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