KeyEventArgs.IsToggled Property

Reference

Definition

Namespace:: System.Windows.Input

Assembly:: PresentationCore.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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.

Applies to

Product	Versions
.NET Framework	3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop	3.0, 3.1, 5, 6, 7, 8, 9, 10

Share via