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


Glossary Item Box

Occurs when the use of a command button causes an error.

Syntax

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

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

The ErrorCommand command name can be one of the following values:

Error Description
InvalidInput Input values are not valid
UpdateFailed Spread failed to update the data model
InsertFailed FarPoint could not insert the new row to the data model
DeleteFailed FarPoint could not delete the specified row.

The ErrorCommand command argument is the index of the row being acted on.

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
private void FpSpread1ErrorCommand(object sender, FarPoint.Web.Spread.SpreadCommandEventArgs e) 
{
    if (e.CommandName == "InsertFailed")
    {
        TextBox1.Text = "Insert of row failed.";
    }
}
Visual BasicCopy Code
Private Sub FpSpread1ErrorCommand(ByVal sender As System.Object, ByVal e As FarPoint.Web.Spread.SpreadCommandEventArgs) Handles
FpSpread1.ErrorCommand
    If e.CommandName = "InsertFailed" Then
        TextBox1.Text = "Insert of row failed."
    End If
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.