RecommendedAsConfigurableAttribute Класс

Определение

Внимание!

Use System.ComponentModel.SettingsBindableAttribute instead to work with the new settings model.

Указывает, что это свойство может быть использовано в качестве параметра приложения.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
[System.AttributeUsage(System.AttributeTargets.Property)]
public class RecommendedAsConfigurableAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.Property)>]
[<System.Obsolete("Use System.ComponentModel.SettingsBindableAttribute instead to work with the new settings model.")>]
type RecommendedAsConfigurableAttribute = class
    inherit Attribute
[<System.AttributeUsage(System.AttributeTargets.Property)>]
type RecommendedAsConfigurableAttribute = class
    inherit Attribute
Public Class RecommendedAsConfigurableAttribute
Inherits Attribute
Наследование
RecommendedAsConfigurableAttribute
Атрибуты

Примеры

В следующем примере свойство отмечается как доступное для использования в качестве параметра приложения.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

В следующем примере показано, как проверить значение RecommendedAsConfigurableAttribute для MyProperty .The next example shows how to check the value of the RecommendedAsConfigurableAttribute for MyProperty. Сначала код получает PropertyDescriptorCollection со всеми свойствами для объекта.First the code gets a PropertyDescriptorCollection with all the properties for the object. Затем он индексирует в, PropertyDescriptorCollection чтобы получить MyProperty .Next it indexes into the PropertyDescriptorCollection to get MyProperty. Затем он возвращает атрибуты для этого свойства и сохраняет их в переменной attributes.Then it returns the attributes for this property and saves them in the attributes variable.

В этом примере представлены два разных способа проверки значения RecommendedAsConfigurableAttribute .This example presents two different ways of checking the value of the RecommendedAsConfigurableAttribute. Во втором фрагменте кода в примере вызывается Equals метод.In the second code fragment, the example calls the Equals method. В последнем фрагменте кода в примере используется RecommendedAsConfigurable свойство для проверки значения.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

Если вы пометили класс с помощью RecommendedAsConfigurableAttribute , используйте следующий код для проверки значения.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 

Комментарии

Свойства, отмеченные RecommendedAsConfigurableAttribute набором, true отображаемым при развертывании строки конфигураблепропертиес в окне " Свойства ".Properties that are marked with the RecommendedAsConfigurableAttribute set to true display when you expand the ConfigurableProperties line in the Properties window. Свойство, не имеющее рекомендуемых параметров или помеченное атрибутом RecommendedAsConfigurableAttribute Set, false не отображается, и маловероятно, что он является параметром приложения.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. Значение по умолчанию — false.The default is false.

Можно привязать свойство, которое не имеет RecommendedAsConfigurableAttribute к параметру в Visual Studio, нажав кнопку с многоточием (...) в разделе " Параметры " в окне " Свойства " и выбрав соответствующее свойство из списка.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.

Примечание

Если свойство помечается значением RecommendedAsConfigurableAttribute true , значение этого атрибута устанавливается равным элементу Constant Yes .When you mark a property with RecommendedAsConfigurableAttribute set to true, the value of this attribute is set to the constant member Yes. Для свойства, помеченного как RecommendedAsConfigurableAttribute значение false , используется значение No .For a property marked with RecommendedAsConfigurableAttribute set to value false, the value is No. Поэтому, если необходимо проверить значение этого атрибута в коде, необходимо указать атрибут как RecommendedAsConfigurableAttribute.Yes или RecommendedAsConfigurableAttribute.No .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.

Дополнительные сведения см. в разделе Атрибуты.For more information, see Attributes.

..

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

RecommendedAsConfigurableAttribute(Boolean)

Инициализирует новый экземпляр класса RecommendedAsConfigurableAttribute.Initializes a new instance of the RecommendedAsConfigurableAttribute class.

Поля

Default

Задает значение по умолчанию для атрибута RecommendedAsConfigurableAttribute, равное No.Specifies the default value for the RecommendedAsConfigurableAttribute, which is No. Это статическое (static) поле доступно только для чтения.This static field is read-only.

No

Определяет, что свойство не может быть использовано в качестве параметра приложения.Specifies that a property cannot be used as an application setting. Это статическое (static) поле доступно только для чтения.This static field is read-only.

Yes

Определяет, что свойство может использоваться в качестве параметра приложения.Specifies that a property can be used as an application setting. Это статическое (static) поле доступно только для чтения.This static field is read-only.

Свойства

RecommendedAsConfigurable

Возвращает значение, показывающее, может ли свойство, с которым связан этот атрибут, быть использовано в качестве параметра приложения.Gets a value indicating whether the property this attribute is bound to can be used as an application setting.

TypeId

В случае реализации в производном классе возвращает уникальный идентификатор для этого атрибута Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Унаследовано от Attribute)

Методы

Equals(Object)

Указывает, равен ли этот экземпляр заданному объекту.Indicates whether this instance and a specified object are equal.

GetHashCode()

Возвращает хэш-код данного экземпляра.Returns the hash code for this instance.

GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
IsDefaultAttribute()

Показывает, является ли значение этого экземпляра значением по умолчанию для класса.Indicates whether the value of this instance is the default value for the class.

Match(Object)

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Унаследовано от Attribute)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

Явные реализации интерфейса

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

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.Maps a set of names to a corresponding set of dispatch identifiers.

(Унаследовано от Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Возвращает сведения о типе объекта, которые можно использовать для получения сведений о типе интерфейса.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Унаследовано от Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Унаследовано от Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Предоставляет доступ к открытым свойствам и методам объекта.Provides access to properties and methods exposed by an object.

(Унаследовано от Attribute)

Применяется к

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