Hid​Numeric​Control​Description Hid​Numeric​Control​Description Hid​Numeric​Control​Description Class

Definition

Describes a numeric control for a given HID device.

Edit 
public sealed class HidNumericControlDescription : IHidNumericControlDescriptionpublic sealed class HidNumericControlDescription : IHidNumericControlDescriptionPublic NotInheritable Class HidNumericControlDescription Implements IHidNumericControlDescription
Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute
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

HasNull HasNull HasNull

Edit

Retrieves a Boolean value which indicates whether the control supports a null, or out-of-range, value.

public PlatForm::Boolean HasNull { get; }public bool HasNull { get; }Public ReadOnly Property HasNull As bool
Value
bool bool bool

True if the control supports a null value; false otherwise.

Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

Id Id Id

Edit

Retrieves the identifier for a given numeric control.

public unsigned short Id { get; }public uint Id { get; }Public ReadOnly Property Id As uint
Value
uint uint uint

Identifies the control.

Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

IsAbsolute IsAbsolute IsAbsolute

Edit

Retrieves a Boolean value indicating whether the given control values are absolute or relative.

public PlatForm::Boolean IsAbsolute { get; }public bool IsAbsolute { get; }Public ReadOnly Property IsAbsolute As bool
Value
bool bool bool

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

Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

LogicalMaximum LogicalMaximum LogicalMaximum

Edit

Retrieves the logical maximum value for the given control.

public int LogicalMaximum { get; }public int LogicalMaximum { get; }Public ReadOnly Property LogicalMaximum As int
Value
int int int

The logical maximum value.

Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

LogicalMinimum LogicalMinimum LogicalMinimum

Edit

Retrieves the logical minimum value for the control.

public int LogicalMinimum { get; }public int LogicalMinimum { get; }Public ReadOnly Property LogicalMinimum As int
Value
int int int

The logical minimum value.

Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

ParentCollections ParentCollections ParentCollections

Edit

Retrieves the parent collections for a given numeric control.

public IVectorView<HidCollection> ParentCollections { get; }public IVectorView<HidCollection> ParentCollections { get; }Public ReadOnly Property ParentCollections As IVectorView<HidCollection>
Value

A vector of HidCollection objects.

Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

PhysicalMaximum PhysicalMaximum PhysicalMaximum

Edit

Retrieves the physical maximum-value for the given control.

public int PhysicalMaximum { get; }public int PhysicalMaximum { get; }Public ReadOnly Property PhysicalMaximum As int
Value
int int int

The physical maximum value.

Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

PhysicalMinimum PhysicalMinimum PhysicalMinimum

Edit

Retrieves the physical minimum-value for the given control.

public int PhysicalMinimum { get; }public int PhysicalMinimum { get; }Public ReadOnly Property PhysicalMinimum As int
Value
int int int

The physical minimum value.

Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

ReportCount ReportCount ReportCount

Edit

Retrieves the number of reports associated with the given control.

public unsigned short ReportCount { get; }public uint ReportCount { get; }Public ReadOnly Property ReportCount As uint
Value
uint uint uint

The number of reports.

Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

ReportId ReportId ReportId

Edit

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

public ushort ReportId { get; }public ushort ReportId { get; }Public ReadOnly Property ReportId As ushort
Value
ushort ushort ushort

The report identifier.

Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

ReportSize ReportSize ReportSize

Edit

Retrieves the size, in bytes, of the given numeric control.

public unsigned short ReportSize { get; }public uint ReportSize { get; }Public ReadOnly Property ReportSize As uint
Value
uint uint uint

The report size (in bytes).

Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

ReportType ReportType ReportType

Edit

Retrieves the type of report associated with the given numeric control.

public HidReportType ReportType { get; }public HidReportType ReportType { get; }Public ReadOnly Property ReportType As HidReportType
Value
HidReportType HidReportType HidReportType

The report type.

Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

Unit Unit Unit

Edit

Retrieves the unit associated with the given numeric control.

public unsigned short Unit { get; }public uint Unit { get; }Public ReadOnly Property Unit As uint
Value
uint uint uint

The report unit.

Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

UnitExponent UnitExponent UnitExponent

Edit

Retrieves the unit exponent for the given numeric control.

public unsigned short UnitExponent { get; }public uint UnitExponent { get; }Public ReadOnly Property UnitExponent As uint
Value
uint uint uint

The unit exponent.

Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

UsageId UsageId UsageId

Edit

Retrieves the usage identifier associated with the given numeric control.

public ushort UsageId { get; }public ushort UsageId { get; }Public ReadOnly Property UsageId As ushort
Value
ushort ushort ushort

The usage identifierl.

Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

UsagePage UsagePage UsagePage

Edit

Retrieves the usage page associated with the given numeric control.

public ushort UsagePage { get; }public ushort UsagePage { get; }Public ReadOnly Property UsagePage As ushort
Value
ushort ushort ushort

The usage page.

Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute