RecommendedAsConfigurableAttribute Classe

Définition

Espace de noms:

System.ComponentModel

Assembly:

System.ComponentModel.TypeConverter.dll

Source:

RecommendedAsConfigurableAttribute.cs

Attention

RecommendedAsConfigurableAttribute has been deprecated. Use System.ComponentModel.SettingsBindableAttribute instead.

Spécifie que la propriété peut être utilisée comme paramètre d'application.

public ref class RecommendedAsConfigurableAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Property)]
[System.Obsolete("RecommendedAsConfigurableAttribute has been deprecated. Use System.ComponentModel.SettingsBindableAttribute instead.")]
public class RecommendedAsConfigurableAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Property)>]
[<System.Obsolete("RecommendedAsConfigurableAttribute has been deprecated. Use System.ComponentModel.SettingsBindableAttribute instead.")>]
type RecommendedAsConfigurableAttribute = class
    inherit Attribute

Public Class RecommendedAsConfigurableAttribute
Inherits Attribute

Héritage

Object

Attribute

RecommendedAsConfigurableAttribute

Attributs

AttributeUsageAttribute ObsoleteAttribute

Exemples

L’exemple suivant marque une propriété comme utilisable en tant que paramètre d’application.

public:
   [RecommendedAsConfigurable(true)]
   property int MyProperty 
   {
      int get()
      {
         // Insert code here.
         return 0;
      }
      void set( int /*value*/ )
      {
         // Insert code here.
      }
   }

[RecommendedAsConfigurable(true)]
 public int MyProperty {
    get {
       // Insert code here.
       return 0;
    }
    set {
       // Insert code here.
    }
 }

<RecommendedAsConfigurable(True)> _
Public Property MyProperty() As Integer
    Get
        ' Insert code here.
        Return 0
    End Get
    Set
        ' Insert code here.
    End Set 
End Property

L’exemple suivant montre comment case activée la valeur de pour RecommendedAsConfigurableAttributeMyProperty. Tout d’abord, le code obtient un PropertyDescriptorCollection avec toutes les propriétés de l’objet . Ensuite, il indexe dans pour PropertyDescriptorCollection obtenir MyProperty. Ensuite, il retourne les attributs de cette propriété et les enregistre dans la variable d’attributs.

Cet exemple présente deux façons différentes de vérifier la valeur de .RecommendedAsConfigurableAttribute Dans le deuxième fragment de code, l’exemple appelle la Equals méthode . Dans le dernier fragment de code, l’exemple utilise la RecommendedAsConfigurable propriété pour case activée la valeur.

// Gets the attributes for the property.
AttributeCollection^ attributes = TypeDescriptor::GetProperties( this )[ "MyProperty" ]->Attributes;

// Checks to see if the value of the RecommendedAsConfigurableAttribute is Yes.
if ( attributes[ RecommendedAsConfigurableAttribute::typeid ]->Equals( RecommendedAsConfigurableAttribute::Yes ) )
{
   // Insert code here.
}

// This is another way to see if the property is recommended as configurable.
RecommendedAsConfigurableAttribute^ myAttribute = dynamic_cast<RecommendedAsConfigurableAttribute^>(attributes[ RecommendedAsConfigurableAttribute::typeid ]);
if ( myAttribute->RecommendedAsConfigurable )
{
   // Insert code here.
}

// Gets the attributes for the property.
AttributeCollection attributes = 
   TypeDescriptor.GetProperties(this)["MyProperty"].Attributes;
 
// Checks to see if the value of the RecommendedAsConfigurableAttribute is Yes.
if(attributes[typeof(RecommendedAsConfigurableAttribute)].Equals(RecommendedAsConfigurableAttribute.Yes)) {
   // Insert code here.
}
 
// This is another way to see if the property is recommended as configurable.
RecommendedAsConfigurableAttribute myAttribute = 
   (RecommendedAsConfigurableAttribute)attributes[typeof(RecommendedAsConfigurableAttribute)];
if(myAttribute.RecommendedAsConfigurable) {
   // Insert code here.
}

' Gets the attributes for the property.
Dim attributes As AttributeCollection = TypeDescriptor.GetProperties(Me)("MyProperty").Attributes

