Clase DispIdAttribute

 

Publicado: noviembre de 2016

Especifica el identificador de envío (DISPID) de COM de un método, un campo o una propiedad.

Espacio de nombres:   System.Runtime.InteropServices
Ensamblado:  mscorlib (en mscorlib.dll)

Jerarquía de herencia

System.Object
  System.Attribute
    System.Runtime.InteropServices.DispIdAttribute

Sintaxis

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

[AttributeUsageAttribute(AttributeTargets::Method | AttributeTargets::Property | AttributeTargets::Field | AttributeTargets::Event, 
    Inherited = false)]
[ComVisibleAttribute(true)]
public ref class DispIdAttribute sealed : Attribute

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Method | AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Event,
    Inherited = false)>]
[<ComVisibleAttribute(true)>]
type DispIdAttribute = 
    class
        inherit Attribute
    end

<AttributeUsageAttribute(AttributeTargets.Method Or AttributeTargets.Property Or AttributeTargets.Field Or AttributeTargets.Event,
    Inherited := False)>
<ComVisibleAttribute(True)>
Public NotInheritable Class DispIdAttribute
    Inherits Attribute

Constructores

	Nombre	Descripción
	DispIdAttribute(Int32)	Inicializa una nueva instancia de la DispIdAttribute clase con el identificador de envío especificado.

Propiedades

	Nombre	Descripción
	TypeId	Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.(Heredado de Attribute).
	Value	Obtiene el identificador de envío para el miembro.

Métodos

	Nombre	Descripción
	Equals(Object)	Esta API admite la infraestructura producto y no está diseñada para usarse directamente desde el código. Devuelve un valor que indica si esta instancia es igual que un objeto especificado.(Heredado de Attribute).
	GetHashCode()	Devuelve el código hash de esta instancia.(Heredado de Attribute).
	GetType()	Obtiene el Type de la instancia actual.(Heredado de Object).
	IsDefaultAttribute()	Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada.(Heredado de Attribute).
	Match(Object)	Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado.(Heredado de Attribute).
	ToString()	Devuelve una cadena que representa el objeto actual.(Heredado de Object).

Implementaciones de interfaz explícitas

	Nombre	Descripción
	_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío.(Heredado de Attribute).
	_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz.(Heredado de Attribute).
	_Attribute.GetTypeInfoCount(UInt32)	Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1).(Heredado de Attribute).
	_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Proporciona acceso a las propiedades y los métodos expuestos por un objeto.(Heredado de Attribute).

Comentarios

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.

See DISPID Constantshttps://msdn.microsoft.com/library/windows/desktop/ms221242(v=vs.85).aspx for a list of commonly used DISPID values.

Ejemplos

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

Imports System.Runtime.InteropServices

Class SampleClass

    Public Sub New()
        'Insert code here.
    End Sub

    <DispIdAttribute(8)> _ 
    Public Sub MyMethod()
        'Insert code here.
    End Sub    

    Public Function MyOtherMethod() As Integer
        'Insert code here.
        Return 0
    End Function

    <DispId(9)> _
    Public MyField As Boolean
End Class

using namespace System::Runtime::InteropServices;
public ref class MyClass
{
public:
   MyClass(){}


   [DispId(8)]
   void MyMethod(){}

   int MyOtherMethod()
   {
      return 0;
   }


   [DispId(9)]
   bool MyField;
};

Información de versión

Plataforma universal de Windows
Disponible desde 8
.NET Framework
Disponible desde 1.1
Biblioteca de clases portable
Se admite en: plataformas portátiles de .NET
Silverlight
Disponible desde 2.0
Windows Phone Silverlight
Disponible desde 7.0
Windows Phone
Disponible desde 8.1

Seguridad para subprocesos

Cualquier miembro ( Compartido en Visual Basic) estático público de este tipo es seguro para subprocesos. No se garantiza que los miembros de instancia sean seguros para subprocesos.

Ver también

Espacio de nombres System.Runtime.InteropServices

Volver al principio