ClientFormsAuthenticationCredentials Class

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.

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

public ref class ClientFormsAuthenticationCredentials

public class ClientFormsAuthenticationCredentials

type ClientFormsAuthenticationCredentials = class

Public Class ClientFormsAuthenticationCredentials

Inheritance: Object
ClientFormsAuthenticationCredentials

Examples

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;
    }
}

Public Function GetCredentials() As  _
    ClientFormsAuthenticationCredentials Implements _
    IClientFormsAuthenticationCredentialsProvider.GetCredentials

    If Me.ShowDialog() = DialogResult.OK Then
        Return New ClientFormsAuthenticationCredentials( _
            UsernameTextBox.Text, PasswordTextBox.Text, _
            rememberMeCheckBox.Checked)
    Else
        Return Nothing
    End If

End Function

Remarks

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.

Constructors

ClientFormsAuthenticationCredentials(String, String, Boolean)

Initializes a new instance of the ClientFormsAuthenticationCredentials class.

Properties

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

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

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