 | CredentialDialog Class |
Represents a dialog box that allows the user to enter generic credentials.
Inheritance HierarchyNamespace: Ookii.Dialogs
Assembly: Ookii.Dialogs (in Ookii.Dialogs.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxThe CredentialDialog type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CredentialDialog |
Initializes a new instance of the CredentialDialog class.
|
| CredentialDialog(IContainer) |
Initializes a new instance of the CredentialDialog class with the specified container.
|
Properties| Name | Description | |
|---|---|---|
 | CanRaiseEvents | Gets a value indicating whether the component can raise an event. (Inherited from Component.) |
 | Container | Gets the IContainer that contains the Component. (Inherited from Component.) |
| Content |
Gets or sets additional text to display in the dialog.
|
| Credentials |
Gets the user-specified user name and password in a NetworkCredential object.
|
| DesignMode | Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.) |
| DownlevelTextMode |
Gets or sets a value that indicates how the text of the MainInstruction and Content properties
is displayed on Windows XP.
|
| Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component.) |
| IsSaveChecked |
Gets or sets whether the "save password" checkbox is checked.
|
| IsStoredCredential |
Gets a value that indicates whether the current credentials were retrieved from a credential store.
|
| MainInstruction |
Gets or sets a brief message to display in the dialog box.
|
| Password |
Gets the password the user entered in the dialog.
|
| ShowSaveCheckBox |
Gets or sets a value that indicates whether a check box is shown on the dialog that allows the user to choose whether to save
the credentials or not.
|
| ShowUIForSavedCredentials |
Gets or sets a value that indicates whether the dialog should be displayed even when saved credentials exist for the
specified target.
|
| Site | (Inherited from Component.) |
| Target |
Gets or sets the target for the credentials, typically a server name.
|
| UseApplicationInstanceCredentialCache |
Gets or sets whether to use the application instance credential cache.
|
| UserName |
Gets the user name the user entered in the dialog.
|
| WindowTitle |
Gets or sets the title of the credentials dialog.
|
Methods| Name | Description | |
|---|---|---|
| ConfirmCredentials |
Confirms the validity of the credential provided by the user.
|
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
 | DeleteCredential |
Deletes the credentials for the specified target.
|
| Dispose | Releases all resources used by the Component. (Inherited from Component.) |
 | Dispose(Boolean) |
Clean up any resources being used.
(Overrides ComponentDispose(Boolean).) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| GetService | (Inherited from Component.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
| OnPasswordChanged |
Raises the PasswordChanged event.
|
| OnUserNameChanged |
Raises the UserNameChanged event.
|
| RetrieveCredential |
Retrieves credentials for the specified target from the operating system's credential store for the current user.
|
| RetrieveCredentialFromApplicationInstanceCache |
Tries to get the credentials for the specified target from the application instance credential cache.
|
| ShowDialog |
Shows the credentials dialog as a modal dialog.
|
| ShowDialog(IWin32Window) |
Shows the credentials dialog as a modal dialog with the specified owner.
|
| StoreCredential |
Stores the specified credentials in the operating system's credential store for the currently logged on user.
|
| ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.) |
Events| Name | Description | |
|---|---|---|
 | Disposed | Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.) |
| PasswordChanged |
Event raised when the Password property changes.
|
| UserNameChanged |
Event raised when the UserName property changes.
|
RemarksThis class is meant for generic credentials; it does not provide access to all the functionality of the Windows CredUI API. Features such as Windows domain credentials or alternative security providers (e.g. smartcards or biometric devices) are not supported.
The CredentialDialog class provides methods for storing and retrieving credentials, and also manages automatic persistence of credentials by using the "Save password" checkbox on the credentials dialog. To specify the target for which the credentials should be saved, set the Target property.
 Note |
|---|
| This class requires Windows XP or later. |
Thread SafetyAny public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also