Spread Windows Forms 6.0 Product Documentation
EditModeStarting Event
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace > FpSpread Class : EditModeStarting Event


Glossary Item Box

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

Syntax

Visual Basic (Declaration) 
Public Event EditModeStarting As EditModeStartingEventHandler
Visual Basic (Usage)Copy Code
Dim instance As FpSpread
Dim handler As EditModeStartingEventHandler
 
AddHandler instance.EditModeStarting, handler
C# 
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.

PropertyDescription
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.
C#Copy Code
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 BasicCopy Code
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 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

© 2002-2012 ComponentOne, a division of GrapeCity. All Rights Reserved.