RecommendedAsConfigurableAttribute Classe

Definizione

Spazio dei nomi:

System.ComponentModel

Assembly:

System.ComponentModel.TypeConverter.dll

Source:

RecommendedAsConfigurableAttribute.cs

Attenzione

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

Consente di specificare che la proprietà può essere utilizzata come un'impostazione dell'applicazione.

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

Ereditarietà

Object

Attribute

RecommendedAsConfigurableAttribute

Attributi

AttributeUsageAttribute ObsoleteAttribute

Esempio

L'esempio seguente contrassegna una proprietà come utilizzabile come impostazione dell'applicazione.

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

Nell'esempio seguente viene illustrato come controllare il valore di RecommendedAsConfigurableAttribute per MyProperty. Prima di tutto, il codice ottiene un PropertyDescriptorCollection oggetto con tutte le proprietà per l'oggetto . Successivamente, indicizza in PropertyDescriptorCollection per ottenere MyProperty. Restituisce quindi gli attributi per questa proprietà e li salva nella variabile degli attributi.

In questo esempio vengono presentati due modi diversi per controllare il valore di RecommendedAsConfigurableAttribute. Nel secondo frammento di codice l'esempio chiama il Equals metodo . Nell'ultimo frammento di codice l'esempio usa la RecommendedAsConfigurable proprietà per controllare il valore.

// 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

Se è stata contrassegnata una classe con RecommendedAsConfigurableAttribute, usare il codice seguente per controllare il valore.

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

Commenti

Proprietà contrassegnate con il RecommendedAsConfigurableAttribute set da true visualizzare quando si espande la riga ConfigurableProperties nella finestra Proprietà . Una proprietà senza impostazione consigliata o contrassegnata con RecommendedAsConfigurableAttribute impostato su false non viene visualizzata ed è un candidato improbabile per essere un'impostazione dell'applicazione. Il valore predefinito è false.

È possibile associare una proprietà che non dispone di un'impostazione RecommendedAsConfigurableAttribute in Visual Studio facendo clic sul pulsante con i puntini di sospensione (...) in Impostazioni nella finestra Proprietà e selezionando la proprietà appropriata dall'elenco.

Nota

Quando si contrassegna una proprietà con RecommendedAsConfigurableAttribute impostato su true, il valore di questo attributo viene impostato sul membro Yescostante . Per una proprietà contrassegnata con RecommendedAsConfigurableAttribute impostato su value false, il valore è No. Pertanto, quando si vuole controllare il valore di questo attributo nel codice, è necessario specificare l'attributo come RecommendedAsConfigurableAttribute.Yes o RecommendedAsConfigurableAttribute.No.

Per altre informazioni, vedere Attributi.

.

Costruttori

RecommendedAsConfigurableAttribute(Boolean)

Obsoleti. Inizializza una nuova istanza della classe RecommendedAsConfigurableAttribute.

Campi

Default	Obsoleti. Consente di specificare il valore predefinito per l'attributo RecommendedAsConfigurableAttribute, che è No. Questo campo static è di sola lettura.
No	Obsoleti. Consente di specificare che una proprietà non può essere utilizzata come impostazione dell'applicazione. Questo campo static è di sola lettura.
Yes	Obsoleti. Consente di specificare che una proprietà può essere utilizzata come impostazione dell'applicazione. Questo campo static è di sola lettura.

Proprietà

RecommendedAsConfigurable	Obsoleti. Ottiene un valore che indica se la proprietà alla quale è associato questo attributo può essere utilizzata come impostazione dell'applicazione.
TypeId	Obsoleti. Quando è implementata in una classe derivata, ottiene un identificatore univoco della classe Attribute. (Ereditato da Attribute)

Metodi

Equals(Object)	Obsoleti. Indica se questa istanza e un oggetto specificato sono uguali.
GetHashCode()	Obsoleti. Restituisce il codice hash per l'istanza.
GetType()	Obsoleti. Ottiene l'oggetto Type dell'istanza corrente. (Ereditato da Object)
IsDefaultAttribute()	Obsoleti. Indica se il valore dell'istanza è quello predefinito per la classe.
Match(Object)	Obsoleti. Quando è sottoposto a override in una classe derivata, restituisce un valore che indica se questa istanza equivale a un oggetto specificato. (Ereditato da Attribute)
MemberwiseClone()	Obsoleti. Crea una copia superficiale dell'oggetto Object corrente. (Ereditato da Object)
ToString()	Obsoleti. Restituisce una stringa che rappresenta l'oggetto corrente. (Ereditato da Object)

Vedi anche

• Attribute
• PropertyDescriptor
• AttributeCollection
• PropertyDescriptorCollection