SftTree/NET 2.0 - Tree Control for Windows Forms

EndEdit Method, SftTree Class

Ends cell editing.

Class: SftTree
Namespace: Softelvdm.SftTreeNET
Assembly: Softelvdm.SftTreeNET

Syntax

public bool EndEdit( bool Validate );

Public Function EndEdit( ByVal Validate As Boolean ) As Boolean

Parameters

Validate

Set to True to validate input data, False to skip input validation.

Return Value

Returns True if cell editing has ended, False if it hasn't due to input validation (the application rejected the input data using the EditValidate event). If Validate is False, EndEdit will always return True.

Comments

Ends cell editing.

If Validate is True, the EditValidate event is generated to allow the application to process the input data. If Validate is False, the current data being edited is abandoned and the cell remains unchanged.

The EndEdit method doesn't need to be called under normal circumstances. If the user clicks the mouse button outside the cell being edited, the tree control automatically generates an EditValidate event. The EndEdit method can be used to end cell editing due to an external event, such as a timer event or other application specific events.

Cell editing can be started using the CellClass.Edit method.

Examples

C#

                e.Handled = true;
            } else if (e.KeyCode == Keys.Tab && (e.Modifiers & Keys.Shift) != 0) { // Shift+Tab
                sftTree1.EditNavigate(EditNavigateEnum.Left);
                e.Handled = true;
            } else if (e.KeyCode == Keys.Tab && (e.Modifiers & Keys.Shift) == 0) { // Tab
                sftTree1.EditNavigate(EditNavigateEnum.Right);
                e.Handled = true;
            } else if (e.KeyCode == Keys.Escape) { // ESC
                sftTree1.EndEdit(false);
                e.Handled = true;
            } else if (e.KeyCode == Keys.Return) { // Return
                sftTree1.EndEdit(true);
                e.Handled = true;
            }
        }

View Entire Sample Code

VB.NET

        e.Handled = True
    ElseIf e.KeyCode = Keys.Tab And (e.Modifiers And Keys.Shift) <> 0 Then ' Shift+Tab
        sftTree1.EditNavigate(EditNavigateEnum.Left)
        e.Handled = True
    ElseIf e.KeyCode = Keys.Tab And (e.Modifiers And Keys.Shift) = 0 Then ' Tab
        sftTree1.EditNavigate(EditNavigateEnum.Right)
        e.Handled = True
    ElseIf e.KeyCode = Keys.Escape Then ' ESC
        sftTree1.EndEdit(False)
        e.Handled = True
    ElseIf e.KeyCode = Keys.Return Then ' Return
        sftTree1.EndEdit(True)
        e.Handled = True
    End If
End Sub

View Entire Sample Code

See Also SftTree Class | Classes | SftTree/NET 2.0