ComVisibleAttribute Classe

Definição

Controla a acessibilidade de um tipo gerenciado individual ou membro, ou então de todos os tipos em um assembly, ao COM.Controls accessibility of an individual managed type or member, or of all types within an assembly, to COM.

public ref class ComVisibleAttribute sealed : Attribute
[System.Runtime.InteropServices.ComVisible(true)]
[System.AttributeUsage(System.AttributeTargets.Assembly | System.AttributeTargets.Class | System.AttributeTargets.Delegate | System.AttributeTargets.Enum | System.AttributeTargets.Field | System.AttributeTargets.Interface | System.AttributeTargets.Method | System.AttributeTargets.Property | System.AttributeTargets.Struct, Inherited=false)]
public sealed class ComVisibleAttribute : Attribute
type ComVisibleAttribute = class
    inherit Attribute
Public NotInheritable Class ComVisibleAttribute
Inherits Attribute
Herança
ComVisibleAttribute
Atributos

Exemplos

O exemplo a seguir mostra como você pode controlar a visibilidade para COM de uma classe para que seus membros fiquem invisíveis.The following example shows how you can control the visibility to COM of a class so that its members are invisible. Ao definir ComVisibleAttribute como false on false MyMethod (no exemplo de Visual Basic) e em e MyProperty, você pode evitar a exposição inadvertida de membros a com por meio de herança.SampleClass MyClassBy setting ComVisibleAttribute to false on MyClass(SampleClass in the Visual Basic example), and false on MyMethod and MyProperty, you can avoid inadvertently exposing the members to COM through inheritance.

using namespace System::Runtime::InteropServices;

[ComVisible(false)]
ref class MyClass
{
private:
   int myProperty;

public:
   MyClass()
   {
      
      //Insert code here.
   }


   [ComVisible(false)]
   int MyMethod( String^ param )
   {
      return 0;
   }

   bool MyOtherMethod()
   {
      return true;
   }


   property int MyProperty 
   {

      [ComVisible(false)]
      int get()
      {
         return myProperty;
      }

   }

};

using System.Runtime.InteropServices;

[ComVisible(false)]
class MyClass
{
   public MyClass()
   {
      //Insert code here.
   }
   
   [ComVisible(false)]
   public int MyMethod(string param) 
   {
      return 0;
   }

   public bool MyOtherMethod() 
   {
      return true;
   }

   [ComVisible(false)]
   public int MyProperty
   {
      get
      {
         return MyProperty;
      }
   }
}
Imports System.Runtime.InteropServices

<ComVisible(False)> _
Class SampleClass
    
    Public Sub New()
        'Insert code here.
    End Sub
    
    <ComVisible(False)> _
    Public Function MyMethod(param As String) As Integer
        Return 0
    End Function    
    
    Public Function MyOtherMethod() As Boolean
        Return True
    End Function
    
    <ComVisible(False)> _
    Public ReadOnly Property MyProperty() As Integer
        Get
            Return MyProperty
        End Get
    End Property
    
End Class

Comentários

Você pode aplicar esse atributo a assemblies, interfaces, classes, estruturas, delegados, enumerações, campos, métodos ou propriedades.You can apply this attribute to assemblies, interfaces, classes, structures, delegates, enumerations, fields, methods, or properties.

O padrão é true, que indica que o tipo gerenciado é visível para com.The default is true, which indicates that the managed type is visible to COM. Esse atributo não é necessário para tornar os tipos e assemblies gerenciados públicos visíveis; Eles são visíveis para COM por padrão.This attribute is not needed to make public managed assemblies and types visible; they are visible to COM by default. Somente public tipos podem se tornar visíveis.Only public types can be made visible. O atributo não pode ser usado para tornar um internal caso protected ou tipo visível para com ou para tornar os membros de um tipo não visível visíveis.The attribute cannot be used to make an otherwise internal or protected type visible to COM or to make members of a nonvisible type visible.

Definir o atributo como false no assembly oculta todos os public tipos dentro do assembly.Setting the attribute to false on the assembly hides all public types within the assembly. Você pode criar seletivamente tipos dentro do assembly visível definindo os tipos individuais como true.You can selectively make types within the assembly visible by setting the individual types to true. Definir o atributo como false em um tipo específico oculta esse tipo e seus membros.Setting the attribute to false on a specific type hides that type and its members. No entanto, você não poderá tornar os membros de um tipo visíveis se o tipo for invisível.However, you cannot make members of a type visible if the type is invisible. Definir o atributo como false em um tipo impede que esse tipo seja exportado para uma biblioteca de tipos; as classes não são registradas; as interfaces nunca QueryInterface são responsivas a chamadas não gerenciadas.Setting the attribute to false on a type prevents that type from being exported to a type library; classes are not registered; interfaces are never responsive to unmanaged QueryInterface calls.

A menos que você defina explicitamente uma classe e seus falseMembros como, as classes herdadas podem ser expostas a membros da classe base com que são invisíveis na classe original.Unless you explicitly set a class and its members to false, inherited classes can expose to COM base class members that are invisible in the original class. Por exemplo, se você definir ClassA como false e não aplicar o atributo a seus membros, a classe e seus membros serão invisíveis para com.For example, if you set ClassA to false and do not apply the attribute to its members, the class and its members are invisible to COM. No entanto, se você derivar ClassB da ClasseA e exportar ClassB para COM, os membros da classe se tornarão membros da classe base visíveis de ClassB.However, if you derive ClassB from ClassA and export ClassB to COM, ClassA members become visible base class members of ClassB.

Para obter uma descrição detalhada do processo de exportação, consulte assembly para o resumo da conversão da biblioteca de tipos.For a detailed description of the export process, see Assembly to Type Library Conversion Summary.

Construtores

ComVisibleAttribute(Boolean)

Inicializa uma nova instância da classe ComVisibleAttribute.Initializes a new instance of the ComVisibleAttribute class.

Propriedades

TypeId

Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Herdado de Attribute)
Value

Obtém um valor que indica se o tipo COM está visível.Gets a value that indicates whether the COM type is visible.

Métodos

Equals(Object)

Retorna um valor que indica se essa instância é igual a um objeto especificado.Returns a value that indicates whether this instance is equal to a specified object.

(Herdado de Attribute)
GetHashCode()

Retorna o código hash para essa instância.Returns the hash code for this instance.

(Herdado de Attribute)
GetType()

Obtém o Type da instância atual.Gets the Type of the current instance.

(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.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(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.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Herdado de Attribute)
MemberwiseClone()

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

(Herdado de Object)
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object.

(Herdado de Object)

Implantações explícitas de interface

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Mapeia um conjunto de nomes para um conjunto correspondente de identificadores de expedição.Maps a set of names to a corresponding set of dispatch identifiers.

(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.Retrieves the type information for an object, which can be used to get the type information for an 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).Retrieves the number of type information interfaces that an object provides (either 0 or 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.Provides access to properties and methods exposed by an object.

(Herdado de Attribute)

Aplica-se a

Veja também