Class TextBoxKeyPressingEventArgs

Event arguments for when a key is pressed on the textbox.

Inheritance

System.Object

TextBoxKeyPressingEventArgs

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

public class TextBoxKeyPressingEventArgs

Constructors

TextBoxKeyPressingEventArgs(Key, TextboxState)

Initializes a new instance of the TextBoxKeyPressingEventArgs class.

Declaration

public TextBoxKeyPressingEventArgs(Key pressedKey, TextboxState intendedState)

Parameters

Type	Name	Description
Key	pressedKey	Pressed key.
TextboxState	intendedState	Intended state.

Properties

IntendedState

Gets the state the textbox is intending to move to once the current operation is completed. You can edit this state when receiving an OnPressingKey event to override the result (i.e change the text or caret position).

Declaration

public TextboxState IntendedState { get; }

Property Value

Type	Description
TextboxState	The state of the intended.

PressedKey

Gets the pressed key.

Declaration

public Key PressedKey { get; }

Property Value

Type	Description
Key	The pressed key.

ShouldCancel

A subscriber of the event can canel processing the key input by setting this property to true.

Declaration

public bool ShouldCancel { get; set; }

Property Value

Type	Description
System.Boolean	true if should cancel; otherwise, false.