BeginEdit Method

Visual Basic (Declaration)
Visual Basic (Usage)
C#

<FeatureAttribute(Name="UIEdit", Version="v5.0")>
Public Function BeginEdit( _
   ByVal selectAll As Boolean _
) As Boolean

Dim instance As GcMultiRow
Dim selectAll As Boolean
Dim value As Boolean
 
value = instance.BeginEdit(selectAll)

[Feature(Name="UIEdit", Version="v5.0")]
public bool BeginEdit( 
   bool selectAll
)

Parameters

selectAll: true if selecting the cell's contents; otherwise,false.

Return Value

true if the current cell is already in edit mode or successfully enters edit mode; otherwise, false.

Exception	Description
System.InvalidCastException	The type indicated by the cell's Cell.EditType property does not derive from the System.Windows.Forms.Control type or does not implement the IEditingControl interface.

This method returns false if the cell fails to enter edit mode. This can happen for a number of reasons.

The following table lists when this method returns false.

The current cell is a null reference (Nothing in Visual Basic) or read-only or invisible.

The cell Cell.EditType property is a null reference (Nothing in Visual Basic) (meaning the cell cannot host an editing control) and the cell type does not implement the IEditingCell interface.

The current row is read-only.

The GcMultiRow control is invisible or disabled or the GcMultiRow's ViewMode property value is ViewMode.Display.

The GcMultiRow control cannot get focus.

The CellBeginEdit event needs to be handled by the user and the CellBeginEditEventArgs's System.ComponentModel.CancelEventArgs.Cancel property needs to be true.

If the cell successfully enters edit mode, the IsCurrentCellInEditMode property returns true.

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

Reference

GcMultiRow Class
GcMultiRow Members