SpreadsheetGear
CellBeginEdit Event
See Also  Example Send Feedback
SpreadsheetGear.Windows.Forms Namespace > WorkbookView Class : CellBeginEdit Event

Occurs when edit mode is being initiated.

Syntax

Visual Basic (Declaration) 
<DescriptionAttribute("Occurs when edit mode begins.")>
<CategoryAttribute("Data")>
Public Event CellBeginEdit() As CellBeginEditEventHandler
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: x86 and x64 versions of Windows 2000, Windows XP, Windows Vista, Windows 7, Windows Server 2003 (including R2) and Windows Server 2008 (including R2). SpreadsheetGear 2009 requires the Microsoft .NET Framework 2.0 and supports .NET 3.0 and .NET 3.5.

See Also

Copyright © 2003-2009 SpreadsheetGear LLC. All Rights Reserved.Help Powered by Innovasys   
SpreadsheetGear is a registered trademark of SpreadsheetGear LLC.
Microsoft, Microsoft Excel and Visual Studio are trademarks or registered trademarks of Microsoft Corporation.