This documentation is archived and is not being maintained.

PasswordPropertyTextAttribute Class

Indicates that an object's text representation is obscured by characters such as asterisks. This class cannot be inherited.

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

public sealed class PasswordPropertyTextAttribute : Attribute

If the PasswordPropertyTextAttribute attribute is placed on a property or a type, its text representation in a property window appears as dots or asterisks to indicate a password field.

Caution noteCaution:

This indication in no way represents any type of encryption or security. For more information about using attributes, see Extending Metadata Using Attributes.

The following code example demonstrates using the PasswordPropertyTextAttribute to obscure the value of a string property in a PropertyGrid control. For a full code listing, see How to: Apply Attributes in Windows Forms Controls.

// This property exists only to demonstrate the  
// PasswordPropertyText attribute. When this control  
// is attached to a PropertyGrid control, the returned  
// string will be displayed with obscuring characters 
// such as asterisks. This property has no other effect.
[Description("Demonstrates PasswordPropertyTextAttribute.")]
public string Password
        return "This is a demo password.";


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0