This documentation is archived and is not being maintained.

DefaultEventAttribute Class

Specifies the default event for a component.

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

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class)> _
Public NotInheritable Class DefaultEventAttribute _
	Inherits Attribute
'Usage
Dim instance As DefaultEventAttribute

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

For more information, see Attributes Overview and Extending Metadata Using Attributes.

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

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

System.Object
  System.Attribute
    System.ComponentModel.DefaultEventAttribute

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

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Show: