FormsAuthenticationEventArgs Класс

Определение

Предоставляет данные для события FormsAuthentication_OnAuthenticate.Provides data for the FormsAuthentication_OnAuthenticate event. Этот класс не наследуется.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
Наследование
FormsAuthenticationEventArgs

Примеры

В следующем примере кода событие FormsAuthentication_OnAuthenticate используется User для задания свойства Current HttpContext для GenericPrincipal объекта с пользовательским 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

Комментарии

Класс используется для предоставления значений событий событию FormsAuthentication_OnAuthenticate и позволяет указать настраиваемое удостоверение для текущего запроса. **** FormsAuthenticationEventArgsThe 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.

Конструирует объект с помощью текущего HttpContext объекта и передает его в событие FormsAuthentication_OnAuthenticate. **** FormsAuthenticationModule FormsAuthenticationEventArgsThe FormsAuthenticationModule constructs a FormsAuthenticationEventArgs object using the current HttpContext and passes it to the FormsAuthentication_OnAuthenticate event.

С помощью User свойства можно User задать свойство Current HttpContext для пользовательского IPrincipal объекта.You can use the User property to set the User property of the current HttpContext to a custom IPrincipal object.

Если не указать значение User свойства во время события FormsAuthentication_OnAuthenticate , будет использоваться удостоверение, предоставленное билетом проверки подлинности форм в файле cookie или URL-адресе.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.

Событие FormsAuthentication_OnAuthenticate возникает только в том случае, если Mode для проверки подлинности FormsAuthenticationModule задано значение Forms и является активным модулем HTTP для приложения.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.

Конструкторы

FormsAuthenticationEventArgs(HttpContext)

Инициализирует новый экземпляр класса FormsAuthenticationEventArgs.Initializes a new instance of the FormsAuthenticationEventArgs class.

Свойства

Context

Возвращает объект HttpContext для текущего HTTP-запроса.Gets the HttpContext object for the current HTTP request.

User

Получает или задает объект IPrincipal, который будет связан с текущим запросом.Gets or sets the IPrincipal object to be associated with the current request.

Методы

Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

Применяется к

Дополнительно