KeyEventArgs.IsToggled Property

Definition

Namespace:

System.Windows.Input

Assembly:

PresentationCore.dll

Gets a value that indicates whether the key referenced by the event is in the toggled state.

public:
 property bool IsToggled { bool get(); };

public bool IsToggled { get; }

member this.IsToggled : bool

Public ReadOnly Property IsToggled As Boolean

Property Value

Boolean

true if the key is toggled; otherwise, false. There is no default value.

Examples

The following example checks whether the key associated with an instance of KeyEventArgs is toggled by obtaining the state of the IsToggled property.

// e is a instance of KeyEventArgs.
// btnIsToggled is a Button.
if (e.IsToggled)
{
    btnIsToggle.Background = Brushes.Red;
}

' e is a instance of KeyEventArgs.
' btnIsToggled is a Button.
If e.IsToggled Then
    btnIsToggle.Background = Brushes.Red

Remarks

The Keyboard class also provides information about the state of the keys on the keyboard. For instance, the IsKeyToggled method returns whether a specified key is toggled.

See also

• KeyEventHandler
• KeyboardEventArgs
• KeyboardEventHandler