ComEventInterfaceAttribute Class

Definition

Namespace:

System.Runtime.InteropServices

Assembly:

System.Runtime.InteropServices.dll

Source:

ComEventInterfaceAttribute.cs

Identifies the source interface and the class that implements the methods of the event interface that is generated when a coclass is imported from a COM type library.

public ref class ComEventInterfaceAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Interface, Inherited=false)]
public sealed class ComEventInterfaceAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Interface, Inherited=false)>]
type ComEventInterfaceAttribute = class
    inherit Attribute

Public NotInheritable Class ComEventInterfaceAttribute
Inherits Attribute

Inheritance

Object

Attribute

ComEventInterfaceAttribute

Attributes

AttributeUsageAttribute

Remarks

You can apply this attribute to interfaces, although the Tlbimp.exe (Type Library Importer) typically applies it for you when it imports a type library.

When a source interface is imported from a type library, any methods it implements are added as events to a generated event interface. Tlbimp.exe applies ComEventInterfaceAttribute to the event interface to identify the managed class that implements the methods of the event interface and implements the original source interface. The common language runtime uses this attribute at run time to perform the following tasks:

• Associate events exposed by the interface to their implementation in the event provider class.

• Link the events to the original COM source interface.

You rarely apply this attribute. However, if you plan to write source code that produces metadata that closely simulates metadata produced by Tlbimp.exe, you should create a event interface for each original source interface. For a detailed description about how Tlbimp.exe imports events, see Imported Member Conversion. For instruction about how to expose a COM event to a .NET client, see How to: Handle Events Raised by a COM Source.

Constructors

ComEventInterfaceAttribute(Type, Type)

Initializes a new instance of the ComEventInterfaceAttribute class with the source interface and event provider class.

Properties

EventProvider	Gets the class that implements the methods of the event interface.
SourceInterface	Gets the original source interface from the type library.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• Tlbimp.exe (Type Library Importer)