MaskedTextProvider.ToString Method (Boolean, Boolean)

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 IncludePrompt IncludeLiterals properties. This method will always return the original input characters, ignoring the value of the PasswordChar property.

Important noteImportant

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

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft