ComVisibleAttribute Classe

Definição

public ref class ComVisibleAttribute sealed : Attribute

[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

[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)]
[System.Runtime.InteropServices.ComVisible(true)]
public sealed class ComVisibleAttribute : Attribute

[<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)>]
type ComVisibleAttribute = class
    inherit Attribute

[<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)>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type ComVisibleAttribute = class
    inherit Attribute

Public NotInheritable Class ComVisibleAttribute
Inherits Attribute

Herança

Object

Attribute

ComVisibleAttribute

Atributos

AttributeUsageAttribute ComVisibleAttribute

Exemplos

O exemplo a seguir mostra como você pode controlar a visibilidade do COM de uma classe para que seus membros sejam invisíveis. Ao definir ComVisibleAttribute para false em MyClass(SampleClass no exemplo Visual Basic) e false em MyMethod e MyProperty, você pode evitar inadvertidamente expor os membros ao COM por meio da herança.

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, acessadores de eventos ou propriedades.

O padrão é true, que indica que o tipo gerenciado está visível para COM. Esse atributo não é necessário para tornar os assemblies e tipos gerenciados públicos visíveis; eles são visíveis para COM por padrão. Somente public os tipos podem ficar visíveis. O atributo não pode ser usado para tornar um tipo internal ou protected tipo visível para COM ou para tornar os membros de um tipo não visível visíveis.

Definir o atributo false no assembly oculta todos os public tipos dentro do assembly. Você pode tornar seletivamente os tipos dentro do assembly visíveis definindo os tipos individuais como true. Definir o atributo em false um tipo específico oculta esse tipo e seus membros. No entanto, você não poderá tornar os membros de um tipo visíveis se o tipo for invisível. Definir o atributo 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 respondem a chamadas não gerenciadas QueryInterface .

A menos que você defina explicitamente uma classe e seus membros como false, as classes herdadas podem expor aos membros da classe base COM que são invisíveis na classe original. Por exemplo, se você definir ClassA false e não aplicar o atributo a seus membros, a classe e seus membros ficarão invisíveis para COM. No entanto, se você derivar ClassB de ClassA e exportar ClassB para COM, os membros classA se tornarão membros visíveis da classe base do ClassB.

Para obter uma descrição detalhada do processo de exportação, consulte Resumo da conversão assembly to type library.

Confira também

• Tlbexp.exe (Exportador de Biblioteca de Tipos)