SpreadsheetGear The Performance Spreadsheet Component Company 
CellBeginEdit Event
See Also  Example
SpreadsheetGear.Windows.Forms Namespace > WorkbookView Class : CellBeginEdit Event
Occurs when edit mode is being initiated.

Syntax

C# 
[DescriptionAttribute("Occurs when edit mode begins.")]
[CategoryAttribute("Data")]
public event CellBeginEditEventHandler CellBeginEdit()

Event Data

The event handler receives an argument of type CellBeginEditEventArgs containing data related to this event. The following CellBeginEditEventArgs properties provide information specific to this event.

PropertyDescription
Cancel Gets or sets the value which specifies whether the event should be canceled.
Entry Gets or sets the edit entry text.

Example

C#Copy Code
/* 
  * Sets the initial entry text to "Jim" when entry mode is initiated for cell B1. 
  *  
  * Cancels entry mode for any cell other than B1. 
  */ 
 private void workbookView_CellBeginEdit(object sender,  
     SpreadsheetGear.Windows.Forms.CellBeginEditEventArgs e) 
 { 
     // Acquire a workbook set lock. 
     workbookView.GetLock(); 
     try 
     { 
         // Get a reference to the active worksheet's cells. 
         SpreadsheetGear.IRange cells = workbookView.ActiveWorksheet.Cells; 
  
         // Check if the correct cell is selected. 
         if (workbookView.RangeSelection.Equals(cells["B1"])) 
             // Change the entry text to "Jim". 
             e.Entry = "Jim"; 
         else 
             // Cancel CellBeginEdit. 
             e.Cancel = true; 
     } 
     finally 
     { 
         // Release the workbook set lock. 
         workbookView.ReleaseLock(); 
     } 
 } 
    

Remarks

The CellBeginEdit event occurs when edit mode is being initiated, and provides the event handler with the ability to modify the text to be edited or cancel edit mode.

The CellBeginEdit event is always invoked on the thread which created the workbook view control, and a lock is always acquired on the workbook set associated with the workbook view control before CellBeginEdit is invoked.

Requirements

Platforms: Windows 98, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family. SpreadsheetGear for .NET 1.x requires the Microsoft .NET Framework 1.1 or .NET 2.0. SpreadsheetGear for .NET 2006 requires the Microsoft .NET Framework 2.0.

See Also