RecommendedAsConfigurableAttribute Класс

Определение

Пространство имен:

System.ComponentModel

Сборка:

System.ComponentModel.TypeConverter.dll

Исходный код:

RecommendedAsConfigurableAttribute.cs

Внимание!

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

Указывает, что это свойство может быть использовано в качестве параметра приложения.

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

Наследование

Object

Attribute

RecommendedAsConfigurableAttribute

Атрибуты

AttributeUsageAttribute ObsoleteAttribute

Примеры

В следующем примере свойство помечает как пригодное для использования в качестве параметра приложения.

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

В следующем примере показано, как проверка значение для RecommendedAsConfigurableAttributeMyProperty. Сначала код получает со PropertyDescriptorCollection всеми свойствами объекта . Затем он индексирует в , PropertyDescriptorCollection чтобы получить MyProperty. Затем он возвращает атрибуты для этого свойства и сохраняет их в переменной атрибутов.

В этом примере представлены два разных способа проверки значения RecommendedAsConfigurableAttribute. Во втором фрагменте кода в примере вызывается Equals метод . В последнем фрагменте кода в примере используется RecommendedAsConfigurable свойство для проверка значения.

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

Если вы пометили класс с RecommendedAsConfigurableAttributeпомощью , используйте следующий код, чтобы проверка значение .

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

Комментарии

Свойства, помеченные набором RecommendedAsConfigurableAttribute для true отображения при развертывании строки ConfigurableProperties в окне Свойства . Свойство, у которого нет рекомендуемого параметра или отмечено значением RecommendedAsConfigurableAttributefalse , не отображается и является маловероятным кандидатом на роль параметра приложения. Значение по умолчанию — false.

Вы можете привязать свойство, у которых RecommendedAsConfigurableAttribute нет , к параметру в Visual Studio, нажав кнопку с многоточием (...) в разделе Параметры в окне Свойства и выбрав соответствующее свойство из списка.

Примечание

Если для свойства RecommendedAsConfigurableAttribute задано значение true, для этого атрибута устанавливается константный член Yes. Для свойства, помеченного значением RecommendedAsConfigurableAttribute , falseзначение равно No. Поэтому, если вы хотите проверка значение этого атрибута в коде, необходимо указать атрибут как RecommendedAsConfigurableAttribute.Yes или RecommendedAsConfigurableAttribute.No.

Дополнительные сведения см. в разделе Атрибуты.

.

Конструкторы

RecommendedAsConfigurableAttribute(Boolean)

Устаревшие.. Инициализирует новый экземпляр класса RecommendedAsConfigurableAttribute.

Поля

Default	Устаревшие.. Задает значение по умолчанию для атрибута RecommendedAsConfigurableAttribute, равное No. Это статическое (static) поле доступно только для чтения.
No	Устаревшие.. Определяет, что свойство не может быть использовано в качестве параметра приложения. Это статическое (static) поле доступно только для чтения.
Yes	Устаревшие.. Определяет, что свойство может использоваться в качестве параметра приложения. Это статическое (static) поле доступно только для чтения.

Свойства

RecommendedAsConfigurable	Устаревшие.. Возвращает значение, показывающее, может ли свойство, с которым связан этот атрибут, быть использовано в качестве параметра приложения.
TypeId	Устаревшие.. В случае реализации в производном классе возвращает уникальный идентификатор для этого атрибута Attribute. (Унаследовано от Attribute)

Методы

Equals(Object)	Устаревшие.. Указывает, равен ли этот экземпляр заданному объекту.
GetHashCode()	Устаревшие.. Возвращает хэш-код данного экземпляра.
GetType()	Устаревшие.. Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
IsDefaultAttribute()	Устаревшие.. Показывает, является ли значение этого экземпляра значением по умолчанию для класса.
Match(Object)	Устаревшие.. При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту. (Унаследовано от Attribute)
MemberwiseClone()	Устаревшие.. Создает неполную копию текущего объекта Object. (Унаследовано от Object)
ToString()	Устаревшие.. Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

См. также раздел

• Attribute
• PropertyDescriptor
• AttributeCollection
• PropertyDescriptorCollection