LoginCancelEventArgs Class

Provides data for a cancelable event.

System.Object
  System.EventArgs
    System.Web.UI.WebControls.LoginCancelEventArgs
      System.Web.UI.WebControls.MailMessageEventArgs

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

type LoginCancelEventArgs =  
    class 
        inherit EventArgs 
    end

The LoginCancelEventArgs type exposes the following members.

  NameDescription
Public methodLoginCancelEventArgs()Initializes a new instance of the LoginCancelEventArgs class with the Cancel property set to false.
Public methodLoginCancelEventArgs(Boolean)Initializes a new instance of the LoginCancelEventArgs class with the Cancel property set to the specified value.
Top

  NameDescription
Public propertyCancelGets or sets a value indicating whether the event should be canceled.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

No code example is currently available or this language may not be supported.

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

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft