FormsAuthenticationEventArgs Classe

Définition

Fournit des données pour l’événement FormsAuthentication_OnAuthenticate.Provides data for the FormsAuthentication_OnAuthenticate event. Cette classe ne peut pas être héritée.This class cannot be inherited.

public ref class FormsAuthenticationEventArgs sealed : EventArgs
public sealed class FormsAuthenticationEventArgs : EventArgs
type FormsAuthenticationEventArgs = class
    inherit EventArgs
Public NotInheritable Class FormsAuthenticationEventArgs
Inherits EventArgs
Héritage
FormsAuthenticationEventArgs

Exemples

L’exemple de code suivant utilise l’événement FormsAuthentication_OnAuthenticate pour définir la propriété User du HttpContext actuel sur un objet GenericPrincipal avec une Identitypersonnalisée.The following code example uses the FormsAuthentication_OnAuthenticate event to set the User property of the current HttpContext to a GenericPrincipal object with a custom Identity.

public void FormsAuthentication_OnAuthenticate(object sender, FormsAuthenticationEventArgs args)
{
  if (FormsAuthentication.CookiesSupported)
  {
    if (Request.Cookies[FormsAuthentication.FormsCookieName] != null)
    {
      try
      {
        FormsAuthenticationTicket ticket = FormsAuthentication.Decrypt(
          Request.Cookies[FormsAuthentication.FormsCookieName].Value);
        
        args.User = new System.Security.Principal.GenericPrincipal(
          new Samples.AspNet.Security.MyFormsIdentity(ticket),
          new string[0]);
      }
      catch (Exception e)
      {
        // Decrypt method failed.
      }
    }
  }
  else
  {
    throw new HttpException("Cookieless Forms Authentication is not " +
                            "supported for this application.");
  }
}
Public Sub FormsAuthentication_OnAuthenticate(sender As Object, _
                                              args As FormsAuthenticationEventArgs)
  If FormsAuthentication.CookiesSupported Then
    If Not Request.Cookies(FormsAuthentication.FormsCookieName) Is Nothing Then
      Try
        Dim ticket As FormsAuthenticationTicket = FormsAuthentication.Decrypt( _
          Request.Cookies(FormsAuthentication.FormsCookieName).Value)
        
        args.User = New System.Security.Principal.GenericPrincipal( _
          New Samples.AspNet.Security.MyFormsIdentity(ticket), _
          New String(0) {})
      Catch e As HttpException
        ' Decrypt method failed.
      End Try
    End If
  Else
      Throw New Exception("Cookieless Forms Authentication is not " & _
                            "supported for this application.")
  End If
End Sub

Remarques

La classe FormsAuthenticationEventArgs est utilisée pour fournir des valeurs d’événement à l’événement FormsAuthentication_OnAuthenticate et pour vous permettre de spécifier une identité personnalisée pour la demande actuelle.The FormsAuthenticationEventArgs class is used to supply event values to the FormsAuthentication_OnAuthenticate event and to enable you to specify a custom identity for the current request.

L' FormsAuthenticationModule construit un objet FormsAuthenticationEventArgs à l’aide du HttpContext actuel et le passe à l’événement FormsAuthentication_OnAuthenticate .The FormsAuthenticationModule constructs a FormsAuthenticationEventArgs object using the current HttpContext and passes it to the FormsAuthentication_OnAuthenticate event.

Vous pouvez utiliser la propriété User pour définir la propriété User de la HttpContext actuelle sur un objet IPrincipal personnalisé.You can use the User property to set the User property of the current HttpContext to a custom IPrincipal object.

Si vous ne spécifiez pas de valeur pour la propriété User pendant l’événement FormsAuthentication_OnAuthenticate , l’identité fournie par le ticket d’authentification par formulaire dans le cookie ou l’URL est utilisée.If you do not specify a value for the User property during the FormsAuthentication_OnAuthenticate event, the identity supplied by the forms authentication ticket in the cookie or URL is used.

L’événement FormsAuthentication_OnAuthenticate est déclenché uniquement lorsque l' Mode d’authentification a la valeur Forms et que le FormsAuthenticationModule est un module http actif pour l’application.The FormsAuthentication_OnAuthenticate event is only raised when the authentication Mode is set to Forms and the FormsAuthenticationModule is an active HTTP module for the application.

Constructeurs

FormsAuthenticationEventArgs(HttpContext)

Initialise une nouvelle instance de la classe FormsAuthenticationEventArgs.Initializes a new instance of the FormsAuthenticationEventArgs class.

Propriétés

Context

Obtient l'objet HttpContext pour la requête HTTP actuelle.Gets the HttpContext object for the current HTTP request.

User

Obtient ou définit l'objet IPrincipal à associer à la demande en cours.Gets or sets the IPrincipal object to be associated with the current request.

Méthodes

Equals(Object)

Détermine si l'objet spécifié est égal à l'objet actuel.Determines whether the specified object is equal to the current object.

(Hérité de Object)
GetHashCode()

Sert de fonction de hachage par défaut.Serves as the default hash function.

(Hérité de Object)
GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Hérité de Object)
MemberwiseClone()

Crée une copie superficielle du Object actuel.Creates a shallow copy of the current Object.

(Hérité de Object)
ToString()

Retourne une chaîne qui représente l'objet actif.Returns a string that represents the current object.

(Hérité de Object)

S’applique à

Voir aussi