Class IgbKeyEventArgs

Event args for KeyUp and KeyDown events.

Inheritance
System.Object
BaseRendererElement
IgbKeyEventArgs
Implements
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbKeyEventArgs : BaseRendererElement, JsonSerializable

Constructors

IgbKeyEventArgs()

Declaration
public IgbKeyEventArgs()

Properties

Alt

Gets a value indicating whether the ALT key was pressed.

Declaration
public bool Alt { get; protected set; }
Property Value
Type Description
System.Boolean

Ctrl

Gets a value indicating whether the CTRL key was pressed.

Declaration
public bool Ctrl { get; protected set; }
Property Value
Type Description
System.Boolean

DefaultPrevented

Gets whether the PreventDefault method was called.

Declaration
public bool DefaultPrevented { get; protected set; }
Property Value
Type Description
System.Boolean

KeyCode

Gets the keyboard code for a KeyDown or KeyUp event.

Declaration
public int KeyCode { get; protected set; }
Property Value
Type Description
System.Int32

Modifiers

Gets the modifier flags for a KeyDown or KeyUp event. The flags indicate which combination of CTRL, SHIFT, and ALT keys was pressed.

Declaration
public ModifierKeys Modifiers { get; protected set; }
Property Value
Type Description
ModifierKeys

OriginalEvent

Declaration
public object OriginalEvent { get; protected set; }
Property Value
Type Description
System.Object

OriginalEventScript

Provides a means of setting OriginalEvent in the JavaScript environment.

Declaration
public string OriginalEventScript { get; set; }
Property Value
Type Description
System.String

Shift

Gets a value indicating whether the SHIFT key was pressed.

Declaration
public bool Shift { get; protected set; }
Property Value
Type Description
System.Boolean

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

Methods

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

FromEventJson(BaseRendererControl, Dictionary<String, Object>)

Declaration
protected override void FromEventJson(BaseRendererControl control, Dictionary<string, object> args)
Parameters
Type Name Description
BaseRendererControl control
System.Collections.Generic.Dictionary<System.String, System.Object> args
Overrides

PreventDefault()

Declaration
public void PreventDefault()

PreventDefaultAsync()

Tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be.

Declaration
public Task PreventDefaultAsync()
Returns
Type Description
System.Threading.Tasks.Task

StopPropagation()

Declaration
public void StopPropagation()

StopPropagationAsync()

Prevent the event from bubbling up.

Declaration
public Task StopPropagationAsync()
Returns
Type Description
System.Threading.Tasks.Task

ToEventJson(BaseRendererControl, Dictionary<String, Object>)

Declaration
protected override void ToEventJson(BaseRendererControl control, Dictionary<string, object> args)
Parameters
Type Name Description
BaseRendererControl control
System.Collections.Generic.Dictionary<System.String, System.Object> args
Overrides

Implements