Class UserInteractiveDeviceEventArgs

Namespace

LightningChartLib.WinForms.Charting

Assembly

LightningChart.WinForms.Charting.NET4.dll

Mouse/Pointer/Touch/Pen/input device related event arguments. Position is pixels.

public class UserInteractiveDeviceEventArgs

Inheritance

object

UserInteractiveDeviceEventArgs

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

UserInteractiveDeviceEventArgs(ButtonState, CoordXY, double, UserInteractiveDeviceEventType, uint, bool)

Constructor.

public UserInteractiveDeviceEventArgs(ButtonState buttonsState, CoordXY position, double delta, UserInteractiveDeviceEventType eventType, uint pointerId, bool handled = false)

Parameters

buttonsState ButtonState

param buttonsState M:LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs.#ctor(LightningChartLib.WinForms.Charting.ButtonState,LightningChartLib.WinForms.Charting.CoordXY,System.Double,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.UInt32,System.Boolean)

position CoordXY

param position M:LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs.#ctor(LightningChartLib.WinForms.Charting.ButtonState,LightningChartLib.WinForms.Charting.CoordXY,System.Double,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.UInt32,System.Boolean)

delta double

param delta M:LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs.#ctor(LightningChartLib.WinForms.Charting.ButtonState,LightningChartLib.WinForms.Charting.CoordXY,System.Double,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.UInt32,System.Boolean)

eventType UserInteractiveDeviceEventType

param eventType M:LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs.#ctor(LightningChartLib.WinForms.Charting.ButtonState,LightningChartLib.WinForms.Charting.CoordXY,System.Double,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.UInt32,System.Boolean)

pointerId uint

param pointerId M:LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs.#ctor(LightningChartLib.WinForms.Charting.ButtonState,LightningChartLib.WinForms.Charting.CoordXY,System.Double,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.UInt32,System.Boolean)

handled bool

param handled M:LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs.#ctor(LightningChartLib.WinForms.Charting.ButtonState,LightningChartLib.WinForms.Charting.CoordXY,System.Double,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.UInt32,System.Boolean)

UserInteractiveDeviceEventArgs(UserInteractiveDeviceButton, UserInteractiveDeviceButtonState, CoordXY, int, UserInteractiveDeviceEventType)

Constructor.

public UserInteractiveDeviceEventArgs(UserInteractiveDeviceButton button, UserInteractiveDeviceButtonState state, CoordXY point, int delta, UserInteractiveDeviceEventType eventType)

Parameters

button UserInteractiveDeviceButton

param button M:LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs.#ctor(LightningChartLib.WinForms.Charting.UserInteractiveDeviceButton,LightningChartLib.WinForms.Charting.UserInteractiveDeviceButtonState,LightningChartLib.WinForms.Charting.CoordXY,System.Int32,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType)

state UserInteractiveDeviceButtonState

param state M:LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs.#ctor(LightningChartLib.WinForms.Charting.UserInteractiveDeviceButton,LightningChartLib.WinForms.Charting.UserInteractiveDeviceButtonState,LightningChartLib.WinForms.Charting.CoordXY,System.Int32,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType)

point CoordXY

param point M:LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs.#ctor(LightningChartLib.WinForms.Charting.UserInteractiveDeviceButton,LightningChartLib.WinForms.Charting.UserInteractiveDeviceButtonState,LightningChartLib.WinForms.Charting.CoordXY,System.Int32,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType)

delta int

param delta M:LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs.#ctor(LightningChartLib.WinForms.Charting.UserInteractiveDeviceButton,LightningChartLib.WinForms.Charting.UserInteractiveDeviceButtonState,LightningChartLib.WinForms.Charting.CoordXY,System.Int32,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType)

eventType UserInteractiveDeviceEventType

param eventType M:LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs.#ctor(LightningChartLib.WinForms.Charting.UserInteractiveDeviceButton,LightningChartLib.WinForms.Charting.UserInteractiveDeviceButtonState,LightningChartLib.WinForms.Charting.CoordXY,System.Int32,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType)

Fields

ButtonsState

Buttons with states. Buttons are enumerated as flagged.

public readonly ButtonState ButtonsState

Field Value

ButtonState

Delta

Wheel related value.

public readonly double Delta

Field Value

double

EventType

Event type.

public readonly UserInteractiveDeviceEventType EventType

Field Value

UserInteractiveDeviceEventType

PointerId

Pointer Id. Mainly used with UWP.

public readonly uint PointerId

Field Value

uint

Position

Position in pixel coordinates.

public readonly CoordXY Position

Field Value

CoordXY

Properties

Handled

Event handled status.

public bool Handled { get; set; }

Property Value

bool

Methods

IsButtonPressed(UserInteractiveDeviceButton)

Check if given button is pressed.

public bool IsButtonPressed(UserInteractiveDeviceButton button)

Parameters

button UserInteractiveDeviceButton

Button to check.

Returns

bool

True, if is pressed, false otherwise.

IsButtonReleased(UserInteractiveDeviceButton)

Check if given button is released.

public bool IsButtonReleased(UserInteractiveDeviceButton button)

Parameters

button UserInteractiveDeviceButton

Button to check.

Returns

bool

True, if is released, false otherwise.

ToString()

Return button state and event type as string.

public override string ToString()

Returns

string

returns M:LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs.ToString