alphaTab.platform.IContainer

This interface represents a container control in the UI layer.

 interface IContainer

Properties

height

Gets or sets the height of the control.

JavaScript

height: number;

C#

double Height { get; set; }

Kotlin

var height: Double

isVisible

Gets a value indicating whether the control is visible.

JavaScript

readonly isVisible: boolean;

C#

bool IsVisible { get; }

Kotlin

val isVisible: Boolean

mouseDown

This event occurs when a mouse/finger press happened on the control.

JavaScript

mouseDown: IEventEmitterOfT<IMouseEventArgs>;

C#

IEventEmitterOfT<IMouseEventArgs> MouseDown { get; set; }

Kotlin

var mouseDown: IEventEmitterOfT<IMouseEventArgs>

mouseMove

This event occurs when a mouse/finger moves on top of the control. While a press started on this control is active, moves are reported even if they happen outside the control.

JavaScript

mouseMove: IEventEmitterOfT<IMouseEventArgs>;

C#

IEventEmitterOfT<IMouseEventArgs> MouseMove { get; set; }

Kotlin

var mouseMove: IEventEmitterOfT<IMouseEventArgs>

mouseUp

This event occurs when a mouse/finger is released from the control. Every press started on this control ends with exactly one mouseUp, also when the release happens outside the control or the gesture is cancelled by the system.

JavaScript

mouseUp: IEventEmitterOfT<IMouseEventArgs>;

C#

IEventEmitterOfT<IMouseEventArgs> MouseUp { get; set; }

Kotlin

var mouseUp: IEventEmitterOfT<IMouseEventArgs>

resize

This event occurs when the control was resized.

JavaScript

resize: IEventEmitter;

C#

IEventEmitter Resize { get; set; }

Kotlin

var resize: IEventEmitter

scrollLeft

Gets or sets the horizontal scroll offset of this control if it is scrollable.

JavaScript

scrollLeft: number;

C#

double ScrollLeft { get; set; }

Kotlin

var scrollLeft: Double

scrollTop

Gets or sets the vertical scroll offset of this control if it is scrollable.

JavaScript

scrollTop: number;

C#

double ScrollTop { get; set; }

Kotlin

var scrollTop: Double

width

Gets or sets the width of the control.

JavaScript

width: number;

C#

double Width { get; set; }

Kotlin

var width: Double

Methods

appendChild

Adds the given child control to this container.

JavaScript

appendChild(child: IContainer): void

C#

void AppendChild(IContainer child)

Kotlin

fun appendChild(child: IContainer): Unit

Parameter	Summary
childAll	The child control to add.

clear

Clears the container and removes all child items.

JavaScript

clear(): void

C#

void Clear()

Kotlin

fun clear(): Unit

setBounds

Sets the position and size of the container for efficient repositioning.

JavaScript

setBounds(x: number, y: number, w: number, h: number): void

C#

void SetBounds(double x, double y, double w, double h)

Kotlin

fun setBounds(x: Double, y: Double, w: Double, h: Double): Unit

Parameter	Summary
xAll	The X-position
yAll	The Y-position
wAll	The width
hAll	The height

stopAnimation

Stops the animations of this control immediately.

JavaScript

stopAnimation(): void

C#

void StopAnimation()

Kotlin

fun stopAnimation(): Unit

transitionToX

Tells the control to move to the given X-position in the given time.

JavaScript

transitionToX(duration: number, x: number): void

C#

void TransitionToX(double duration, double x)

Kotlin

fun transitionToX(duration: Double, x: Double): Unit

Parameter	Summary
durationAll	The milliseconds that should be needed to reach the new X-position
xAll	The new X-position