Open topic with navigation

com.hp.lft.sdk.wpf

## Interface ToggleButton

-     public interface ToggleButton

  A .NET WPF toggle button control Note: To create an instance of this interface, first create a Button instance for a button with toggle behavior, and then return the ToggleButton using the Button.getToggleButton method.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `Button` | `getButtonTestObject()` Returns the Button test object, from which this toggle button was accessed.
    `CheckedState` | `getState()` Returns the toggle button status.
    `boolean` | `isChecked()` Indicates whether the toggle button is checked.
    `boolean` | `isThreeState()` Indicates whether the toggle button is able to display three check states.
    `void` | `set(CheckedState state)` Sets the status of the toggle button.

- - ### Method Detail

    - #### getButtonTestObject

                                                      Button getButtonTestObject()

      Returns the Button test object, from which this toggle button was accessed.
      Returns:
        the Button test object, from which this toggle button was accessed.

    - #### getState

                                                      CheckedState getState()
                         throws GeneralLeanFtException

      Returns the toggle button status.
      Returns:
        the toggle button status.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### set

          void set(CheckedState state)
            throws GeneralLeanFtException

      Sets the status of the toggle button.
      Parameters:
        `state` - the status to be assigned to the toggle button.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### isChecked

          boolean isChecked()
                     throws GeneralLeanFtException

      Indicates whether the toggle button is checked.
      For Three State toggle button: IsChecked will return true for either a Checked or Indeterminate State.
      Returns:
        true, if the check box is checked.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### isThreeState

          boolean isThreeState()
                        throws GeneralLeanFtException

      Indicates whether the toggle button is able to display three check states.
      Returns:
        true, if the toggle button is able to display three check states.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.