MaskedTextProvider.ToString Method (Boolean, Boolean)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns the formatted string, optionally including prompt and literal characters.

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)

public string ToString(
	bool includePrompt,
	bool includeLiterals
)

Parameters

includePrompt
Type: System.Boolean

true to include prompt characters in the return string; otherwise, false.

includeLiterals
Type: System.Boolean

true to include literal characters in the return string; otherwise, false.

Return Value

Type: System.String

The formatted String that includes all the assigned character values and optionally includes literals and prompts.

This version of the overloaded ToString method includes prompts and literals according to the values of the IncludePrompt and IncludeLiterals parameters, respectively. Notice that these parameters override the values of the IncludePromptIncludeLiterals properties. This method will always return the original input characters, ignoring the value of the PasswordChar property.

System_CAPS_importantImportant

Because this method reveals information that is usually protected in the user interface by password characters, it should be used with extreme caution to avoid accidentally revealing sensitive user data.

.NET Framework
Available since 2.0
Return to top
Show: