HidBooleanControl HidBooleanControl HidBooleanControl HidBooleanControl Class

Definition

Represents a simple Boolean control on a HID device that returns on/off values. An example would be the LED light on a keyboard.

public : sealed class HidBooleanControl : IHidBooleanControl
public sealed class HidBooleanControl : IHidBooleanControl
Public NotInheritable Class HidBooleanControl Implements IHidBooleanControl
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

ControlDescription ControlDescription ControlDescription ControlDescription

Retrieves a description of the given Boolean control.

public : HidBooleanControlDescription ControlDescription { get; }
public HidBooleanControlDescription ControlDescription { get; }
Public ReadOnly Property ControlDescription As HidBooleanControlDescription
var hidBooleanControlDescription = hidBooleanControl.controlDescription;

Id Id Id Id

Retrieves the identifier for a given Boolean control.

public : unsigned int Id { get; }
public uint Id { get; }
Public ReadOnly Property Id As uint
var uint = hidBooleanControl.id;
Value
unsigned int uint uint uint

The control identifier.

IsActive IsActive IsActive IsActive

Retrieves a Boolean value indicating whether the given Boolean control is active.

public : Platform::Boolean IsActive { get; set; }
public bool IsActive { get; set; }
Public ReadWrite Property IsActive As bool
var bool = hidBooleanControl.isActive;
hidBooleanControl.isActive = bool;
Value
Platform::Boolean bool bool bool

True if the control is active; false otherwise.

UsageId UsageId UsageId UsageId

Retrieves the usage identifier associated with the given Boolean control.

public : ushort UsageId { get; }
public ushort UsageId { get; }
Public ReadOnly Property UsageId As ushort
var ushort = hidBooleanControl.usageId;
Value
ushort ushort ushort ushort

The usage identifier.

UsagePage UsagePage UsagePage UsagePage

Retrieves the usage page for a given Boolean control.

public : ushort UsagePage { get; }
public ushort UsagePage { get; }
Public ReadOnly Property UsagePage As ushort
var ushort = hidBooleanControl.usagePage;
Value
ushort ushort ushort ushort

The usage page.