Skip to main content
.NET Framework Class Library
DefaultPropertyAttribute Class

Specifies the default property for a component.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.ComponentModelDefaultPropertyAttribute

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)
Syntax
<[%$TOPIC/6tbassey_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/6tbassey_en-us_VS_110_2_0_0_0_1%].Class)> _
Public NotInheritable Class DefaultPropertyAttribute _
	Inherits [%$TOPIC/6tbassey_en-us_VS_110_2_0_0_0_2%]
[[%$TOPIC/6tbassey_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/6tbassey_en-us_VS_110_2_0_1_0_1%].Class)]
public sealed class DefaultPropertyAttribute : [%$TOPIC/6tbassey_en-us_VS_110_2_0_1_0_2%]
[[%$TOPIC/6tbassey_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/6tbassey_en-us_VS_110_2_0_2_0_1%]::Class)]
public ref class DefaultPropertyAttribute sealed : public [%$TOPIC/6tbassey_en-us_VS_110_2_0_2_0_2%]
[<[%$TOPIC/6tbassey_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/6tbassey_en-us_VS_110_2_0_3_0_1%]([%$TOPIC/6tbassey_en-us_VS_110_2_0_3_0_2%].Class)>]
type DefaultPropertyAttribute =  
    class 
        inherit [%$TOPIC/6tbassey_en-us_VS_110_2_0_3_0_3%] 
    end

The DefaultPropertyAttribute type exposes the following members.

Constructors
  NameDescription
Public method DefaultPropertyAttributeInitializes a new instance of the DefaultPropertyAttribute class.
Top
Properties
  NameDescription
Public property NameGets the name of the default property for the component this attribute is bound to.
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods
  NameDescription
Public method EqualsReturns whether the value of the given object is equal to the current DefaultPropertyAttribute. (Overrides AttributeEquals(Object).)
Public method GetHashCodeReturns the hash code for this instance. (Overrides AttributeGetHashCode.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Fields
  NameDescription
Public field Static member DefaultSpecifies the default value for the DefaultPropertyAttribute, which is . This static field is read-only.
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

Use the Name property to get the name of the default property.

For more information, see Extending Metadata Using Attributes.

Examples

The following example defines a control named MyControl. The class is marked with a DefaultPropertyAttribute that specifies MyProperty as the default property.

<DefaultProperty("MyProperty")> _
Public Class MyControl
    Inherits Control

    Public Property MyProperty() As Integer 
        Get 
            ' Insert code here. 
            Return 0
        End Get 
        Set 
            ' Insert code here. 
        End Set  
    End Property 
    ' Insert any additional code. 
End Class 'MyControl
[DefaultProperty("MyProperty")]
 public class MyControl : Control {

    public int MyProperty {
       get {
          // Insert code here. 
          return 0;
       }
       set {
          // Insert code here.
       }
    }

    // Insert any additional code.

 }
[DefaultProperty("MyProperty")]
ref class MyControl: public Control
{
public:

   property int MyProperty 
   {
      int get()
      {
         // Insert code here. 
         return 0;
      }

      void set( int value )
      {
         // Insert code here.
      }
   }
   // Insert any additional code.
};

The next example creates an instance of MyControl. Then it gets the attributes for the class, extracts the DefaultPropertyAttribute, and prints the name of the default property.

Public Shared Function Main() As Integer 
    ' Creates a new control. 
    Dim myNewControl As New MyControl()

    ' Gets the attributes for the collection. 
    Dim attributes As AttributeCollection = TypeDescriptor.GetAttributes(myNewControl)

    ' Prints the name of the default property by retrieving the 
    ' DefaultPropertyAttribute from the AttributeCollection.  
    Dim myAttribute As DefaultPropertyAttribute = _
        CType(attributes(GetType(DefaultPropertyAttribute)), DefaultPropertyAttribute)
    Console.WriteLine(("The default property is: " + myAttribute.Name))
    Return 0
End Function 'Main
public static int Main() {
    // Creates a new control.
    MyControl myNewControl = new MyControl();

    // Gets the attributes for the collection.
    AttributeCollection attributes = TypeDescriptor.GetAttributes(myNewControl);

    /* Prints the name of the default property by retrieving the 
     * DefaultPropertyAttribute from the AttributeCollection. */
    DefaultPropertyAttribute myAttribute = 
       (DefaultPropertyAttribute)attributes[typeof(DefaultPropertyAttribute)];
    Console.WriteLine("The default property is: " + myAttribute.Name);

    return 0;
 }
int main()
{
   // Creates a new control.
   Form1::MyControl^ myNewControl = gcnew Form1::MyControl;

   // Gets the attributes for the collection.
   AttributeCollection^ attributes = TypeDescriptor::GetAttributes( myNewControl );

   /* Prints the name of the default property by retrieving the 
       * DefaultPropertyAttribute from the AttributeCollection. */
   DefaultPropertyAttribute^ myAttribute = dynamic_cast<DefaultPropertyAttribute^>(attributes[ DefaultPropertyAttribute::typeid ]);
   Console::WriteLine( "The default property is: {0}", myAttribute->Name );
   return 0;
}
Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

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.

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