RecommendedAsConfigurableAttribute RecommendedAsConfigurableAttribute RecommendedAsConfigurableAttribute RecommendedAsConfigurableAttribute Class

Définition

Avertissement

Cette API est désormais obsolète.

Spécifie que la propriété peut être utilisée comme paramètre d'application.Specifies that the property can be used as an application setting.

public ref class RecommendedAsConfigurableAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Property)]
[System.Obsolete("Use System.ComponentModel.SettingsBindableAttribute instead to work with the new settings model.")]
public class RecommendedAsConfigurableAttribute : Attribute
type RecommendedAsConfigurableAttribute = class
    inherit Attribute
Public Class RecommendedAsConfigurableAttribute
Inherits Attribute
Héritage
RecommendedAsConfigurableAttributeRecommendedAsConfigurableAttributeRecommendedAsConfigurableAttributeRecommendedAsConfigurableAttribute
Attributs

Exemples

L’exemple suivant marque une propriété comme étant utilisable en tant que paramètre d’application.The following example marks a property as usable as an application setting.

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 vérifier la valeur de RecommendedAsConfigurableAttribute pour. MyPropertyThe next example shows how to check the value of the RecommendedAsConfigurableAttribute for MyProperty. Tout d’abord, le PropertyDescriptorCollection code obtient un avec toutes les propriétés de l’objet.First the code gets a PropertyDescriptorCollection with all the properties for the object. Ensuite, il indexe dans PropertyDescriptorCollection le à MyPropertyrécupérer.Next it indexes into the PropertyDescriptorCollection to get MyProperty. Elle retourne ensuite les attributs de cette propriété et les enregistre dans la variable d’attributs.Then it returns the attributes for this property and saves them in the attributes variable.

Cet exemple présente deux méthodes différentes de vérification de la valeur de RecommendedAsConfigurableAttribute.This example presents two different ways of checking the value of the RecommendedAsConfigurableAttribute. Dans le deuxième fragment de code, l’exemple appelle Equals la méthode.In the second code fragment, the example calls the Equals method. Dans le dernier fragment de code, l’exemple utilise RecommendedAsConfigurable la propriété pour vérifier la valeur.In the last code fragment, the example uses the RecommendedAsConfigurable property to check the value.

// 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 RecommendedAsConfigurableAttribute, utilisez le code suivant pour vérifier la valeur.If you marked a class with the RecommendedAsConfigurableAttribute, use the following code to check the value.

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 RecommendedAsConfigurableAttribute marquées avec le jeu à true afficher lorsque vous développez la ligne ConfigurableProperties dans la fenêtre Propriétés .Properties that are marked with the RecommendedAsConfigurableAttribute set to true display when you expand the ConfigurableProperties line in the Properties window. Une propriété qui n’a pas de paramètre recommandé ou qui est RecommendedAsConfigurableAttribute marquée avec false la valeur n’est pas affichée et est un candidat peu probable pour être un paramètre d’application.A property that has no recommended setting or that is marked with RecommendedAsConfigurableAttribute set to false is not shown and is an unlikely candidate for being an application setting. La valeur par défaut est false.The default is false.

Vous pouvez lier une propriété qui n’a RecommendedAsConfigurableAttribute pas de à 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.You can bind a property that does not have a RecommendedAsConfigurableAttribute to a setting in Visual Studio by clicking the ellipsis button (…) under Settings in the Properties window and selecting the appropriate property from the list.

Notes

Lorsque vous marquez une propriété RecommendedAsConfigurableAttribute avec truela valeur, la valeur de cet attribut est définie sur le membre Yesconstant.When you mark a property with RecommendedAsConfigurableAttribute set to true, the value of this attribute is set to the constant member Yes. Pour une propriété marquée avec RecommendedAsConfigurableAttribute défini sur value false, la valeur est No.For a property marked with RecommendedAsConfigurableAttribute set to value false, the value is No. Par conséquent, lorsque vous souhaitez vérifier la valeur de cet attribut dans votre code, vous devez spécifier l’attribut en RecommendedAsConfigurableAttribute.Yes tant RecommendedAsConfigurableAttribute.Noque ou.Therefore, when you want to check the value of this attribute in your code, you must specify the attribute as RecommendedAsConfigurableAttribute.Yes or RecommendedAsConfigurableAttribute.No.

Pour plus d’informations, consultez Attributs.For more information, see Attributes.

..

Constructeurs

RecommendedAsConfigurableAttribute(Boolean) RecommendedAsConfigurableAttribute(Boolean) RecommendedAsConfigurableAttribute(Boolean) RecommendedAsConfigurableAttribute(Boolean)

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

Champs

Default Default Default Default

Spécifie la valeur par défaut de RecommendedAsConfigurableAttribute (No).Specifies the default value for the RecommendedAsConfigurableAttribute, which is No. Ce champ static est en lecture seule.This static field is read-only.

No No No No

Spécifie qu'une propriété ne peut pas être utilisée comme paramètre d'application.Specifies that a property cannot be used as an application setting. Ce champ static est en lecture seule.This static field is read-only.

Yes Yes Yes Yes

Spécifie qu'une propriété peut être utilisée comme paramètre d'application.Specifies that a property can be used as an application setting. Ce champ static est en lecture seule.This static field is read-only.

Propriétés

RecommendedAsConfigurable RecommendedAsConfigurable RecommendedAsConfigurable RecommendedAsConfigurable

Obtient une valeur indiquant si la propriété à laquelle est lié cet attribut peut être utilisée comme paramètre d'application.Gets a value indicating whether the property this attribute is bound to can be used as an application setting.

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

(Inherited from Attribute)

Méthodes

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Indique si cette instance et un objet spécifié sont égaux.Indicates whether this instance and a specified object are equal.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

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

GetType() GetType() GetType() GetType()

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

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

Indique si la valeur de cette instance est la valeur par défaut pour la classe.Indicates whether the value of this instance is the default value for the class.

Match(Object) Match(Object) Match(Object) 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.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

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

(Inherited from Object)
ToString() ToString() ToString() ToString()

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

(Inherited from Object)

Implémentations d’interfaces explicites

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _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.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _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.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _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).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _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.

(Inherited from Attribute)

S’applique à

Voir aussi