' Checks to see if the value of the RecommendedAsConfigurableAttribute is Yes.
If attributes(GetType(RecommendedAsConfigurableAttribute)).Equals(RecommendedAsConfigurableAttribute.Yes) Then
    ' Insert code here.
End If 

' This is another way to see if the property is recommended as configurable.
Dim myAttribute As RecommendedAsConfigurableAttribute = _
    CType(attributes(GetType(RecommendedAsConfigurableAttribute)), RecommendedAsConfigurableAttribute)
If myAttribute.RecommendedAsConfigurable Then
    ' Insert code here.
End If

Si vous avez marqué une classe avec , RecommendedAsConfigurableAttributeutilisez le code suivant pour case activée la valeur.

AttributeCollection^ attributes = TypeDescriptor::GetAttributes( MyProperty );
if ( attributes[ RecommendedAsConfigurableAttribute::typeid ]->Equals( RecommendedAsConfigurableAttribute::Yes ) )
{
   // Insert code here.
}

AttributeCollection attributes = 
   TypeDescriptor.GetAttributes(MyProperty);
if(attributes[typeof(RecommendedAsConfigurableAttribute)].Equals(RecommendedAsConfigurableAttribute.Yes)) {
   // Insert code here.
}

Dim attributes As AttributeCollection = TypeDescriptor.GetAttributes(MyProperty)
If attributes(GetType(RecommendedAsConfigurableAttribute)).Equals(RecommendedAsConfigurableAttribute.Yes) Then
    ' Insert code here.
End If

Remarques

Propriétés marquées avec l’ensemble RecommendedAsConfigurableAttribute à true afficher lorsque vous développez la ligne ConfigurableProperties dans la fenêtre Propriétés . Une propriété qui n’a aucun paramètre recommandé ou qui est marquée avec RecommendedAsConfigurableAttribute la valeur définie sur false n’est pas affichée et est un candidat peu probable pour être un paramètre d’application. La valeur par défaut est false.

Vous pouvez lier une propriété qui n’a pas de RecommendedAsConfigurableAttribute à un paramètre dans Visual Studio en cliquant sur le bouton de sélection (...) sous Paramètres dans la fenêtre Propriétés et en sélectionnant la propriété appropriée dans la liste.

Notes

Lorsque vous marquez une propriété avec RecommendedAsConfigurableAttribute la valeur définie sur true, la valeur de cet attribut est définie sur le membre Yesconstant . Pour une propriété marquée avec RecommendedAsConfigurableAttribute la valeur falsedéfinie sur , la valeur est No. Par conséquent, lorsque vous souhaitez case activée la valeur de cet attribut dans votre code, vous devez spécifier l’attribut en tant que RecommendedAsConfigurableAttribute.Yes ou RecommendedAsConfigurableAttribute.No.

Pour plus d’informations, consultez Attributs.

.

Constructeurs

RecommendedAsConfigurableAttribute(Boolean)

Obsolète. Initialise une nouvelle instance de la classe RecommendedAsConfigurableAttribute.

Champs

Default	Obsolète. Spécifie la valeur par défaut de RecommendedAsConfigurableAttribute (No). Ce champ static est en lecture seule.
No	Obsolète. Spécifie qu'une propriété ne peut pas être utilisée comme paramètre d'application. Ce champ static est en lecture seule.
Yes	Obsolète. Spécifie qu'une propriété peut être utilisée comme paramètre d'application. Ce champ static est en lecture seule.

Propriétés

RecommendedAsConfigurable	Obsolète. Obtient une valeur indiquant si la propriété à laquelle est lié cet attribut peut être utilisée comme paramètre d'application.
TypeId	Obsolète. Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute. (Hérité de Attribute)

Méthodes

Equals(Object)	Obsolète. Indique si cette instance et un objet spécifié sont égaux.
GetHashCode()	Obsolète. Retourne le code de hachage de cette instance.
GetType()	Obsolète. Obtient le Type de l'instance actuelle. (Hérité de Object)
IsDefaultAttribute()	Obsolète. Indique si la valeur de cette instance est la valeur par défaut pour la classe.
Match(Object)	Obsolète. En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié. (Hérité de Attribute)
MemberwiseClone()	Obsolète. Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Obsolète. Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

Voir aussi

• Attribute
• PropertyDescriptor
• AttributeCollection
• PropertyDescriptorCollection