ComVisibleAttribute Classe

Définition

Contrôle l'accessibilité à COM d'un membre ou type managé spécifique, ou de tous les types dans un assembly.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
Héritage
ComVisibleAttribute
Attributs

Exemples

L’exemple suivant montre comment vous pouvez contrôler la visibilité sur COM d’une classe afin que ses membres soient invisibles.The following example shows how you can control the visibility to COM of a class so that its members are invisible. En affectant false à MyClasslaSampleClass valeur ComVisibleAttribute on (dans l’exemple Visual Basic false ) MyMethod et MyPropertysur et, vous pouvez éviter d’exposer par inadvertance les membres à com par le biais de l’héritage.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

Remarques

Vous pouvez appliquer cet attribut à des assemblys, des interfaces, des classes, des structures, des délégués, des énumérations, des champs, des méthodes ou des propriétés.You can apply this attribute to assemblies, interfaces, classes, structures, delegates, enumerations, fields, methods, or properties.

La valeur par truedéfaut est, ce qui indique que le type managé est visible par com.The default is true, which indicates that the managed type is visible to COM. Cet attribut n’est pas nécessaire pour rendre les assemblys et types managés publics visibles. ils sont visibles par défaut par COM.This attribute is not needed to make public managed assemblies and types visible; they are visible to COM by default. Seuls public les types peuvent être rendus visibles.Only public types can be made visible. L’attribut ne peut pas être utilisé pour rendre internal un protected autre ou un type visible par com ou pour rendre visibles les membres d’un type non visible.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.

L’affectation de la false valeur à l’attribut sur l' public assembly masque tous les types dans l’assembly.Setting the attribute to false on the assembly hides all public types within the assembly. Vous pouvez rendre les types de l’assembly visibles de manière sélective en affectant trueaux types individuels la valeur.You can selectively make types within the assembly visible by setting the individual types to true. L’affectation de la false valeur à l’attribut sur un type spécifique masque ce type et ses membres.Setting the attribute to false on a specific type hides that type and its members. Toutefois, vous ne pouvez pas rendre les membres d’un type visibles si le type est invisible.However, you cannot make members of a type visible if the type is invisible. L’affectation de la false valeur à l’attribut sur un type empêche ce type d’être exporté vers une bibliothèque de types ; les classes ne sont pas inscrites ; QueryInterface les interfaces ne répondent jamais aux appels non managés.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.

Sauf si vous définissez explicitement une classe et ses membres falsesur, les classes héritées peuvent exposer aux membres de la classe de base com qui sont invisibles dans la classe d’origine.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. Par exemple, si vous affectez à false classa la valeur et que vous n’appliquez pas l’attribut à ses membres, la classe et ses membres sont invisibles pour 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. Toutefois, si vous dérivez ClassB de classa et que vous exportez ClassB vers COM, les membres classa deviennent des membres de classe de base visibles de ClassB.However, if you derive ClassB from ClassA and export ClassB to COM, ClassA members become visible base class members of ClassB.

Pour obtenir une description détaillée du processus d’exportation, consultez Résumé de la conversion d’un assembly en bibliothèque de types.For a detailed description of the export process, see Assembly to Type Library Conversion Summary.

Constructeurs

ComVisibleAttribute(Boolean)

Initialise une nouvelle instance de la classe ComVisibleAttribute.Initializes a new instance of the ComVisibleAttribute class.

Propriétés

TypeId

Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Hérité de Attribute)
Value

Obtient une valeur indiquant si le type est visible par COM.Gets a value that indicates whether the COM type is visible.

Méthodes

Equals(Object)

Retourne une valeur qui indique si cette instance est égale à un objet spécifié.Returns a value that indicates whether this instance is equal to a specified object.

(Hérité de Attribute)
GetHashCode()

Retourne le code de hachage de cette instance.Returns the hash code for this instance.

(Hérité de Attribute)
GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Hérité de Object)
IsDefaultAttribute()

En cas de substitution dans une classe dérivée, indique si la valeur de cette instance est la valeur par défaut pour la classe dérivée.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Hérité de Attribute)
Match(Object)

En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Hérité de Attribute)
MemberwiseClone()

Crée une copie superficielle de l'objet Object actuel.Creates a shallow copy of the current Object.

(Hérité de Object)
ToString()

Retourne une chaîne qui représente l'objet actuel.Returns a string that represents the current object.

(Hérité de Object)

Implémentations d’interfaces explicites

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

Mappe un jeu de noms avec un jeu correspondant d'identificateurs de dispatch.Maps a set of names to a corresponding set of dispatch identifiers.

(Hérité de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Récupère les informations de type pour un objet, qui peuvent être utilisées pour obtenir les informations de type d'une interface.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Hérité de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Récupère le nombre d'interfaces d'informations de type fourni par un objet (0 ou 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Hérité de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Fournit l'accès aux propriétés et aux méthodes exposées par un objet.Provides access to properties and methods exposed by an object.

(Hérité de Attribute)

S’applique à

Voir aussi