HidBooleanControlDescription HidBooleanControlDescription HidBooleanControlDescription HidBooleanControlDescription Class

Describes a Boolean control for a given HID device.

Syntax

Declaration

public sealed class HidBooleanControlDescriptionpublic sealed class HidBooleanControlDescriptionPublic NotInheritable Class HidBooleanControlDescription

Properties summary

Retrieves the identifier for a given Boolean control.

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

Retrieves the parent collection for a given Boolean control.

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

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

Retrieves the usage identifier associated with the given Boolean control.

Retrieves the usage page associated with the given Boolean control.

Properties

  • Id
    Id
    Id
    Id

    Retrieves the identifier for a given Boolean control.

    public uint Id { get; }public uint Id { get; }Public ReadOnly Property Id As uint

    Property Value

    • uint
      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 bool IsAbsolute { get; }public bool IsAbsolute { get; }Public ReadOnly Property IsAbsolute As bool

    Property Value

    • bool
      bool
      bool
      bool

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

    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 IVectorView<HidCollection> ParentCollections { get; }Public ReadOnly Property ParentCollections As IVectorView<HidCollection>

    Property Value

    • 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

    Property 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

    Property Value

  • 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

    Property 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

    Property Value

    • ushort
      ushort
      ushort
      ushort

      The usage page.

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.DualApiPartitionAttribute
Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute

Details

Assembly

Windows.Devices.HumanInterfaceDevice.dll