HP.LFT.SDK Namespace

Provides the SDK for core LeanFT functionality.
Classes
  Class Description
Class AppModelBase Base class of all generated Application Model classes.
Class AppModelNodeBase<T,TDescription> Base class for all container sub-classes generated under the Application Model class.
Class As The class used to support regular expressions.
Class Base64ImageStringConverter Class used to convert System.Drawing.Image images to base-64 stream representations and vice versa.
Class ClickArgs A structure defining operations that can be specified in a Click operation.
Class DateRange A range of dates used for month calendar controls that support multi-selection.
Class Description The base class for all Description classes that support the index and Visual Relation Identifier (VRI) test object properties.
Class DescriptionException Exceptions raised when errors are encountered in the description of a test object.
Class Desktop A top-level Window or Dialog test object.
Class DesktopEnvironment Desktop environment class
Class DragAndDropArgs Class defining the behavior for drag and drop operations.
Class EmptySessionIdException The exception that is thrown when the LeanFT runtime engine receives an empty session ID.
Class FunctionKeys Supplies constants representing the Function keyboard keys(F1-F12), which can be used in the input parameter string of the ISupportSendKeys.SendKeys method.
Class GeneralLeanFtException Represents general errors that occur when working with LeanFT.
Class GeneralReplayException Represents general errors that occur when running a LeanFT testing project.
Class GeneralServerErrorException Represents general errors that occur in the LeanFT runtime engine.
Class InvalidAgentException The exception that is thrown when the LeanFT runtime engine receives a message with an invalid agent field value.
Class InvalidFormatException The exception that is thrown when the LeanFT runtime engine receives a message with an invalid format.
Class InvalidMessageFieldException The exception that is thrown when the LeanFT runtime engine receives a message with an invalid field value.
Class InvalidVersionException The exception that is thrown when the LeanFT runtime engine receives a message with an invalid version.
Class Keyboard A class that enables low-level keyboard device operations.
Class Keys Supplies constants representing keyboard keys, which can be used in the input parameter string of the ISupportSendKeys.SendKeys method.
Class LabNotConnectedException The exception that is thrown when the LeanFT runtime engine is not connected to the expected Lab.
Class Location Provides a location (relative to an object in the application) for operations that support it. For example, the Click method uses the Location structure to determine where inside this object to perform the click.
Class LocationProperty Class for defining a test object's location property.
Class MessageTypeNotSupportedException The exception that is thrown when the LeanFT runtime engine receives a message type that is not supported.
Class MobileCenterNotConnectedException The exception that is thrown when the LeanFT runtime engine is not connected to mobile center.
Class Mouse A class that enables low-level mouse device operations.
Class ObjectCookieNotFoundException The exception that is thrown when a test object cookie is not found in the LeanFT runtime engine.
Class PropertiesDescription The base of all test object descriptions. It is a collection of properties and values.
Class RegExpProperty The class used for regular expression properties.
Class ReplayArgumentOutOfRangeException The exception that is thrown when a method argument value is outside the valid value range for the method.
Class ReplayBrowserNotInstalledException The exception that is thrown when the specified browser type is not installed on the machine running the test.
Class ReplayItemNotFoundException The exception that is thrown when an item of the object in the current step is not found in the AUT.
Class ReplayItemNotUniqueException The exception that is thrown when an item of the object in the current step can't be uniquely identified in the AUT.
Class ReplayObjectDisabledException The exception that is thrown when the object in the current step is disabled in the AUT.
Class ReplayObjectNotFoundException The exception that is thrown when an object with the specified test object description is not found in the AUT.
Class ReplayObjectNotUniqueException The exception that is thrown when a test object's description is not sufficient to uniquely identify an object in the AUT.
Class ReplayObjectNotVisibleException The exception that is thrown when an object with the specified test object description is not visible in the AUT.
Class ReplayParentMissingException The exception that is thrown when a parent of the test object in the current step is not found in the AUT.
Class ReplayTimeoutException The exception that is thrown when a timeout occurs while attempting to run a step.
Class ScrollProperty The class used for scrollbar properties.
Class SDK The LeanFT SDK base class.
Class SdkConfiguration Class for defining the SDK configuration information. This class is supplied for the SDK.SDK.Init method.
Class ServerAlreadyInRecordModeException The exception that is thrown when the LeanFT engine receives a start record request when it is already in record mode.
Class ServerIsShuttingDownException The exception that is thrown when an attempt to access the LeanFT runtime engine occurs while the engine is shutting down.
Class SessionNotFoundExceptionException The exception that is thrown when the LeanFT runtime engine receives an unknown session ID.
Class SizeProperty The size properties of a test object.
Class SrfLab This class can be used to launch browsers or lock devices in the SRF lab.
Class StringProperty The class used for string properties.
Class TechnologyNotSupportedException The exception that is thrown when a technology is not supported.
Class TestObjectExtensions Class for extension methods of the TestObject class
Class TopLevelObjectNodeBase<T,TDescription> This class is used by 'Application Model Code Generator' as the base class for all container classes.
Class TypeNotRegisteredException The exception thrown when a test object type is not registered.
Class VideoData An object that holds video binary data.
Class VisualRelation Class representing Visual Relations Identifier (VRI) data. Each VisualRelation class contains a reference to a test object, and up to three possible relations: horizontal relation, vertical relation, and proximity relation.
Class VriDescriptionException Exceptions raised when errors are encountered in the VRI description of test objects.
Interfaces
  Interface Description
