HidBooleanControlDescription HidBooleanControlDescription HidBooleanControlDescription HidBooleanControlDescription Class

Definition

Describes a Boolean control for a given HID device.

public : sealed class HidBooleanControlDescription : IHidBooleanControlDescription, IHidBooleanControlDescription2
public sealed class HidBooleanControlDescription : IHidBooleanControlDescription, IHidBooleanControlDescription2
Public NotInheritable Class HidBooleanControlDescription Implements IHidBooleanControlDescription, IHidBooleanControlDescription2
// 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

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 = hidBooleanControlDescription.id;
Value
unsigned int uint uint uint

The control identifier.

IsAbsolute IsAbsolute IsAbsolute IsAbsolute

Gets a value indicating whether the given boolean control values are absolute or relative.

public : Platform::Boolean IsAbsolute { get; }
public bool IsAbsolute { get; }
Public ReadOnly Property IsAbsolute As bool
var bool = hidBooleanControlDescription.isAbsolute;
Value
Platform::Boolean bool bool bool

True if the values are absolute; false if the values are relative.

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Remarks

This property is useful when an app provides similar functionality as the system and needs to keep the corresponding in-app control synchronized with the system setting. For example, an in-app (relative) mute button that doesn't affect the system volume, but which must correspond to any changes made to the system setting (absolute).

ParentCollections ParentCollections ParentCollections ParentCollections

Retrieves the parent collection for a given Boolean control.

public : IVectorView<HidCollection> ParentCollections { get; }
public IReadOnlyList<HidCollection> ParentCollections { get; }
Public ReadOnly Property ParentCollections As IReadOnlyList<HidCollection>
var iReadOnlyList = hidBooleanControlDescription.parentCollections;
Value
IVectorView<HidCollection> IReadOnlyList<HidCollection> IReadOnlyList<HidCollection> IReadOnlyList<HidCollection>

The control's parent collection.

ReportId ReportId ReportId ReportId

Retrieves the identifier for the report associated with the given Boolean control.

public : ushort ReportId { get; }
public ushort ReportId { get; }
Public ReadOnly Property ReportId As ushort
var ushort = hidBooleanControlDescription.reportId;
Value
ushort ushort ushort ushort

The report identifier.

ReportType ReportType ReportType ReportType

Retrieves the report type for the report associated with the given Boolean control.

public : HidReportType ReportType { get; }
public HidReportType ReportType { get; }
Public ReadOnly Property ReportType As HidReportType
var hidReportType = hidBooleanControlDescription.reportType;

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 = hidBooleanControlDescription.usageId;
Value
ushort ushort ushort ushort

The usage identifier.

UsagePage UsagePage UsagePage UsagePage

Retrieves the usage page associated with the given Boolean control.

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

The usage page.