HidNumericControlDescription HidNumericControlDescription HidNumericControlDescription HidNumericControlDescription HidNumericControlDescription Class

Definition

Describes a numeric control for a given HID device.

public : sealed class HidNumericControlDescription : IHidNumericControlDescription
struct winrt::Windows::Devices::HumanInterfaceDevice::HidNumericControlDescription : IHidNumericControlDescription
public sealed class HidNumericControlDescription : IHidNumericControlDescription
Public NotInheritable Class HidNumericControlDescription Implements IHidNumericControlDescription
// 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

HasNull HasNull HasNull HasNull HasNull

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

public : Platform::Boolean HasNull { get; }
bool HasNull();
public bool HasNull { get; }
Public ReadOnly Property HasNull As bool
var bool = hidNumericControlDescription.hasNull;
Value
bool bool bool

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

Id Id Id Id Id

Retrieves the identifier for a given numeric control.

public : unsigned int Id { get; }
uint32_t Id();
public uint Id { get; }
Public ReadOnly Property Id As uint
var uint = hidNumericControlDescription.id;
Value
uint uint uint

Identifies the control.

IsAbsolute IsAbsolute IsAbsolute IsAbsolute IsAbsolute

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

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

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

LogicalMaximum LogicalMaximum LogicalMaximum LogicalMaximum LogicalMaximum

Retrieves the logical maximum value for the given control.

public : int LogicalMaximum { get; }
int32_t LogicalMaximum();
public int LogicalMaximum { get; }
Public ReadOnly Property LogicalMaximum As int
var int = hidNumericControlDescription.logicalMaximum;
Value
int int int

The logical maximum value.

LogicalMinimum LogicalMinimum LogicalMinimum LogicalMinimum LogicalMinimum

Retrieves the logical minimum value for the control.

public : int LogicalMinimum { get; }
int32_t LogicalMinimum();
public int LogicalMinimum { get; }
Public ReadOnly Property LogicalMinimum As int
var int = hidNumericControlDescription.logicalMinimum;
Value
int int int

The logical minimum value.

ParentCollections ParentCollections ParentCollections ParentCollections ParentCollections

Retrieves the parent collections for a given numeric control.

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

A vector of HidCollection objects.

PhysicalMaximum PhysicalMaximum PhysicalMaximum PhysicalMaximum PhysicalMaximum

Retrieves the physical maximum-value for the given control.

public : int PhysicalMaximum { get; }
int32_t PhysicalMaximum();
public int PhysicalMaximum { get; }
Public ReadOnly Property PhysicalMaximum As int
var int = hidNumericControlDescription.physicalMaximum;
Value
int int int

The physical maximum value.

PhysicalMinimum PhysicalMinimum PhysicalMinimum PhysicalMinimum PhysicalMinimum

Retrieves the physical minimum-value for the given control.

public : int PhysicalMinimum { get; }
int32_t PhysicalMinimum();
public int PhysicalMinimum { get; }
Public ReadOnly Property PhysicalMinimum As int
var int = hidNumericControlDescription.physicalMinimum;
Value
int int int

The physical minimum value.

ReportCount ReportCount ReportCount ReportCount ReportCount

Retrieves the number of reports associated with the given control.

public : unsigned int ReportCount { get; }
uint32_t ReportCount();
public uint ReportCount { get; }
Public ReadOnly Property ReportCount As uint
var uint = hidNumericControlDescription.reportCount;
Value
uint uint uint

The number of reports.

ReportId ReportId ReportId ReportId ReportId

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

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

The report identifier.

ReportSize ReportSize ReportSize ReportSize ReportSize

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

public : unsigned int ReportSize { get; }
uint32_t ReportSize();
public uint ReportSize { get; }
Public ReadOnly Property ReportSize As uint
var uint = hidNumericControlDescription.reportSize;
Value
uint uint uint

The report size (in bytes).

ReportType ReportType ReportType ReportType ReportType

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

public : HidReportType ReportType { get; }
HidReportType ReportType();
public HidReportType ReportType { get; }
Public ReadOnly Property ReportType As HidReportType
var hidReportType = hidNumericControlDescription.reportType;
Value
HidReportType HidReportType HidReportType

The report type.

Unit Unit Unit Unit Unit

Retrieves the unit associated with the given numeric control.

public : unsigned int Unit { get; }
uint32_t Unit();
public uint Unit { get; }
Public ReadOnly Property Unit As uint
var uint = hidNumericControlDescription.unit;
Value
uint uint uint

The report unit.

UnitExponent UnitExponent UnitExponent UnitExponent UnitExponent

Retrieves the unit exponent for the given numeric control.

public : unsigned int UnitExponent { get; }
uint32_t UnitExponent();
public uint UnitExponent { get; }
Public ReadOnly Property UnitExponent As uint
var uint = hidNumericControlDescription.unitExponent;
Value
uint uint uint

The unit exponent.

UsageId UsageId UsageId UsageId UsageId

Retrieves the usage identifier associated with the given numeric control.

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

The usage identifierl.

UsagePage UsagePage UsagePage UsagePage UsagePage

Retrieves the usage page associated with the given numeric control.

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

The usage page.