Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

DispIdAttribute Class

Specifies the COM dispatch identifier (DISPID) of a method, field, or property.

Namespace: System.Runtime.InteropServices
Assembly: mscorlib (in mscorlib.dll)

[AttributeUsageAttribute(AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Event, Inherited=false)] 
[ComVisibleAttribute(true)] 
public sealed class DispIdAttribute : Attribute
/** @attribute AttributeUsageAttribute(AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Event, Inherited=false) */ 
/** @attribute ComVisibleAttribute(true) */ 
public final class DispIdAttribute extends Attribute
AttributeUsageAttribute(AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Event, Inherited=false) 
ComVisibleAttribute(true) 
public final class DispIdAttribute extends Attribute

You can apply this attribute to methods, fields, or properties.

This attribute contains the DISPID for the method, field, or property it describes. Unique DISPIDs are typically assigned by the common language runtime, but you can use this attribute to assign a specific DISPID to a method. When importing a type library, this attribute is applied to all methods with assigned DISPIDs. This ensures that any managed implementation of the same method retains the same DISPID if exposed to COM.

The following example demonstrates how explicit DISPIDs can be assigned to members of a class.

using System.Runtime.InteropServices;

public class MyClass
{
   public MyClass() {}

   [DispId(8)]
   public void MyMethod() {}
   
   public int MyOtherMethod() {
      return 0;
   }
   
   [DispId(9)]
   public bool MyField;
}

import System.Runtime.InteropServices.*;

public class MyClass
{
    public MyClass()
    {
    } //MyClass

    /** @attribute DispId(8)
     */
    public void MyMethod()
    {
    } //MyMethod

    public int MyOtherMethod()
    {
        return 0;
    } //MyOtherMethod

    /** @attribute DispId(9)
     */
    public boolean MyField;
} //MyClass

System.Object
   System.Attribute
    System.Runtime.InteropServices.DispIdAttribute
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 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.