RecommendedAsConfigurableAttribute Klasse

Definition

Namespace:

System.ComponentModel

Assembly:

System.ComponentModel.TypeConverter.dll

Quelle:

RecommendedAsConfigurableAttribute.cs

Achtung

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

Gibt an, dass die Eigenschaft als Anwendungseinstellung verwendet werden kann.

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

Vererbung

Object

Attribute

RecommendedAsConfigurableAttribute

Attribute

AttributeUsageAttribute ObsoleteAttribute

Beispiele

Im folgenden Beispiel wird eine Eigenschaft als Anwendungseinstellung verwendet.

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

Das nächste Beispiel zeigt, wie der Wert von RecommendedAsConfigurableAttribute für MyPropertyüberprüft wird. Zunächst ruft der Code eine PropertyDescriptorCollection mit allen Eigenschaften für das -Objekt ab. Als Nächstes indiziert es in den PropertyDescriptorCollection , um abzurufen MyProperty. Anschließend werden die Attribute für diese Eigenschaft zurückgegeben und in der Variablen attribute gespeichert.

In diesem Beispiel werden zwei verschiedene Möglichkeiten zum Überprüfen des Werts von RecommendedAsConfigurableAttributevorgestellt. Im zweiten Codefragment ruft das Beispiel die -Methode auf Equals . Im letzten Codefragment wird im Beispiel die RecommendedAsConfigurable -Eigenschaft verwendet, um den Wert zu überprüfen.

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

Wenn Sie eine Klasse mit RecommendedAsConfigurableAttributemarkiert haben, verwenden Sie den folgenden Code, um den Wert zu überprüfen.

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

Hinweise

Eigenschaften, die mit dem Wert gekennzeichnet sind, der RecommendedAsConfigurableAttribute angezeigt werden soll true , wenn Sie die Zeile Konfigurierbare Eigenschaften im Fenster Eigenschaften erweitern. Eine Eigenschaft, die keine empfohlene Einstellung aufweist oder die mit RecommendedAsConfigurableAttribute festgelegt auf false gekennzeichnet ist, wird nicht angezeigt und ist ein unwahrscheinlicher Kandidat für eine Anwendungseinstellung. Der Standardwert ist false.

Sie können eine Eigenschaft, die keinen RecommendedAsConfigurableAttribute hat, an eine Einstellung in Visual Studio binden, indem Sie unter Einstellungen im Fenster Eigenschaften auf die Schaltfläche mit den Auslassungspunkten klicken und die entsprechende Eigenschaft aus der Liste auswählen.

Hinweis

Wenn Sie eine Eigenschaft mit RecommendedAsConfigurableAttribute festgelegt auf truemarkieren, wird der Wert dieses Attributs auf das konstante Element Yesfestgelegt. Für eine Eigenschaft, die mit RecommendedAsConfigurableAttribute festgelegtem Wert falsegekennzeichnet ist, ist Noder Wert . Wenn Sie daher den Wert dieses Attributs in Ihrem Code überprüfen möchten, müssen Sie das Attribut als RecommendedAsConfigurableAttribute.Yes oder RecommendedAsConfigurableAttribute.Noangeben.

Weitere Informationen finden Sie unter Attribute.

.

Konstruktoren

RecommendedAsConfigurableAttribute(Boolean)

Veraltet. Initialisiert eine neue Instanz der RecommendedAsConfigurableAttribute-Klasse.

Felder

Default	Veraltet. Gibt den Standardwert für das RecommendedAsConfigurableAttribute an, der No ist. Dieses static-Feld ist schreibgeschützt.
No	Veraltet. Gibt an, dass eine Eigenschaft nicht als Anwendungseinstellung verwendet werden kann. Dieses static-Feld ist schreibgeschützt.
Yes	Veraltet. Gibt an, dass eine Eigenschaft als Anwendungseinstellung verwendet werden kann. Dieses static-Feld ist schreibgeschützt.

Eigenschaften

RecommendedAsConfigurable	Veraltet. Ruft einen Wert ab, der angibt, ob die Eigenschaft, an die dieses Attribut gebunden ist, als Anwendungseinstellung verwendet werden kann.
TypeId	Veraltet. Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute)

Methoden

Equals(Object)	Veraltet. Gibt an, ob diese Instanz und ein angegebenes Objekt gleich sind.
GetHashCode()	Veraltet. Gibt den Hashcode für diese Instanz zurück.
GetType()	Veraltet. Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Veraltet. Gibt an, ob der Wert dieser Instanz der Standardwert für die Klasse ist.
Match(Object)	Veraltet. Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht. (Geerbt von Attribute)
MemberwiseClone()	Veraltet. Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Veraltet. Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Weitere Informationen

• Attribute
• PropertyDescriptor
• AttributeCollection
• PropertyDescriptorCollection