FormsAuthenticationEventArgs Classe

Definição

Fornece dados para o evento FormsAuthentication_OnAuthenticate.Provides data for the FormsAuthentication_OnAuthenticate event. Essa classe não pode ser herdada.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
Herança
FormsAuthenticationEventArgs

Exemplos

O exemplo de código a seguir usa o evento FormsAuthentication_OnAuthenticate para definir a User Propriedade do atual HttpContext como um GenericPrincipal objeto com um personalizado Identity .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

Comentários

A FormsAuthenticationEventArgs classe é usada para fornecer valores de evento para o evento FormsAuthentication_OnAuthenticate e para permitir que você especifique uma identidade personalizada para a solicitação atual.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.

O FormsAuthenticationModule constrói um FormsAuthenticationEventArgs objeto usando o atual HttpContext e o passa para o evento FormsAuthentication_OnAuthenticate .The FormsAuthenticationModule constructs a FormsAuthenticationEventArgs object using the current HttpContext and passes it to the FormsAuthentication_OnAuthenticate event.

Você pode usar a User propriedade para definir a User Propriedade do atual HttpContext como um objeto personalizado IPrincipal .You can use the User property to set the User property of the current HttpContext to a custom IPrincipal object.

Se você não especificar um valor para a User Propriedade durante o evento FormsAuthentication_OnAuthenticate , a identidade fornecida pelo tíquete de autenticação de formulários no cookie ou na URL será usada.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.

O evento FormsAuthentication_OnAuthenticate só é gerado quando a autenticação Mode é definida como Forms e o FormsAuthenticationModule é um módulo http ativo para o aplicativo.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.

Construtores

FormsAuthenticationEventArgs(HttpContext)

Inicializa uma nova instância da classe FormsAuthenticationEventArgs.Initializes a new instance of the FormsAuthenticationEventArgs class.

Propriedades

Context

Obtém o objeto HttpContext para a solicitação HTTP atual.Gets the HttpContext object for the current HTTP request.

User

Obtém ou define o objeto IPrincipal a ser associado à solicitação atual.Gets or sets the IPrincipal object to be associated with the current request.

Métodos

Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.Determines whether the specified object is equal to the current object.

(Herdado de Object)
GetHashCode()

Serve como a função de hash padrão.Serves as the default hash function.

(Herdado de Object)
GetType()

Obtém o Type da instância atual.Gets the Type of the current instance.

(Herdado de Object)
MemberwiseClone()

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

(Herdado de Object)
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object.

(Herdado de Object)

Aplica-se a