alphaTab.platform.IMouseEventArgs

This interface represents the information about a mouse event that occured on the UI.

 interface IMouseEventArgs

Properties

isLeftMouseButton

Gets a value indicating whether the left mouse button was pressed.

JavaScript

readonly isLeftMouseButton: boolean;

C#

bool IsLeftMouseButton { get; }

Kotlin

val isLeftMouseButton: Boolean

Methods

getX

Gets the X-position of the cursor at the time of the event relative to the given UI container.

JavaScript

getX(relativeTo: IContainer): number

C#

double GetX(IContainer relativeTo)

Kotlin

fun getX(relativeTo: IContainer): Double

Parameter	Summary
relativeToAll	The UI element to which the relative position should be calculated.

Returns

The relative X-position of the cursor to the given UI container at the time the event occured.

getY

Gets the Y-position of the cursor at the time of the event relative to the given UI container.

JavaScript

getY(relativeTo: IContainer): number

C#

double GetY(IContainer relativeTo)

Kotlin

fun getY(relativeTo: IContainer): Double

Parameter	Summary
relativeToAll	The UI element to which the relative position should be calculated.

Returns

The relative Y-position of the cursor to the given UI container at the time the event occured.

preventDefault

If called, the original mouse action is prevented and the event is flagged as handled.

JavaScript

preventDefault(): void

C#

void PreventDefault()

Kotlin

fun preventDefault(): Unit