FormsAuthenticationEventArgs Třída

  • Reference

Definice

Obor názvů:
System.Web.Security
Sestavení:
System.Web.dll

Poskytuje data pro událost FormsAuthentication_OnAuthenticate . Tato třída se nemůže dědit.

public ref class FormsAuthenticationEventArgs sealed : EventArgs
public sealed class FormsAuthenticationEventArgs : EventArgs
type FormsAuthenticationEventArgs = class
    inherit EventArgs
Public NotInheritable Class FormsAuthenticationEventArgs
Inherits EventArgs
Dědičnost
Object
EventArgs
FormsAuthenticationEventArgs

Příklady

Následující příklad kódu používá událost FormsAuthentication_OnAuthenticate k nastavení User vlastnosti current HttpContext na GenericPrincipal objekt s vlastní 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

Poznámky

Třída FormsAuthenticationEventArgs se používá k poskytování hodnot událostí FormsAuthentication_OnAuthenticate události a umožňuje zadat vlastní identitu pro aktuální požadavek.

Objekt FormsAuthenticationModule vytvoří FormsAuthenticationEventArgs pomocí aktuálního HttpContext objektu a předá ho události FormsAuthentication_OnAuthenticate .

Vlastnost můžete použít User k nastavení User vlastnosti aktuální HttpContext na vlastní IPrincipal objekt.

Pokud během události FormsAuthentication_OnAuthenticate nezadáte hodnotu User vlastnosti, použije se identita zadaná lístkem ověřování formulářů v souboru cookie nebo adrese URL.

Událost FormsAuthentication_OnAuthenticate se vyvolá pouze v případě, že je ověřování Mode nastavené na Forms a FormsAuthenticationModule je aktivní modul HTTP pro aplikaci.

Konstruktory

FormsAuthenticationEventArgs(HttpContext)

Inicializuje novou instanci FormsAuthenticationEventArgs třídy.

Vlastnosti

Context

HttpContext Získá objekt pro aktuální požadavek HTTP.
User

Získá nebo nastaví IPrincipal objekt, který má být přidružen k aktuálnímu požadavku.

Metody

Equals(Object)

Určí, zda se zadaný objekt rovná aktuálnímu objektu.

(Zděděno od Object)
GetHashCode()

Slouží jako výchozí hashovací funkce.

(Zděděno od Object)
GetType()

Získá aktuální Type instanci.

(Zděděno od Object)
MemberwiseClone()

Vytvoří mělkou kopii aktuálního Objectsouboru .

(Zděděno od Object)
ToString()

Vrátí řetězec, který představuje aktuální objekt.

(Zděděno od Object)

Platí pro

Viz také