Interface IAut An abstraction of an AUT process launched by the user.
Interface ICalendarBase Base interface for Calendar test objects.
Interface IClickable Indicates that this object can be clicked.
Interface IDescription Interface for a class to be used as a test object description.
Interface IDoubleClickable Indicates that this object can be double-clicked.
Interface IEnabledProvider

Indicates that a test object supports the IsEnabled property.

Interface IEnvironment Base interface for AUT environments.
Interface IItemTextRepresentationProvider Provides the text representation of an item, which can be used for relevant properties of a test object description.
Interface ILocationInfoProvider Indicates that a test object supports accessing properties of its location on the screen.
Interface IMenuItemBase Base interface for all MenuItem interfaces in SDK.
Interface IScrollable Represents test objects that support scrolling.
Interface ISdkConfiguration Interface for defining the configuration information for the SDK.
Interface ISupportDragAndDrop A test object that supports drag and drop.
Interface ISupportSendKeys A test object that supports the SendKeys(String,KeyModifier) method.
Interface ISupportsNativeObject A test object that supports accessing the native application object.
Interface ITestObject Base interface for all test objects.
Interface ITestObjectDescriber Base interface for all classes that support describing test objects.
Interface ITopLevelObject A top-level test object that can be described from the Desktop, such as a StdWin, WinForms, or WPF IWindow.
Interface IUiObjectBase Base interface for all UiObjects in all technologies.
Interface IVisibleProvider

Indicates that a test object supports the IsVisible property.

Structures
  Structure Description
Structure ScrollInfo Structure representing the properties of a scroll bar.
Enumerations
  Enumeration Description
Enumeration CheckedState Check box states.
Enumeration DateFormatType Date string types.
Enumeration HorizontalVisualRelation The horizontal location of the related test object relative to the object to identify. See the LeanFT Help Center for a diagram that illustrates the way LeanFT interprets visual relations and the boundaries that are used for determining in-line related objects.
Enumeration Keyboard.Keys Keys which can be used in sending keyboards events.
Enumeration KeyModifier Represents keyboard keys that can be pressed and held down during the execution of a method, such as the SendKeys method.
Enumeration MouseButton The mouse button to use for mouse operations.
Enumeration Orientation The visual orientation of an object.
Enumeration Position Indicates the position for an offset relative to this object in the application.
Enumeration ProximityVisualRelation The distance or hierarchical location of the related test object relative to the object to identify. See the LeanFT Help Center for more details on VRI.
Enumeration ScrollOrientation Represents the scroll bar orientation.
Enumeration ScrollType The type of scrolling operation.
Enumeration SDKMode Indicates which mode the LeanFT runtime engine uses for test runs.
Enumeration SwipeDirection Swipe direction.
Enumeration VerticalScrollPosition The position of the vertical scroll bar.
Enumeration VerticalVisualRelation The vertical location of the related test object relative to the object to identify. See the LeanFT Help Center for a diagram that illustrates the way LeanFT interprets visual relations and the boundaries that are used for determining in-line related objects.
Enumeration VideoFormat Formats which can be used in VideoData construction.
Enumeration WindowExtendedStyles Extended window styles as defined in the Windows API.
Enumeration WindowState The window state.
Enumeration WindowStyles Window styles as defined in the Windows API.

See also:

HP.LFT.SDK Assembly