CredentialPickerOptions CredentialPickerOptions CredentialPickerOptions CredentialPickerOptions Class

Definition

Controls the appearance and behavior of a credential prompt.

public : sealed class CredentialPickerOptions : ICredentialPickerOptionspublic sealed class CredentialPickerOptions : ICredentialPickerOptionsPublic NotInheritable Class CredentialPickerOptions Implements ICredentialPickerOptions// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Note

: This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see Threading and Marshaling (C++/CX) and Using Windows Runtime objects in a multithreaded environment.

Constructors

CredentialPickerOptions() CredentialPickerOptions() CredentialPickerOptions() CredentialPickerOptions()

Creates and initializes a new, empty instance of the CredentialPickerOptions object.

public : CredentialPickerOptions()public CredentialPickerOptions()Public Sub New()// You can use this method in JavaScript.

Properties

AlwaysDisplayDialog AlwaysDisplayDialog AlwaysDisplayDialog AlwaysDisplayDialog

Gets or sets the option of whether the dialog box is displayed.

public : PlatForm::Boolean AlwaysDisplayDialog { get; set; }public bool AlwaysDisplayDialog { get; set; }Public ReadWrite Property AlwaysDisplayDialog As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

Gets or sets the option of always displaying the dialog box. The default value is False.

AuthenticationProtocol AuthenticationProtocol AuthenticationProtocol AuthenticationProtocol

Gets or sets the authentication protocol.

public : AuthenticationProtocol AuthenticationProtocol { get; set; }public AuthenticationProtocol AuthenticationProtocol { get; set; }Public ReadWrite Property AuthenticationProtocol As AuthenticationProtocol// You can use this property in JavaScript.
Value
AuthenticationProtocol AuthenticationProtocol AuthenticationProtocol AuthenticationProtocol

Name of the authentication protocol to use for credential authentication. The default value is Negotiate.

CallerSavesCredential CallerSavesCredential CallerSavesCredential CallerSavesCredential

Gets or sets whether the caller wants to save the credentials.

public : PlatForm::Boolean CallerSavesCredential { get; set; }public bool CallerSavesCredential { get; set; }Public ReadWrite Property CallerSavesCredential As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

Gets or sets whether the caller wants to save the credentials. The default value is False.

Remarks

If CallerSavesCredential is False and the user checks the Save Credentials check box, the entered credentials are stored in Credential Manager by default. However, if CallerSavesCredential is set to True and the user checks the Save Credentials check box, it is up to caller to store the entered credentials securely. For secure credential storage, please refer to Credential Locker.

Caption Caption Caption Caption

Gets or sets the caption text that is displayed to the user.

public : PlatForm::String Caption { get; set; }public string Caption { get; set; }Public ReadWrite Property Caption As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

Text that appears in the message header of the dialog box. The default value is the caller's app name.

CredentialSaveOption CredentialSaveOption CredentialSaveOption CredentialSaveOption

Gets or sets the option on saving credentials.

public : CredentialSaveOption CredentialSaveOption { get; set; }public CredentialSaveOption CredentialSaveOption { get; set; }Public ReadWrite Property CredentialSaveOption As CredentialSaveOption// You can use this property in JavaScript.
Value
CredentialSaveOption CredentialSaveOption CredentialSaveOption CredentialSaveOption

The option specifies the initial state of the dialog's "Save Credential" check box. The default value is clear (unchecked). This property is ignored if the caller specifies Hidden in the CredentialSaveOption enumeration.

CustomAuthenticationProtocol CustomAuthenticationProtocol CustomAuthenticationProtocol CustomAuthenticationProtocol

Gets or sets whether the authentication protocol is custom rather than a standard authentication protocol.

public : PlatForm::String CustomAuthenticationProtocol { get; set; }public string CustomAuthenticationProtocol { get; set; }Public ReadWrite Property CustomAuthenticationProtocol As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The authentication protocol is custom rather than a standard authentication protocol. The default value is none.

ErrorCode ErrorCode ErrorCode ErrorCode

Gets or sets the error code.

public : unsigned int ErrorCode { get; set; }public uint ErrorCode { get; set; }Public ReadWrite Property ErrorCode As uint// You can use this property in JavaScript.
Value
unsigned int uint uint uint

If nonzero, represents a Win32 ERROR_* status value that identifies the error information to be formatted and displayed in the dialog box. The default value is ERROR_SUCCESS if no error occurred.

Message Message Message Message

Gets or sets the body of text that displays to the user.

public : PlatForm::String Message { get; set; }public string Message { get; set; }Public ReadWrite Property Message As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

Text that appears in the message body of the dialog box. The default value is "Enter credentials" or localized equivalent.

PreviousCredential PreviousCredential PreviousCredential PreviousCredential

Gets or sets whether to fill dialog box fields with previous credentials.

public : IBuffer PreviousCredential { get; set; }public IBuffer PreviousCredential { get; set; }Public ReadWrite Property PreviousCredential As IBuffer// You can use this property in JavaScript.
Value
IBuffer IBuffer IBuffer IBuffer

Determines whether dialog box fields are filled with previous credentials. The default value is not to prepopulate the fields.

TargetName TargetName TargetName TargetName

Gets or sets the name of the target computer.

public : PlatForm::String TargetName { get; set; }public string TargetName { get; set; }Public ReadWrite Property TargetName As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

Name of the target computer. The default value is the caller's computer.