Open topic with navigation

com.hp.lft.sdk.winforms

## Interface PropertyGrid

- All Superinterfaces:
    Clickable, DoubleClickable, LocationInfoProvider, SupportDragAndDrop, SupportSendKeys, SupportsNativeObject, TestObject, TestObjectDescriber, UiObjectBase, VisibleProvider, WaitUntilVisibleProvider, WaitUntilEnabledProvider, EnabledProvider

      public interface PropertyGrid
      extends UiObjectBase, TestObject

  A property grid control based on the .NET Windows Forms library.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `getAttachedText()` Returns the static text attached to this control.
    `java.lang.String` | `getErrorText()` Returns the tooltip text of the error icon associated with this object.
    `<T> T` | `getPropertyValue(java.lang.String propertyPath, java.lang.Class<T> type)` Returns value of the specified property in this property grid control. This method is supported only for String, Boolean and Numeric types.
    `void` | `selectProperty(java.lang.String propertyPath)` Selects the specified property in the property grid control.
    `<T> void` | `setPropertyValue(java.lang.String propertyPath, T newPropertyValue)` Sets the value of the specified property in the property grid control. Applicable only to a simple value.

    - ### Methods inherited from interface com.hp.lft.sdk.winforms.UiObjectBase

      `fireEvent, getFullNamePath, getFullType, getObjectName, getObjectProperty, getText, getWindowClassRegExp, getWindowId, isChildWindow, isOwnedWindow`

    - ### Methods inherited from interface com.hp.lft.sdk.UiObjectBase

      `getHandle, getNativeClass, getWindowTitleRegExp, isEnabled, isFocused, isVisible, mouseMove`

    - ### Methods inherited from interface com.hp.lft.sdk.Clickable

      `click, click, click`

    - ### Methods inherited from interface com.hp.lft.sdk.DoubleClickable

      `doubleClick, doubleClick, doubleClick`

    - ### Methods inherited from interface com.hp.lft.sdk.LocationInfoProvider

      `getAbsoluteLocation, getLocation, getSize`

    - ### Methods inherited from interface com.hp.lft.sdk.SupportSendKeys

      `sendKeys, sendKeys`

    - ### Methods inherited from interface com.hp.lft.sdk.SupportDragAndDrop

      `dragAndDropOn, dragAndDropOn`

    - ### Methods inherited from interface com.hp.lft.sdk.SupportsNativeObject

      `getNativeObject`

    - ### Methods inherited from interface com.hp.lft.sdk.TestObject

      `exists, exists, findChildren, getDescription, getDisplayName, getParent, getSnapshot, getTextLocations, getTextLocations, getVisibleText, getVisibleText, highlight, highlightMatches, setDescription, setDisplayName, verifyImageExists, verifyImageExists, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, waitUntilExists, waitUntilExists`

    - ### Methods inherited from interface com.hp.lft.sdk.TestObjectDescriber

      `describe`

    - ### Methods inherited from interface com.hp.lft.sdk.WaitUntilEnabledProvider

      `waitUntilEnabled, waitUntilEnabled`

    - ### Methods inherited from interface com.hp.lft.sdk.EnabledProvider

      `isEnabled`

    - ### Methods inherited from interface com.hp.lft.sdk.WaitUntilVisibleProvider

      `waitUntilVisible, waitUntilVisible`

    - ### Methods inherited from interface com.hp.lft.sdk.VisibleProvider

      `isVisible`

- - ### Method Detail

    - #### getPropertyValue

          <T> T getPropertyValue(java.lang.String propertyPath,
                                 java.lang.Class<T> type)
                          throws GeneralLeanFtException

      Returns value of the specified property in this property grid control.
      This method is supported only for String, Boolean and Numeric types.
      Type Parameters:
        `T` - the generic type of property
      Parameters:
        `propertyPath` - the path of the property
        `type` - the type of the property value
      Returns:
        the value of the property
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### selectProperty

          void selectProperty(java.lang.String propertyPath)
                       throws GeneralLeanFtException

      Selects the specified property in the property grid control.
      Parameters:
        `propertyPath` - the path of the property.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### setPropertyValue

          <T> void setPropertyValue(java.lang.String propertyPath,
                                    T newPropertyValue)
                             throws GeneralLeanFtException

      Sets the value of the specified property in the property grid control.
      Applicable only to a simple value. To change a value of a custom control value in a property grid, try to create a test object for the custom control and use it to change the value.
      Type Parameters:
        `T` - the generic type of the specified property
      Parameters:
        `propertyPath` - the path of the property.
        `newPropertyValue` - the new property value.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getAttachedText

          java.lang.String getAttachedText()
                                    throws GeneralLeanFtException

      Returns the static text attached to this control.
      Returns:
        the static text
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getErrorText

          java.lang.String getErrorText()
                                 throws GeneralLeanFtException

      Returns the tooltip text of the error icon associated with this object.
      Returns:
        the tooltip text of the error icon associated with this object.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.