FlexGrid for WinForms
FinishEditing(Boolean) Method



Whether to cancel the current edits and revert the cell to its original value.
Finishes editing the current cell and takes the grid out of edit mode, optionally canceling the edits.
Syntax
'Declaration
 
Public Overloads Function FinishEditing( _
   ByVal cancel As Boolean _
) As Boolean
'Usage
 
Dim instance As C1FlexGridBase
Dim cancel As Boolean
Dim value As Boolean
 
value = instance.FinishEditing(cancel)
public bool FinishEditing( 
   bool cancel
)
public:
bool FinishEditing( 
   bool cancel
) 

Parameters

cancel
Whether to cancel the current edits and revert the cell to its original value.

Return Value

True if the grid left edit mode successfully, false otherwise.
Remarks

If the cancel parameter is set to false, the grid tries to apply the edits, and fires the ValidateEdit, LeaveEdit, and AfterEdit events as usual. If validation fails, the grid stays in edit mode (and FinishEditing returns false).

If the cancel parameter is set to true, the original cell value is restored and the grid is guaranteed to leave the edit mode. In this case, only the LeaveEdit event fires.

To determine whether the grid is in edit mode, check whether the Editor property is null.

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

C1FlexGridBase Class
C1FlexGridBase Members
Overload List

 

 


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

Send Feedback