RecommendedAsConfigurableAttribute Třída

Definice

Obor názvů:

System.ComponentModel

Sestavení:

System.ComponentModel.TypeConverter.dll

Zdroj:

RecommendedAsConfigurableAttribute.cs

Upozornění

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

Určuje, že vlastnost lze použít jako nastavení aplikace.

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

Dědičnost

Object

Attribute

RecommendedAsConfigurableAttribute

Atributy

AttributeUsageAttribute ObsoleteAttribute

Příklady

Následující příklad označí vlastnost jako použitelnou jako nastavení aplikace.

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

Další příklad ukazuje, jak zkontrolovat hodnotu RecommendedAsConfigurableAttribute pro MyProperty. Nejprve kód získá objekt se PropertyDescriptorCollection všemi vlastnostmi objektu. Dále indexuje do objektu , PropertyDescriptorCollection aby získal MyProperty. Potom vrátí atributy pro tuto vlastnost a uloží je do proměnné atributů.

Tento příklad představuje dva různé způsoby kontroly hodnoty RecommendedAsConfigurableAttribute. V druhém fragmentu kódu volá příklad metodu Equals . V posledním fragmentu kódu používá příklad RecommendedAsConfigurable vlastnost ke kontrole hodnoty.

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

Pokud jste třídu označili RecommendedAsConfigurableAttributepomocí , zkontrolujte hodnotu následujícím kódem.

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

Poznámky

Vlastnosti, které jsou označeny RecommendedAsConfigurableAttribute nastavením, který se true má zobrazit při rozbalení konfigurovatelné vlastnosti řádek v okně Vlastnosti . Vlastnost, která nemá žádné doporučené nastavení nebo která je označena RecommendedAsConfigurableAttribute jako nastavená na false , se nezobrazuje a je nepravděpodobným kandidátem na nastavení aplikace. Výchozí formát je false.

Vlastnost, která nemá, můžete vytvořit vazbu k nastavení v sadě Visual Studio kliknutím na tlačítko se třemi RecommendedAsConfigurableAttribute tečky (...) v části Nastavení v okně Vlastnosti a výběrem příslušné vlastnosti ze seznamu.

Poznámka

Když označíte vlastnost nastavenou RecommendedAsConfigurableAttribute na true, hodnota tohoto atributu se nastaví na konstantní člen Yes. Pro vlastnost označenou nastavenou RecommendedAsConfigurableAttribute na hodnotu falseje Nohodnota . Proto pokud chcete zkontrolovat hodnotu tohoto atributu v kódu, musíte zadat atribut jako RecommendedAsConfigurableAttribute.Yes nebo RecommendedAsConfigurableAttribute.No.

Další informace najdete v tématu Atributy.

.

Konstruktory

RecommendedAsConfigurableAttribute(Boolean)

Zastaralé. Inicializuje novou instanci RecommendedAsConfigurableAttribute třídy.

Pole

Default	Zastaralé. Určuje výchozí hodnotu pro RecommendedAsConfigurableAttribute, což je No. Toto static pole je jen pro čtení.
No	Zastaralé. Určuje, že vlastnost nelze použít jako nastavení aplikace. Toto static pole je jen pro čtení.
Yes	Zastaralé. Určuje, že vlastnost lze použít jako nastavení aplikace. Toto static pole je jen pro čtení.

Vlastnosti

RecommendedAsConfigurable	Zastaralé. Získá hodnotu označující, zda vlastnost, na kterou je tento atribut vázán, lze použít jako nastavení aplikace.
TypeId	Zastaralé. Při implementaci v odvozené třídě získá jedinečný identifikátor pro tuto Attributetřídu . (Zděděno od Attribute)

Metody

Equals(Object)	Zastaralé. Udává, zda je tato instance totožná se zadaným objektem.
GetHashCode()	Zastaralé. Vrátí hodnotu hash pro tuto instanci.
GetType()	Zastaralé. Získá aktuální Type instanci. (Zděděno od Object)
IsDefaultAttribute()	Zastaralé. Určuje, zda je hodnota této instance výchozí hodnotou pro třídu.
Match(Object)	Zastaralé. Při přepsání v odvozené třídě vrátí hodnotu, která označuje, zda se tato instance rovná zadanému objektu. (Zděděno od Attribute)
MemberwiseClone()	Zastaralé. Vytvoří mělkou kopii aktuálního Objectsouboru . (Zděděno od Object)
ToString()	Zastaralé. Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Viz také

• Attribute
• PropertyDescriptor
• AttributeCollection
• PropertyDescriptorCollection