VpnCustomPromptTextInput VpnCustomPromptTextInput VpnCustomPromptTextInput VpnCustomPromptTextInput Class

Definition

Represents a text input UI element used in the RequestCustomPromptAsync method.

public : sealed class VpnCustomPromptTextInput : IVpnCustomPromptElement, IVpnCustomPromptTextInputpublic sealed class VpnCustomPromptTextInput : IVpnCustomPromptElement, IVpnCustomPromptTextInputPublic NotInheritable Class VpnCustomPromptTextInput Implements IVpnCustomPromptElement, IVpnCustomPromptTextInput// This API is not available in Javascript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

Constructors

VpnCustomPromptTextInput() VpnCustomPromptTextInput() VpnCustomPromptTextInput() VpnCustomPromptTextInput()

Allows VPN plug-ins to create a text input UI element object to be used in the RequestCustomPromptAsync method.

public : VpnCustomPromptTextInput()public VpnCustomPromptTextInput()Public Sub New()// This API is not available in Javascript.
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

Properties

Compulsory Compulsory Compulsory Compulsory

Gets or sets whether the user must provide some text input in this element before the UI flow of the can continue (the next button is grayed out).

public : PlatForm::Boolean Compulsory { get; set; }public bool Compulsory { get; set; }Public ReadWrite Property Compulsory As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

If the user must provide some text input, it is TRUE; otherwise , it is FALSE.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

DisplayName DisplayName DisplayName DisplayName

Gets or sets the text label of the text input UI element.

public : PlatForm::String DisplayName { get; set; }public string DisplayName { get; set; }Public ReadWrite Property DisplayName As string// This API is not available in Javascript.
Value
PlatForm::String string string string

The text label of the text input UI element.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

Emphasized Emphasized Emphasized Emphasized

Gets or sets whether the text input UI element is emphasized.

public : PlatForm::Boolean Emphasized { get; set; }public bool Emphasized { get; set; }Public ReadWrite Property Emphasized As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

If the text input UI element is emphasized, it is TRUE; otherwise , it is FALSE.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

IsTextHidden IsTextHidden IsTextHidden IsTextHidden

Gets or sets whether the text typed into the text input UI element must be hidden by showing different characters. This is typically used when the input is expected to be a password, other text credential, or secret.

public : PlatForm::Boolean IsTextHidden { get; set; }public bool IsTextHidden { get; set; }Public ReadWrite Property IsTextHidden As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

If the text typed into the text input UI element must be hidden , it is TRUE; otherwise , it is FALSE.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

PlaceholderText PlaceholderText PlaceholderText PlaceholderText

Gets or sets the text that is displayed as grayed out when the text input UI element does not contain any text typed by the user. This can be sample text.

public : PlatForm::String PlaceholderText { get; set; }public string PlaceholderText { get; set; }Public ReadWrite Property PlaceholderText As string// This API is not available in Javascript.
Value
PlatForm::String string string string

Sample text that is displayed as grayed out when the text input UI element does not contain any text typed by the user.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

Text Text Text Text

Gets the text typed into the text input UI element.

public : PlatForm::String Text { get; }public string Text { get; }Public ReadOnly Property Text As string// This API is not available in Javascript.
Value
PlatForm::String string string string

The text typed into the text input UI element.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider