PasswordPropertyTextAttribute Class
TOC
Collapse the table of content
Expand the table of content

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)

System.Object
  System.Attribute
    System.ComponentModel.PasswordPropertyTextAttribute

[AttributeUsageAttribute(AttributeTargets.All)]
public sealed class PasswordPropertyTextAttribute : Attribute

NameDescription
System_CAPS_pubmethodPasswordPropertyTextAttribute()

Initializes a new instance of the PasswordPropertyTextAttribute class.

System_CAPS_pubmethodPasswordPropertyTextAttribute(Boolean)

Initializes a new instance of the PasswordPropertyTextAttribute class, optionally showing password text.

NameDescription
System_CAPS_pubpropertyPassword

Gets a value indicating if the property for which the PasswordPropertyTextAttribute is defined should be shown as password text.

System_CAPS_pubpropertyTypeId

When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether two PasswordPropertyTextAttribute instances are equal.(Overrides Attribute.Equals(Object).)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Overrides Attribute.GetHashCode().)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodIsDefaultAttribute()

Returns an indication whether the value of this instance is the default value.(Overrides Attribute.IsDefaultAttribute().)

System_CAPS_pubmethodMatch(Object)

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticDefault

Specifies the default value for the PasswordPropertyTextAttribute.

System_CAPS_pubfieldSystem_CAPS_staticNo

Specifies that a text property is not used as a password. This static (Shared in Visual Basic) field is read-only.

System_CAPS_pubfieldSystem_CAPS_staticYes

Specifies that a text property is used as a password. This static (Shared in Visual Basic) field is read-only.

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfoCount(UInt32)

Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.(Inherited from 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.

System_CAPS_cautionCaution

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.";
    }
}

.NET Framework
Available since 2.0

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

Return to top
Show:
© 2016 Microsoft