Class GridCurrentCellControlKeyMessageEventArgs

This is called from the current cell control's ProcessKeyMessage method and gives you a chance to modify the default behavior of this method. Be aware that this is a very implementation-specific method and you should only handle this event if KeyDown, KeyUp, CurrentCellKeyDown, or CurrentCellKeyUp events are not good enough.

Inheritance
System.Object
System.EventArgs
SyncfusionEventArgs
SyncfusionHandledEventArgs
GridCurrentCellControlKeyMessageEventArgs
Inherited Members
System.EventArgs.Empty
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.Windows.Forms.Grid
Assembly: Syncfusion.Grid.Windows.dll
Syntax
public sealed class GridCurrentCellControlKeyMessageEventArgs : SyncfusionHandledEventArgs

Constructors

GridCurrentCellControlKeyMessageEventArgs(Control, Message, Boolean, Boolean, Boolean, Boolean)

Initializes the new instances for GridCurrentCellControlKeyMessageEventArgs class.

Declaration
public GridCurrentCellControlKeyMessageEventArgs(Control control, Message msg, bool scrollInView, bool callProcessKeyPreview, bool callBaseProcessKeyMessage, bool result)
Parameters
Type Name Description
System.Windows.Forms.Control control

The active control with focus.
System.Windows.Forms.Message msg

The original windows message.
System.Boolean scrollInView

Indicates if cell should be scrolled into view.
System.Boolean callProcessKeyPreview

Indicates if ProcessKeyPreview should be called. This will trigger Grid.OnKeyDown and Grid.OnKeyUp events. CurrentCellKeyDown and CurrentCellKeyPress events might also be triggered from Grid's ProcessKeyPreview method.
System.Boolean callBaseProcessKeyMessage

Indicates if base class version of ProcessKeyMessage should be called. This flag will be ignored if callProcessKeyPreview is True.
System.Boolean result

Returns value for ProcessKeyMessage when you set Handled to True. Otherwise this value is ignored.

Properties

CallBaseProcessKeyMessage

Gets or sets a value indicating whether the flag that indicates if base class version of ProcessKeyMessage should be called. This flag will be ignored if callProcessKeyPreview is True.

Declaration
[TraceProperty(true)]
public bool CallBaseProcessKeyMessage { get; set; }
Property Value
Type Description
System.Boolean

CallProcessKeyPreview

Gets or sets a value indicating whether the flag that indicates if ProcessKeyPreview should be called. This will trigger Grid.OnKeyDown and Grid.OnKeyUp events. CurrentCellKeyDown, and CurrentCellKeyPress events might also be triggered from Grid's ProcessKeyPreview method.

Declaration
[TraceProperty(true)]
public bool CallProcessKeyPreview { get; set; }
Property Value
Type Description
System.Boolean

Control

Gets the active control with focus (Read-only).

Declaration
public Control Control { get; }
Property Value
Type Description
System.Windows.Forms.Control

Msg

Gets the original windows message (Read-only).

Declaration
public Message Msg { get; }
Property Value
Type Description
System.Windows.Forms.Message

Result

Gets or sets a value indicating whether return value for ProcessKeyMessage when you set Handled to true. Otherwise this value is ignored.

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

ScrollInView

Gets or sets a value indicating whether cell should be scrolled into view.

Declaration
[TraceProperty(true)]
public bool ScrollInView { get; set; }
Property Value
Type Description
System.Boolean