Spread for ASP.NET 7.0 Product Documentation
DeleteCommand Event
See Also  Example Support Options
FarPoint.Web.Spread Assembly > FarPoint.Web.Spread Namespace > FpSpread Class : DeleteCommand Event


Glossary Item Box

Occurs when the user clicks the Delete button on the component.

Syntax

Visual Basic (Declaration) 
Public Event DeleteCommand As SpreadCommandEventHandler
Visual Basic (Usage)Copy Code
Dim instance As FpSpread
Dim handler As SpreadCommandEventHandler
 
AddHandler instance.DeleteCommand, handler
C# 
public event SpreadCommandEventHandler DeleteCommand

Event Data

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

PropertyDescription
CommandArgument (Inherited from System.Web.UI.WebControls.CommandEventArgs)Gets the argument for the command.
CommandName (Inherited from System.Web.UI.WebControls.CommandEventArgs)Gets the name of the command.
EditValues Gets the postback data in an array list of values.
Handled Gets or sets whether the event has been handled.
SheetView Gets the sheet being updated.
SortFrozenRows Gets or sets whether the frozen rows should be sorted when the sorting command occurs.

Remarks

To display the Delete button, set the SheetView AllowDelete property to true.

You can write code in this event to perform actions when the row is deleted.

The SpreadCommandEventHandler receives an argument of type SpreadCommandEventArgs containing data related to this event.

Example

This example illustrates the use of the event.
C#Copy Code
FpSpread1.ActiveSheetView.AllowDelete = true;
FpSpread1.ActiveSheetView.AllowInsert = true;

private void FpSpread1DeleteCommand(object sender, FarPoint.Web.Spread.SpreadCommandEventArgs e) 
{
    TextBox1.Text = "The deleted row was row #" + e.CommandArgument;
}
Visual BasicCopy Code
FpSpread1.ActiveSheetView.AllowDelete = True
FpSpread1.ActiveSheetView.AllowInsert = True

Private Sub FpSpread1DeleteCommand(ByVal sender As Object, ByVal e As FarPoint.Web.Spread.SpreadCommandEventArgs) Handles
FpSpread1.DeleteCommand
    TextBox1.Text = "The deleted row was row #" & e.CommandArgument
End Sub

Requirements

Target Platforms: Windows 7, Windows 8, Windows Vista, Windows Server 2000, Windows 2000 Professional, Windows XP Professional, Windows NT 4.0 Workstation, SP6, Windows NT 4.0 Server, SP6

See Also

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