Export (0) Print
Expand All

PasswordPropertyTextAttribute Class

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

System.Object
  System.Attribute
    System.ComponentModel.PasswordPropertyTextAttribute

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

'Declaration
<AttributeUsageAttribute(AttributeTargets.All)> _
Public NotInheritable Class PasswordPropertyTextAttribute _
	Inherits Attribute

The PasswordPropertyTextAttribute type exposes the following members.

  NameDescription
Public methodPasswordPropertyTextAttributeInitializes a new instance of the PasswordPropertyTextAttribute class.
Public methodPasswordPropertyTextAttribute(Boolean)Initializes a new instance of the PasswordPropertyTextAttribute class, optionally showing password text.
Top

  NameDescription
Public propertyPasswordGets a value indicating if the property for which the PasswordPropertyTextAttribute is defined should be shown as password text.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top

  NameDescription
Public methodEqualsDetermines whether two PasswordPropertyTextAttribute instances are equal. (Overrides Attribute.Equals(Object).)
Public methodGetHashCodeReturns the hash code for this instance. (Overrides Attribute.GetHashCode.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeReturns an indication whether the value of this instance is the default value. (Overrides Attribute.IsDefaultAttribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public fieldStatic memberDefaultSpecifies the default value for the PasswordPropertyTextAttribute.
Public fieldStatic memberNoSpecifies that a text property is not used as a password. This static (Shared in Visual Basic) field is read-only.
Public fieldStatic memberYesSpecifies that a text property is used as a password. This static (Shared in Visual Basic) field is read-only.
Top

  NameDescription
Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

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

.NET Framework

Supported in: 4.6, 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.

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