LoginCancelEventArgs Class
Collapse the table of content
Expand the table of content

LoginCancelEventArgs Class


Provides data for a cancelable event.

Namespace:   System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)


public class LoginCancelEventArgs : EventArgs


Initializes a new instance of the LoginCancelEventArgs class with the Cancel property set to false.


Initializes a new instance of the LoginCancelEventArgs class with the Cancel property set to the specified value.


Gets or sets a value indicating whether the event should be canceled.


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Serves as the default hash function. (Inherited from Object.)


Gets the Type of the current instance.(Inherited from Object.)


Creates a shallow copy of the current Object.(Inherited from Object.)


Returns a string that represents the current object.(Inherited from Object.)

A cancelable event is raised when a component is about to perform an action that can be canceled, such as logging on to a Web site.

The LoginCancelEventArgs class provides the Cancel property to indicate whether the event should be canceled. A LoginCancelEventArgs object is used with controls that have cancelable actions, such as the Login control, the CreateUserWizard control, and the PasswordRecovery control.

The following code example uses the LoggingIn event to ensure that the user has entered a well-formed e-mail address in the UserName property. If not, the LoggingIn event handler cancels the logon attempt by setting the Cancel property of the LoginCancelEventArgs object to true.Then the error message specified in the InstructionText property is displayed.

public partial class LoginCancelEventArgscs_aspx : System.Web.UI.Page

    bool IsValidEmail(string strIn)
        // Return true if strIn is in valid e-mail format.
        return System.Text.RegularExpressions.Regex.IsMatch(strIn, 

    protected void OnLoggingIn(object sender, System.Web.UI.WebControls.LoginCancelEventArgs e)
        if (!IsValidEmail(Login1.UserName))
            Login1.InstructionText = "You must enter a valid e-mail address.";
            e.Cancel = true;
            Login1.InstructionText = String.Empty;

The following is the .aspx file that can be used to run the preceding example.

.NET Framework
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
© 2015 Microsoft