PushButtonHelper Class

A helper class for implementing the IPushButton interface using a single GPIO pin.

Inheritance Hierarchy

SystemObject
Microsoft.IoT.DeviceHelpers.InputPushButtonHelper

Namespace: Microsoft.IoT.DeviceHelpers.Input
Assembly: Microsoft.IoT.DeviceHelpers (in Microsoft.IoT.DeviceHelpers.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy

public sealed class PushButtonHelper : IDisposable

Public NotInheritable Class PushButtonHelper
	Implements IDisposable

public ref class PushButtonHelper sealed : IDisposable

[<SealedAttribute>]
type PushButtonHelper =  
    class
        interface IDisposable
    end

The PushButtonHelper type exposes the following members.

Constructors

	Name	Description
	PushButtonHelper	Initializes a new PushButtonHelper instance.

Top

Properties

	Name	Description
	ClickEvent	Gets the click event for the push button.
	ClickMode	Gets or sets a value that indicates when the Click event occurs.
	DebounceTimeout	Gets or sets the amount of time in milliseconds that will be used to debounce the pushbutton.
	IsPressed	Gets a value that indicates if the button is pressed.
	Pin	Gets or sets the pin that the button is connected to.
	PressedEvent	Gets the pressed event for the push button.
	PressedValue	Gets or sets the GpioPinValue that indicates the button is pressed.
	ReleasedEvent	Gets the released event for the push button.
	UsePullResistors	Gets or sets a value that indicates if integrated pull up or pull down resistors should be used to help maintain the state of the pin.

Top

Methods

	Name	Description
	Dispose	Releases all resources used by the PushButtonHelper
	EnsureInitialized	Ensures that the helper has been initialized.
	Equals	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	ToString	(Inherited from Object.)

Top

Reference

Microsoft.IoT.DeviceHelpers.Input Namespace