ComVisibleAttribute Klasse

Definition

Steuert den Zugriff eines einzelnen verwalteten Typs oder Members oder aller Typen innerhalb einer Assembly für 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
Vererbung
ComVisibleAttribute
Attribute

Beispiele

Im folgenden Beispiel wird gezeigt, wie Sie die Sichtbarkeit für com einer Klasse steuern können, damit ihre Member unsichtbar sind.The following example shows how you can control the visibility to COM of a class so that its members are invisible. Durch Festlegen ComVisibleAttribute MyMethod MyPropertyvon auf MyClasson(SampleClass im Visual Basic Beispiel) und false in und können Sie verhindern, dass die Mitglieder versehentlich durch Vererbung für com verfügbar gemacht werden. falseBy 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

Hinweise

Sie können dieses Attribut auf Assemblys, Schnittstellen, Klassen, Strukturen, Delegaten, Enumerationen, Felder, Methoden oder Eigenschaften anwenden.You can apply this attribute to assemblies, interfaces, classes, structures, delegates, enumerations, fields, methods, or properties.

Der Standardwert trueist, womit angegeben wird, dass der verwaltete Typ für com sichtbar ist.The default is true, which indicates that the managed type is visible to COM. Dieses Attribut ist nicht erforderlich, um öffentliche verwaltete Assemblys und Typen sichtbar zu machen. Sie sind standardmäßig für com sichtbar.This attribute is not needed to make public managed assemblies and types visible; they are visible to COM by default. Nur public Typen können sichtbar gemacht werden.Only public types can be made visible. Das-Attribut kann nicht verwendet werden, um internal einen protected andernfalls oder Typ für com sichtbar zu machen oder um Member eines nicht sichtbaren Typs sichtbar zu machen.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.

Wenn Sie das- false Attribut für die Assembly auf public festlegen, werden alle Typen in der Assembly ausgeblendet.Setting the attribute to false on the assembly hides all public types within the assembly. Sie können Typen in der Assembly selektiv sichtbar machen, indem Sie die einzelnen Typen trueauf festlegen.You can selectively make types within the assembly visible by setting the individual types to true. Wenn Sie false das-Attribut für einen bestimmten Typ auf festlegen, werden dieser Typ und seine Member ausgeblendet.Setting the attribute to false on a specific type hides that type and its members. Member eines Typs können jedoch nicht sichtbar gemacht werden, wenn der Typ unsichtbar ist.However, you cannot make members of a type visible if the type is invisible. Wenn das-Attribut false für einen Typ auf festgelegt wird, wird verhindert, dass dieser Typ in eine Typbibliothek exportiert wird; Klassen sind nicht registriert; QueryInterface Schnittstellen werden nie auf nicht verwaltete Aufrufe reagiert.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.

Wenn Sie eine Klasse und ihre Member nicht explizit auf falsefestlegen, können geerbte Klassen für com-Basisklassenmember verfügbar gemacht werden, die in der ursprünglichen Klasse unsichtbar sind.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. Wenn Sie z. b. ClassA auf false festlegen und das-Attribut nicht auf seine Member anwenden, sind die-Klasse und ihre Member nicht für com sichtbar.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. Wenn Sie jedoch ClassB von ClassA ableiten und ClassB in com exportieren, werden ClassA-Member sichtbare Basisklassenmember von ClassB.However, if you derive ClassB from ClassA and export ClassB to COM, ClassA members become visible base class members of ClassB.

Eine ausführliche Beschreibung des Export Vorgangs finden Sie unter Übersicht über die Konvertierung der Assembly in eine Typbibliothek.For a detailed description of the export process, see Assembly to Type Library Conversion Summary.

Konstruktoren

ComVisibleAttribute(Boolean)

Initialisiert eine neue Instanz der ComVisibleAttribute-Klasse.Initializes a new instance of the ComVisibleAttribute class.

Eigenschaften

TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Geerbt von Attribute)
Value

Ruft einen Wert ab, der angibt, ob der COM-Typ sichtbar ist.Gets a value that indicates whether the COM type is visible.

Methoden

Equals(Object)

Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist.Returns a value that indicates whether this instance is equal to a specified object.

(Geerbt von Attribute)
GetHashCode()

Gibt den Hashcode für diese Instanz zurück.Returns the hash code for this instance.

(Geerbt von Attribute)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

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

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

(Geerbt von Attribute)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)

Explizite Schnittstellenimplementierungen

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

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(Geerbt von Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Geerbt von Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.Provides access to properties and methods exposed by an object.

(Geerbt von Attribute)

Gilt für:

Siehe auch