RecommendedAsConfigurableAttribute Classe

Definição

Namespace:

System.ComponentModel

Assembly:

System.ComponentModel.TypeConverter.dll

Origem:

RecommendedAsConfigurableAttribute.cs

Cuidado

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

Especifica que a propriedade pode ser usada como uma configuração de aplicativo.

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

Herança

Object

Attribute

RecommendedAsConfigurableAttribute

Atributos

AttributeUsageAttribute ObsoleteAttribute

Exemplos

O exemplo a seguir marca uma propriedade como utilizável como uma configuração de aplicativo.

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

O exemplo a seguir mostra como marcar o valor do RecommendedAsConfigurableAttribute para MyProperty. Primeiro, o código obtém um PropertyDescriptorCollection com todas as propriedades do objeto . Em seguida, ele indexa para o PropertyDescriptorCollection para obter MyProperty. Em seguida, retorna os atributos dessa propriedade e os salva na variável de atributos.

Este exemplo apresenta duas maneiras diferentes de verificar o valor do RecommendedAsConfigurableAttribute. No segundo fragmento de código, o exemplo chama o Equals método . No último fragmento de código, o exemplo usa a RecommendedAsConfigurable propriedade para marcar o valor.

// 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 você marcou uma classe com o RecommendedAsConfigurableAttribute, use o código a seguir para marcar o valor.

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

Comentários

Propriedades marcadas com o RecommendedAsConfigurableAttribute conjunto a ser true exibido quando você expande a linha ConfigurableProperties na janela Propriedades . Uma propriedade que não tem nenhuma configuração recomendada ou marcada com definido como RecommendedAsConfigurableAttributefalse não é mostrada e é um candidato improvável para ser uma configuração de aplicativo. O padrão é false.

Você pode associar uma propriedade que não tem uma RecommendedAsConfigurableAttribute configuração no Visual Studio clicando no botão de reticências (...) em Configurações na janela Propriedades e selecionando a propriedade apropriada na lista.

Observação

Quando você marca uma propriedade com definido como RecommendedAsConfigurableAttributetrue, o valor desse atributo é definido como o membro Yesconstante . Para uma propriedade marcada com definido como RecommendedAsConfigurableAttribute valor false, o valor é No. Portanto, quando você deseja marcar o valor desse atributo em seu código, você deve especificar o atributo como RecommendedAsConfigurableAttribute.Yes ou RecommendedAsConfigurableAttribute.No.

Para obter mais informações, consulte Atributos.

.

Construtores

RecommendedAsConfigurableAttribute(Boolean)

Obsoleto. Inicializa uma nova instância da classe RecommendedAsConfigurableAttribute.

Campos

Default	Obsoleto. Especifica o valor padrão para o RecommendedAsConfigurableAttribute, que é No. Esse campo static é somente leitura.
No	Obsoleto. Especifica que uma propriedade não pode ser usada como uma configuração de aplicativo. Esse campo static é somente leitura.
Yes	Obsoleto. Especifica que uma propriedade pode ser usada como uma configuração de aplicativo. Esse campo static é somente leitura.

Propriedades

RecommendedAsConfigurable	Obsoleto. Obtém um valor que indica se a propriedade à qual esse atributo é associado pode ou não ser usada como uma configuração de aplicativo.
TypeId	Obsoleto. Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute. (Herdado de Attribute)

Métodos

Equals(Object)	Obsoleto. Indica se essa instância e um objeto especificado são iguais.
GetHashCode()	Obsoleto. Retorna o código hash para a instância.
GetType()	Obsoleto. Obtém o Type da instância atual. (Herdado de Object)
IsDefaultAttribute()	Obsoleto. Indica se o valor desta instância é o valor padrão da classe.
Match(Object)	Obsoleto. Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
MemberwiseClone()	Obsoleto. Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Obsoleto. Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)

Confira também

• Attribute
• PropertyDescriptor
• AttributeCollection
• PropertyDescriptorCollection