SftTree.EditNavigate Method
|
|
|
|
|
|
SftTree.EditNavigate Method |
Positions cell editing on another cell.
Syntax
|
VB.NET |
Handled = object.EditNavigate(ByVal Key As Integer, ByVal Shift As Short) As Boolean |
||
|
VB |
Handled = object.EditNavigate(ByVal Key As Long, ByVal Shift As Integer) As Boolean |
||
|
C#.NET |
bool Handled = object.EditNavigate(int Key, short Shift); |
||
|
VC++ |
VARIANT_BOOL Handled = object->EditNavigate(long Key, short Shift); |
||
|
C |
HRESULT object->raw_EditNavigate(long Key, short Shift, VARIANT_BOOL* Handled); |
||
|
Delphi |
Handled := object.EditNavigate(Key : Integer; Shift : Smallint) : WordBool; |
object
A SftTree object.
Key
A virtual key code. The key to be handled.
|
Symbol Name |
Value |
Description |
VK_TAB |
0x09 |
TAB key - This key is handled by the EditNavigate method. Editing of the current cell ends and the next or previous editable cell in the tree control is edited. The TAB key will position to the next cell, SHIFT + TAB to the previous cell. The CONTROL key is ignored. |
VK_RETURN |
0x0d |
ENTER key - This key is handled by the EditNavigate method. Editing of the current cell ends and the next editable cell in the tree control is edited. The CONTROL and SHIFT keys are ignored. |
VK_ESCAPE |
0x1b |
ESC key - This key is handled by the EditNavigate method. Cell editing is ended by calling EndEdit. |
VK_END |
0x23 |
END key - This key is handled by the EditNavigate method if the CONTROL key is pressed. Editing of the current cell ends and the last editable cell in the tree control is edited. |
VK_HOME |
0x24 |
HOME key - This key is handled by the EditNavigate method if the CONTROL key is pressed. Editing of the current cell ends and the first editable cell in the tree control is edited. |
VK_UP |
0x26 |
UP ARROW key - This key is handled by the EditNavigate method if the CONTROL and SHIFT keys are not pressed. Editing of the current cell ends and the cell in the same column of the preceding item is edited. |
VK_DOWN |
0x28 |
DOWN ARROW key - This key is handled by the EditNavigate method if the CONTROL and SHIFT keys are not pressed. Editing of the current cell ends and the cell in the same column of the next item is edited. |
Note: Symbolic names are only available to applications written in C/C++, which use the #include directive to include WinUser.h, part of the Windows header files.
Shift
The state of the SHIFT, CONTROL and ALT keys (see SftTreeKeyConstants). A bit is set if the key is down. The Shift argument is a bit field with bits corresponding to the SHIFT, CONTROL and ALT keys. The Shift variable indicates the state of these keys. Some, all, or none of the bits can be set, indicating which of the keys are pressed.
|
Shift |
Value |
Description |
|
1 |
The SHIFT key was pressed. |
|
|
2 |
The CONTROL key was pressed. |
|
|
4 |
Not used. The ALT key was pressed. |
Handled
Returns True if the key Key was handled by the EditNavigate method, otherwise False is returned.
Comments
The EditNavigate method positions cell editing on another cell.
The EditNavigate method implements default cell navigation for the virtual key codes Key and is called to handle navigation keys pressed during cell editing. These keys can be defined using the CellEditIntercept method. A key that is intercepted will generate the EditNavigating event so the application can handle the key by calling EditNavigate.
See Also SftTree Object | Object Hierarchy