ClientFormsAuthenticationCredentials
Class
Definition
Represents user login information for forms authentication by using client application services.
public class ClientFormsAuthenticationCredentials
- Inheritance
-
ClientFormsAuthenticationCredentials
Inherited Members
System.Object
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. |