ClientFormsAuthenticationMembershipProvider.UserValidated Event

Reference

Definition

Namespace:: System.Web.ClientServices.Providers

Assembly:: System.Web.Extensions.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Occurs when the user is validated.

public:
 event EventHandler<System::Web::ClientServices::Providers::UserValidatedEventArgs ^> ^ UserValidated;

public event EventHandler<System.Web.ClientServices.Providers.UserValidatedEventArgs> UserValidated;

member this.UserValidated : EventHandler<System.Web.ClientServices.Providers.UserValidatedEventArgs>

Public Custom Event UserValidated As EventHandler(Of UserValidatedEventArgs)

Public Event UserValidated As EventHandler(Of UserValidatedEventArgs)

Event Type

EventHandler<UserValidatedEventArgs>

Examples

The following example code demonstrates how to use this event to display the user name in the title bar of a form.

private ClientFormsAuthenticationMembershipProvider formsMembershipProvider =
    (ClientFormsAuthenticationMembershipProvider)
    System.Web.Security.Membership.Provider;
private String appName = "ClientAppServicesDemo";

private void AttachUserValidatedEventHandler()
{
    formsMembershipProvider.UserValidated += 
        new EventHandler<UserValidatedEventArgs>(Form1_UserValidated);
}

private void Form1_UserValidated(object sender, UserValidatedEventArgs e)
{
    // Set the form's title bar to the application name and the user name.
    this.Text = String.Format("{0} ({1})", appName, e.UserName);
}

Private WithEvents formsMembershipProvider As  _
    ClientFormsAuthenticationMembershipProvider = _
    System.Web.Security.Membership.Provider

Private appName As String = "ClientAppServicesDemo"

Private Sub Form1_UserValidated(ByVal sender As Object, _
    ByVal e As UserValidatedEventArgs) _
    Handles formsMembershipProvider.UserValidated

    ' Set the form's title bar to the application name and the user name.
    Me.Text = String.Format("{0} ({1})", appName, e.UserName)

End Sub

Remarks

This event occurs only after the user is successfully validated. You can use this event to update your application to reflect the current user. For example, you can use the UserValidatedEventArgs.UserName property to display the user name in your application user interface (UI).

You can silently revalidate users by calling the ClientFormsIdentity.RevalidateUser method. Therefore, you should avoid using the UserValidated event to display intrusive UI. For example, you should not use the UserValidated event to display a welcome dialog box.

Applies to

Product	Versions
.NET Framework	3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Share via