FlexGrid for WinForms
C1EditorKeyDownFinishEdit Method



Key to be tested.
Gets a value that determines whether a given key should finalize editing.
Syntax
'Declaration
 
Function C1EditorKeyDownFinishEdit( _
   ByVal e As KeyEventArgs _
) As Boolean
'Usage
 
Dim instance As IC1EmbeddedEditor
Dim e As KeyEventArgs
Dim value As Boolean
 
value = instance.C1EditorKeyDownFinishEdit(e)
bool C1EditorKeyDownFinishEdit( 
   KeyEventArgs e
)
bool C1EditorKeyDownFinishEdit( 
   KeyEventArgs^ e
) 

Parameters

e
Key to be tested.

Return Value

True if the key should finish the edits and close the editor.
Remarks

If this method returns true, the grid copies the editor value to the cell and exits edit mode. The key is then processed by the grid (unless the e.Handled parameter is set to true).

For example, pressing the down arrow typically causes the grid to exit edit mode and move the cursor to the next row.

The default handler returns true for the TAB, ENTER, and ESC keys. It also handles the arrow keys for editors based on TextBox, ComboBox, and DateTimePicker controls.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

IC1EmbeddedEditor Interface
IC1EmbeddedEditor Members

 

 


Copyright (c) GrapeCity, inc. All rights reserved.

Send Feedback