Classe DispIdAttribute

Artigo
04/16/2018

Dica

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Especifica o identificador de distribuição (DISPID) COM de um método, campo ou propriedade.

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

Hierarquia de Herança

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

Sintaxe

[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

Construtores

	Nome	Descrição
	DispIdAttribute(Int32)	Inicializa uma nova instância da classe DispIdAttribute com o DISPID especificado.

Propriedades

	Nome	Descrição
	TypeId	Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute.(Herdado de Attribute.)
	Value	Obtém DISPID para o membro.

Métodos

	Nome	Descrição
	Equals(Object)	Esta API dá suporte à infraestrutura produto e não se destina a ser usada diretamente do seu código. Retorna um valor que indica se essa instância é igual a um objeto especificado.(Herdado de Attribute.)
	GetHashCode()	Retorna o código hash para essa instância.(Herdado de Attribute.)
	GetType()	Obtém o Type da instância atual.(Herdado de Object.)
	IsDefaultAttribute()	Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada.(Herdado de Attribute.)
	Match(Object)	Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado.(Herdado de Attribute.)
	ToString()	Retorna uma cadeia de caracteres que representa o objeto atual.(Herdado de Object.)

Implementações Explícitas da Interface

	Nome	Descrição
	_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Mapeia um conjunto de nomes para um conjunto correspondente de identificadores de expedição.(Herdado de Attribute.)
	_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Recupera as informações de tipo para um objeto, que pode ser usado para obter as informações de tipo para uma interface.(Herdado de Attribute.)
	_Attribute.GetTypeInfoCount(UInt32)	Retorna o número de interfaces de informações do tipo que um objeto fornece (0 ou 1).(Herdado de Attribute.)
	_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Fornece acesso a propriedades e métodos expostos por um objeto.(Herdado de Attribute.)

Comentários

Você pode aplicar esse atributo para métodos, campos ou propriedades.

Este atributo contém o DISPID do método, do campo ou da propriedade que ele descreve. Exclusivos DISPIDs normalmente são atribuídas pelo common language runtime, mas você pode usar esse atributo para atribuir um DISPID específico a um método. Ao importar uma biblioteca de tipos, esse atributo é aplicado a todos os métodos com DISPIDs atribuídos. Isso garante que qualquer implementação gerenciada do mesmo método retém o DISPID mesmo se exposto a COM.

Consulte DISPID Constants para obter uma lista de valores DISPID usadas com frequência.

Exemplos

O exemplo a seguir demonstra como explícitas DISPIDs pode ser atribuída a membros de uma classe.

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

Informações de Versão

Plataforma Universal do Windows
Disponível desde 8
.NET Framework
Disponível desde 1.1
Biblioteca de Classes Portátil
Com suporte no: plataformas portáteis do .NET
Silverlight
Disponível desde 2.0
Windows Phone Silverlight
Disponível desde 7.0
Windows Phone
Disponível desde 8.1

Acesso thread-safe

Quaisquer membros estáticos públicos ( Compartilhado no Visual Basic) desse tipo são thread-safe. Não há garantia de que qualquer membro de instância seja thread-safe.

Confira Também

Namespace System.Runtime.InteropServices

Retornar ao início

Compartilhar via