Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

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)

[AttributeUsageAttribute(AttributeTargets.All)] 
public sealed class PasswordPropertyTextAttribute : Attribute
/** @attribute AttributeUsageAttribute(AttributeTargets.All) */ 
public final class PasswordPropertyTextAttribute extends Attribute
AttributeUsageAttribute(AttributeTargets.All) 
public final class PasswordPropertyTextAttribute extends Attribute
Not applicable.

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.
[Category("Security")]
[Description("Demonstrates PasswordPropertyTextAttribute.")]
[PasswordPropertyText(true)]
public string Password
{
    get
    {
        return "This is a demo password.";
    }
}

System.Object
   System.Attribute
    System.ComponentModel.PasswordPropertyTextAttribute

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 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft