Share this page
com.hp.lft.sdk.wpf
Interface ToggleButton
public interface ToggleButtonA .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 ButtongetButtonTestObject()Returns the Button test object, from which this toggle button was accessed.CheckedStategetState()Returns the toggle button status.booleanisChecked()Indicates whether the toggle button is checked.booleanisThreeState()Indicates whether the toggle button is able to display three check states.voidset(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 GeneralLeanFtExceptionReturns 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 GeneralLeanFtExceptionIndicates 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 GeneralLeanFtExceptionIndicates 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.
