Open topic with navigation

com.hp.lft.sdk.winforms

## Interface Editor

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

      public interface Editor
      extends UiObjectBase, TestObject

  A .NET Windows Forms multi-line edit box.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `int` | `getCursorColumn()` Returns the character the cursor is on in the line the cursor is on (0-based).
    `int` | `getCursorLine()` The line the cursor is on in the object (0-based).
    `java.lang.String` | `getErrorText()` Returns the tooltip text of the error icon associated with this object.
    `java.lang.String` | `getSelectedText()` Returns the selected text in this control.
    `void` | `select(int fromLine, int fromCharPos, int toLine, int toCharPos)` Selects text in this multi-line editor.
    `void` | `setCursorPosition(int line, int charPos)` Places the cursor at the specified point in the multi-line editor.

    - ### 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

    - #### getCursorLine

          int getCursorLine()
                     throws GeneralLeanFtException

      The line the cursor is on in the object (0-based).
      Returns:
        the line numbre
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getCursorColumn

          int getCursorColumn()
                       throws GeneralLeanFtException

      Returns the character the cursor is on in the line the cursor is on (0-based).
      Returns:
        the character position
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### setCursorPosition

          void setCursorPosition(int line,
                                 int charPos)
                          throws GeneralLeanFtException

      Places the cursor at the specified point in the multi-line editor.
      Parameters:
        `line` - the zero-based row position at which the insertion point is placed
        `charPos` - the zero-based character position at which the insertion point is placed
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### select

          void select(int fromLine,
                      int fromCharPos,
                      int toLine,
                      int toCharPos)
               throws GeneralLeanFtException

      Selects text in this multi-line editor.
      All positions are 0-based.
      Parameters:
        `fromLine` - the line at which the selection starts, inclusive.
        `fromCharPos` - the character position at which the selection starts, inclusive.
        `toLine` - the line at which the selection ends, inclusive.
        `toCharPos` - the character position at which the selection ends, inclusive.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getSelectedText

          java.lang.String getSelectedText()
                                    throws GeneralLeanFtException

      Returns the selected text in this control.
      Returns:
        the selected 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.