PasswordPropertyTextAttribute Class

Definition

Namespace:

System.ComponentModel

Assembly:

System.ComponentModel.TypeConverter.dll

Source:

PasswordPropertyTextAttribute.cs

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

public ref class PasswordPropertyTextAttribute sealed : Attribute

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

[<System.AttributeUsage(System.AttributeTargets.All)>]
type PasswordPropertyTextAttribute = class
    inherit Attribute

Public NotInheritable Class PasswordPropertyTextAttribute
Inherits Attribute

Inheritance

Object

Attribute

PasswordPropertyTextAttribute

Attributes

AttributeUsageAttribute

Examples

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

' 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 ReadOnly Property Password() As String
    Get
        Return "This is a demo password."
    End Get
End Property

Remarks

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

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

Constructors

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

Fields

Default	Specifies the default value for the PasswordPropertyTextAttribute.
No	Specifies that a text property is not used as a password. This static (Shared in Visual Basic) field is read-only.
Yes	Specifies that a text property is used as a password. This static (Shared in Visual Basic) field is read-only.

Properties

Password	Gets a value indicating if the property for which the PasswordPropertyTextAttribute is defined should be shown as password text.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Determines whether two PasswordPropertyTextAttribute instances are equal.
GetHashCode()	Returns the hash code for this instance.
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	Returns an indication whether the value of this instance is the default value.
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)