RecommendedAsConfigurableAttribute Klasse

Definition

Warnung

Diese API ist jetzt veraltet.

Gibt an, dass die Eigenschaft als Anwendungseinstellung verwendet werden kann.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
Vererbung
RecommendedAsConfigurableAttribute
Attribute

Beispiele

Im folgenden Beispiel wird eine Eigenschaft als verwendbar als Anwendungs Einstellung markiert.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

Im nächsten Beispiel wird gezeigt, wie Sie den Wert der RecommendedAsConfigurableAttribute für MyPropertyüberprüfen.The next example shows how to check the value of the RecommendedAsConfigurableAttribute for MyProperty. Zuerst erhält der Code eine PropertyDescriptorCollection mit allen Eigenschaften für das-Objekt.First the code gets a PropertyDescriptorCollection with all the properties for the object. Im nächsten Schritt werden die PropertyDescriptorCollection, um MyPropertyzu erhalten.Next it indexes into the PropertyDescriptorCollection to get MyProperty. Anschließend werden die Attribute für diese Eigenschaft zurückgegeben und in der Attribut Variablen gespeichert.Then it returns the attributes for this property and saves them in the attributes variable.

In diesem Beispiel werden zwei verschiedene Methoden zum Überprüfen des Werts der RecommendedAsConfigurableAttributedargestellt.This example presents two different ways of checking the value of the RecommendedAsConfigurableAttribute. Im zweiten Code Fragment Ruft das Beispiel die Equals-Methode auf.In the second code fragment, the example calls the Equals method. Im letzten Code Fragment verwendet das Beispiel die RecommendedAsConfigurable-Eigenschaft, um den Wert zu überprüfen.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

Wenn Sie eine Klasse mit der RecommendedAsConfigurableAttributegekennzeichnet haben, verwenden Sie den folgenden Code, um den Wert zu überprüfen.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 

Hinweise

Eigenschaften, die mit dem RecommendedAsConfigurableAttribute festgelegt sind, true angezeigt, wenn Sie im Eigenschaften Fenster die Zeile ConfigurableProperties erweitern.Properties that are marked with the RecommendedAsConfigurableAttribute set to true display when you expand the ConfigurableProperties line in the Properties window. Eine Eigenschaft, die keine empfohlene Einstellung hat oder die mit RecommendedAsConfigurableAttribute auf false markiert ist, wird nicht angezeigt und ist für eine Anwendungs Einstellung unwahrscheinlich.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. Der Standardwert ist false.The default is false.

Sie können eine Eigenschaft, die keine RecommendedAsConfigurableAttribute hat, an eine Einstellung in Visual Studio binden, indem Sie im Fenster Eigenschaften unter Einstellungen auf die Schaltfläche mit den Auslassungs Punkten (...) klicken und die entsprechende Eigenschaft in der Liste auswählen.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.

Hinweis

Wenn Sie eine Eigenschaft markieren, bei der RecommendedAsConfigurableAttribute auf truefestgelegt ist, wird der Wert dieses Attributs auf das Konstante Element Yesfestgelegt.When you mark a property with RecommendedAsConfigurableAttribute set to true, the value of this attribute is set to the constant member Yes. Für eine Eigenschaft, die mit RecommendedAsConfigurableAttribute auf Wert falsefestgelegt ist, ist der Wert No.For a property marked with RecommendedAsConfigurableAttribute set to value false, the value is No. Wenn Sie also den Wert dieses Attributs im Code überprüfen möchten, müssen Sie das-Attribut als RecommendedAsConfigurableAttribute.Yes oder RecommendedAsConfigurableAttribute.Noangeben.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.

Weitere Informationen finden Sie unter Attribute.For more information, see Attributes.

..

Konstruktoren

RecommendedAsConfigurableAttribute(Boolean)

Initialisiert eine neue Instanz der RecommendedAsConfigurableAttribute-Klasse.Initializes a new instance of the RecommendedAsConfigurableAttribute class.

Felder

Default

Gibt den Standardwert für das RecommendedAsConfigurableAttribute an, der No ist.Specifies the default value for the RecommendedAsConfigurableAttribute, which is No. Dieses static-Feld ist schreibgeschützt.This static field is read-only.

No

Gibt an, dass eine Eigenschaft nicht als Anwendungseinstellung verwendet werden kann.Specifies that a property cannot be used as an application setting. Dieses static-Feld ist schreibgeschützt.This static field is read-only.

Yes

Gibt an, dass eine Eigenschaft als Anwendungseinstellung verwendet werden kann.Specifies that a property can be used as an application setting. Dieses static-Feld ist schreibgeschützt.This static field is read-only.

Eigenschaften

RecommendedAsConfigurable

Ruft einen Wert ab, der angibt, ob die Eigenschaft, an die dieses Attribut gebunden ist, als Anwendungseinstellung verwendet werden kann.Gets a value indicating whether the property this attribute is bound to can be used as an application setting.

TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Geerbt von Attribute)

Methoden

Equals(Object)

Gibt an, ob diese Instanz und ein angegebenes Objekt gleich sind.Indicates whether this instance and a specified object are equal.

GetHashCode()

Gibt den Hashcode für diese Instanz zurück.Returns the hash code for this instance.

GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
IsDefaultAttribute()

Gibt an, ob der Wert dieser Instanz der Standardwert für die Klasse ist.Indicates whether the value of this instance is the default value for the class.

Match(Object)

Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Geerbt von Attribute)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)

Explizite Schnittstellenimplementierungen

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

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(Geerbt von Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Geerbt von Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.Provides access to properties and methods exposed by an object.

(Geerbt von Attribute)

Gilt für:

Siehe auch