FormsAuthenticationEventArgs Třída
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Poskytuje data pro událost FormsAuthentication_OnAuthenticate . Tuto třídu nelze zdě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
Příklady
Následující příklad kódu používá FormsAuthentication_OnAuthenticate událost k nastavení User vlastnosti aktuálního HttpContext objektu GenericPrincipal s vlastním 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 zadání hodnot událostí do události FormsAuthentication_OnAuthenticate a k povolení zadat vlastní identitu pro aktuální požadavek.
Vytvoří FormsAuthenticationModule objekt pomocí aktuálního HttpContext objektu a předá ho FormsAuthentication_OnAuthenticateFormsAuthenticationEventArgs události.
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é Forms na a FormsAuthenticationModule je aktivním modulem HTTP pro aplikaci.
Konstruktory
| Name | Description |
|---|---|
| FormsAuthenticationEventArgs(HttpContext) |
Inicializuje novou instanci FormsAuthenticationEventArgs třídy. |
Vlastnosti
| Name | Description |
|---|---|
| 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
| Name | Description |
|---|---|
| Equals(Object) |
Určuje, zda je zadaný objekt roven aktuálnímu objektu. (Zděděno od Object) |
| GetHashCode() |
Slouží jako výchozí funkce hash. (Zděděno od Object) |
| GetType() |
Získá Type aktuální instance. (Zděděno od Object) |
| MemberwiseClone() |
Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object) |
| ToString() |
Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object) |