EditModeStarting Event

Occurs when edit mode is about to start in the active sheet's active cell.

Syntax

Visual Basic
C#

'Declaration
 
Public Event EditModeStarting As EditModeStartingEventHandler

'Usage
 
Dim instance As FpSpread
Dim handler As EditModeStartingEventHandler
 
AddHandler instance.EditModeStarting, handler

public event EditModeStartingEventHandler EditModeStarting

Event Data

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

Property	Description
Cancel	Gets or sets whether to cancel edit mode.
EditFormula	Gets or sets whether the formula for the cell should be edited.

Remarks

This event is raised by the OnEditModeStarting method when edit mode is about to start in the active sheet's active cell.

This event is useful for overriding the default behavior of the cell type to force editing of the formula or value for the cell. By default, cell types that implement IFormulaEditor edit the formula, and cell types that do not implement that interface edit the value.

For more details on the individual event arguments, refer to EditModeStartingEventArgs members.

For a discussion of edit mode and related properties, refer to Understanding Edit Mode.

Example

This example raises the event.

Label1.Text = "Edit mode starting fires the EditModeStarting event";

private void fpSpread1_EditModeStarting(object sender, System.EventArgs e)
{
     ListBox1.Items.Add("EditModeStarting event fired!");
}

Visual Basic

Label1.Text = "Edit mode starting fires the EditModeStarting event"

Private Sub FpSpread1_EditModeStarting(ByVal sender As Object, ByVal e As System.EventArgs) Handles FpSpread1.EditModeStarting
     ListBox1.Items.Add("EditModeStarting event fired!")
End Sub

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8

Reference

FpSpread Class
FpSpread Members
EditModeStartingEventArgs Class

User-Task Documentation

Understanding Edit Mode