.NET Framework Class Library
DefaultEventAttribute Class

Specifies the default event for a component.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.ComponentModelDefaultEventAttribute

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

The DefaultEventAttribute type exposes the following members.

Constructors
  NameDescription
Public method DefaultEventAttributeInitializes a new instance of the DefaultEventAttribute class.
Top
Properties
  NameDescription
Public property NameGets the name of the default event 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 DefaultEventAttribute. (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 DefaultEventAttribute, 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 event.

For more information, see Extending Metadata Using Attributes.

Examples

The following example defines a collection class named MyCollection. The class is marked with a DefaultEventAttribute that specifies CollectionChanged as the default event.

<DefaultEvent("CollectionChanged")> _ 
Public Class MyCollection
    Inherits BaseCollection

    Public Event CollectionChanged (ByVal sender As Object, _
        ByVal e As CollectionChangeEventArgs)

    ' Insert additional code. 
End Class 'MyCollection
[DefaultEvent("CollectionChanged")]
public class MyCollection : BaseCollection {

    private CollectionChangeEventHandler onCollectionChanged;

    public event CollectionChangeEventHandler CollectionChanged {
       add {
          onCollectionChanged += value;
       }
       remove {
          onCollectionChanged -= value;
       }
    }
    // Insert additional code.
}
[DefaultEvent("CollectionChanged")]
public ref class TestCollection: public BaseCollection
{
private:
    CollectionChangeEventHandler^ onCollectionChanged;

public:
    event CollectionChangeEventHandler^ CollectionChanged 
    {
    public:
        void add(CollectionChangeEventHandler^ eventHandler)
        { 
            onCollectionChanged += eventHandler; 
        }

    protected:
        void remove(CollectionChangeEventHandler^ eventHandler) 
        { 
            onCollectionChanged -= eventHandler; 
        }
    }
    // Insert additional code.
};

The next example creates an instance of MyCollection. Then it gets the attributes for the class, extracts the DefaultEventAttribute, and prints the name of the default event.

Public Shared Function Main() As Integer 
    ' Creates a new collection. 
    Dim myNewCollection As New MyCollection()

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

    ' Prints the name of the default event by retrieving the 
    ' DefaultEventAttribute from the AttributeCollection.  
    Dim myAttribute As DefaultEventAttribute = _
        CType(attributes(GetType(DefaultEventAttribute)), DefaultEventAttribute)
    Console.WriteLine(("The default event is: " & myAttribute.Name))
    Return 0
End Function 'Main
public static int Main() {
    // Creates a new collection.
    MyCollection myNewCollection = new MyCollection();

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

    /* Prints the name of the default event by retrieving the 
     * DefaultEventAttribute from the AttributeCollection. */
    DefaultEventAttribute myAttribute = 
       (DefaultEventAttribute)attributes[typeof(DefaultEventAttribute)];
    Console.WriteLine("The default event is: " + myAttribute.Name);
    return 0;
 }
int main()
{
    // Creates a new collection.
    DefaultEventAttributeExample::TestCollection^ newCollection = 
        gcnew DefaultEventAttributeExample::TestCollection;

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

    // Prints the name of the default event by retrieving the  
    // DefaultEventAttribute from the AttributeCollection.
    DefaultEventAttribute^ attribute = (DefaultEventAttribute^)
        attributes[DefaultEventAttribute::typeid];
    Console::WriteLine("The default event is: {0}", attribute->Name);
}
Version Information

.NET Framework

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

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.