HidBooleanControlDescription
HidBooleanControlDescription
HidBooleanControlDescription
HidBooleanControlDescription
Class
Definition
Describes a Boolean control for a given HID device.
public : sealed class HidBooleanControlDescription : IHidBooleanControlDescription, IHidBooleanControlDescription2public sealed class HidBooleanControlDescription : IHidBooleanControlDescription, IHidBooleanControlDescription2Public NotInheritable Class HidBooleanControlDescription Implements IHidBooleanControlDescription, IHidBooleanControlDescription2// You can use this class in JavaScript.
- Attributes
| 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// You can use this property in JavaScript.
- 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// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if the values are absolute; false if the values are relative.
| 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>// You can use this property in JavaScript.
- 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// You can use this property in JavaScript.
- 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// You can use this property in JavaScript.
The report type.
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// You can use this property in JavaScript.
- 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// You can use this property in JavaScript.
- Value
- ushort ushort ushort ushort
The usage page.