Export (0) Print
Expand All

DefaultEventAttribute Class

Specifies the default event for a component.

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

[AttributeUsageAttribute(AttributeTargets::Class)] 
public ref class DefaultEventAttribute sealed : public Attribute
/** @attribute AttributeUsageAttribute(AttributeTargets.Class) */ 
public final class DefaultEventAttribute extends Attribute
AttributeUsageAttribute(AttributeTargets.Class) 
public final class DefaultEventAttribute extends Attribute
Not applicable.

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

/** @attribute DefaultEvent("CollectionChanged")
 */
public static class MyCollection extends BaseCollection
{
    private CollectionChangeEventHandler onCollectionChanged;

    public void add_onCollectionChanged(CollectionChangeEventHandler value)
    {
        onCollectionChanged = (CollectionChangeEventHandler)
            System.Delegate.Combine(onCollectionChanged, value);
    }

    public void remove_onCollectionChanged(CollectionChangeEventHandler
        value)
    {
        onCollectionChanged = (CollectionChangeEventHandler)
            System.Delegate.Remove(onCollectionChanged, value);
    }
    // Insert additional code.
} //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.

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);
}

public static void main(String[] args)
{
    // 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.
        get_Item(DefaultEventAttribute.class.ToType());
    Console.WriteLine("The default event is: " + myAttribute.get_Name());
} //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 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft