ClientFormsAuthenticationCredentials Class

ClientFormsAuthenticationCredentials Class

.NET Framework (current version)
 

Represents user login information for forms authentication by using client application services.

Namespace:   System.Web.ClientServices.Providers
Assembly:  System.Web.Extensions (in System.Web.Extensions.dll)

System.Object
  System.Web.ClientServices.Providers.ClientFormsAuthenticationCredentials

public class ClientFormsAuthenticationCredentials

NameDescription
System_CAPS_pubmethodClientFormsAuthenticationCredentials(String, String, Boolean)

Initializes a new instance of the ClientFormsAuthenticationCredentials class.

NameDescription
System_CAPS_pubpropertyPassword

Gets or sets the user password.

System_CAPS_pubpropertyRememberMe

Gets or sets a value indicating whether the user credentials should be saved and reused for subsequent login attempts.

System_CAPS_pubpropertyUserName

Gets or sets the user name.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

The ClientFormsAuthenticationCredentials class is used by the IClientFormsAuthenticationCredentialsProvider interface. When you implement this interface, you must return a populated instance of this class in your GetCredentials implementation.

The following example code demonstrates how to implement the IClientFormsAuthenticationCredentialsProvider.GetCredentials method, which returns an instance of this class. In this example, the GetCredentials method is part of a login dialog box class. The method displays the dialog box, and then returns a ClientFormsAuthenticationCredentials instance initialized with the user-specified values.

public ClientFormsAuthenticationCredentials GetCredentials()
{
    if (this.ShowDialog() == DialogResult.OK)
    {
        return new ClientFormsAuthenticationCredentials(
            usernameTextBox.Text, passwordTextBox.Text,
            rememberMeCheckBox.Checked);
    }
    else
    {
        return null;
    }
}

.NET Framework
Available since 3.5

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft