ComVisibleAttribute Class

Definition

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.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

Inheritance

Object

Attribute

ComVisibleAttribute

Attributes

ComVisibleAttribute AttributeUsageAttribute

Examples

В следующем примере показано, как можно управлять видимостью для COM класса, чтобы его члены были невидимыми.The following example shows how you can control the visibility to COM of a class so that its members are invisible. Установив для параметра ComVisibleAttribute значение false на MyClass(SampleClass в примере Visual Basic) и false MyMethod и MyProperty, можно избежать случайного предоставления членам возможности COM через наследование.By 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

Remarks

Этот атрибут можно применять к сборкам, интерфейсам, классам, структурам, делегатам, перечислениям, полям, методам или свойствам.You can apply this attribute to assemblies, interfaces, classes, structures, delegates, enumerations, fields, methods, or properties.

Значение по умолчанию — true, которое указывает, что управляемый тип является видимым для COM.The default is true, which indicates that the managed type is visible to COM. Этот атрибут не требуется для отображения открытых управляемых сборок и типов. по умолчанию они видимы для COM.This attribute is not needed to make public managed assemblies and types visible; they are visible to COM by default. Можно сделать видимыми только типы public.Only public types can be made visible. Атрибут нельзя использовать, чтобы сделать иначе internal или protected тип видимым для COM или сделать элементы невидимого типа видимыми.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.

Присвоение атрибуту значения false для сборки скрывает все типы public в сборке.Setting the attribute to false on the assembly hides all public types within the assembly. Можно выборочно сделать типы в сборке видимыми, задав для отдельных типов true.You can selectively make types within the assembly visible by setting the individual types to true. Присвоение атрибуту значения false для определенного типа скрывает этот тип и его члены.Setting the attribute to false on a specific type hides that type and its members. Однако нельзя сделать элементы типа видимыми, если тип является невидимым.However, you cannot make members of a type visible if the type is invisible. Присвоение атрибуту значения false типа предотвращает экспорт этого типа в библиотеку типов; классы не зарегистрированы; интерфейсы никогда не реагируют на неуправляемые вызовы QueryInterface.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.

Если класс и его члены явно не заданы для false, унаследованные классы могут предоставляться членам базового класса COM, невидимым в исходном классе.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. Например, если присвоить классу a значение false и не применять атрибут к его членам, класс и его члены будут невидимыми для 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. Однако если вы наследуете ClassB из класса a и экспортируете ClassB в COM, члены класса a становятся видимыми членами базового класса ClassB.However, if you derive ClassB from ClassA and export ClassB to COM, ClassA members become visible base class members of ClassB.

Подробное описание процесса экспорта см. в разделе Сводка преобразования сборки в библиотеку типов.For a detailed description of the export process, see Assembly to Type Library Conversion Summary.

Constructors

Properties

Methods

Explicit Interface Implementations

Applies to

See also

• Tlbexp.exe (программа экспорта библиотек типов)Tlbexp.exe (Type Library Exporter)