ComVisibleAttribute Klasse

Definition

Namespace:

System.Runtime.InteropServices

Assembly:

System.Runtime.dll

Quelle:

ComVisibleAttribute.cs

Steuert den Zugriff eines einzelnen verwalteten Typs oder Members oder aller Typen innerhalb einer Assembly für COM.

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

Public NotInheritable Class ComVisibleAttribute
Inherits Attribute

Vererbung

Object

Attribute

ComVisibleAttribute

Attribute

AttributeUsageAttribute

Beispiele

Das folgende Beispiel zeigt, wie Sie die Sichtbarkeit einer Klasse für COM steuern können, sodass ihre Member unsichtbar sind. Durch Festlegen ComVisibleAttribute von false on MyClass(SampleClass im Visual Basic-Beispiel) und false auf MyMethod und MyPropertykönnen Sie vermeiden, dass die Member durch Vererbung versehentlich für COM verfügbar werden.

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

Hinweise

Sie können dieses Attribut auf Assemblys, Schnittstellen, Klassen, Strukturen, Delegaten, Enumerationen, Felder, Methoden, Ereignisaccessoren oder Eigenschaften anwenden.

Der Standardwert ist true, was angibt, dass der verwaltete Typ für COM sichtbar ist. Dieses Attribut ist nicht erforderlich, um öffentliche verwaltete Assemblys und Typen sichtbar zu machen. Sie sind standardmäßig für COM sichtbar. Nur public Typen können sichtbar gemacht werden. Das Attribut kann nicht verwendet werden, um einen anderen internal Typ oder protected einen Typ für COM sichtbar zu machen oder Member eines nicht sichtbaren Typs sichtbar zu machen.

Wenn Sie das Attribut für die Assembly auf festlegen false , werden alle public Typen innerhalb der Assembly ausgeblendet. Sie können Typen innerhalb der Assembly selektiv sichtbar machen, indem Sie die einzelnen Typen auf truefestlegen. Wenn Sie das Attribut für einen bestimmten Typ auf false festlegen, werden dieser Typ und seine Member ausgeblendet. Sie können jedoch keine Member eines Typs sichtbar machen, wenn der Typ unsichtbar ist. Wenn Sie das Attribut für einen Typ auf false festlegen, wird verhindert, dass dieser Typ in eine Typbibliothek exportiert wird. Klassen werden nicht registriert. Schnittstellen reagieren nie auf nicht verwaltete Aufrufe QueryInterface .

Wenn Sie eine Klasse und ihre Member nicht explizit auf falsefestlegen, können geerbte Klassen COM-Basisklassenmembern zur Verfügung stellen, die in der ursprünglichen Klasse nicht sichtbar sind. Wenn Sie z. B. ClassA auf false festlegen und das Attribut nicht auf ihre Member anwenden, sind die Klasse und ihre Member für COM nicht sichtbar. Wenn Sie jedoch ClassB von ClassA ableiten und ClassB in COM exportieren, werden ClassA-Member zu sichtbaren Basisklassenmembern von ClassB.

Eine ausführliche Beschreibung des Exportprozesses finden Sie unter Zusammenfassung der Konvertierung von Assembly to Type Library.

Konstruktoren

ComVisibleAttribute(Boolean)

Initialisiert eine neue Instanz der ComVisibleAttribute-Klasse.

Eigenschaften

TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute)
Value	Ruft einen Wert ab, der angibt, ob der COM-Typ sichtbar ist.

Methoden

Equals(Object)	Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist. (Geerbt von Attribute)
GetHashCode()	Gibt den Hashcode für diese Instanz zurück. (Geerbt von Attribute)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist. (Geerbt von Attribute)
Match(Object)	Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht. (Geerbt von Attribute)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Weitere Informationen

• Tlbexp.exe (Type Library Exporter-Tool)