BrowsableAttribute Класс

Определение

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

System.ComponentModel

Сборки:

netstandard.dll, System.ComponentModel.Primitives.dll

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

BrowsableAttribute.cs

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

public ref class BrowsableAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.All)]
public sealed class BrowsableAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.All)>]
type BrowsableAttribute = class
    inherit Attribute

Public NotInheritable Class BrowsableAttribute
Inherits Attribute

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

Object

Attribute

BrowsableAttribute

Атрибуты

AttributeUsageAttribute

Примеры

В следующем примере свойство помечает как просматриваемое.

public:
   [Browsable(true)]
   property int MyProperty 
   {
      int get()
      {
         // Insert code here.
         return 0;
      }
      void set( int value )
      {
         // Insert code here.
      }
   }

[Browsable(true)]
public int MyProperty
{
    get =>
        // Insert code here.
        0;
    set
    {
        // Insert code here.
    }
}

<Browsable(True)> _
Public Property MyProperty() As Integer
    Get
        ' Insert code here.
        Return 0
    End Get
    Set
        ' Insert code here.
    End Set 
End Property

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

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

// Gets the attributes for the property.
AttributeCollection^ attributes = TypeDescriptor::GetProperties( this )[ "MyProperty" ]->Attributes;

// Checks to see if the value of the BrowsableAttribute is Yes.
if ( attributes[ BrowsableAttribute::typeid ]->Equals( BrowsableAttribute::Yes ) )
{
   
   // Insert code here.
}

// This is another way to see whether the property is browsable.
BrowsableAttribute^ myAttribute = dynamic_cast<BrowsableAttribute^>(attributes[ BrowsableAttribute::typeid ]);
if ( myAttribute->Browsable )
{
   // Insert code here.
}

// Gets the attributes for the property.
AttributeCollection attributes =
   TypeDescriptor.GetProperties(this)["MyProperty"].Attributes;

// Checks to see if the value of the BrowsableAttribute is Yes.
if (attributes[typeof(BrowsableAttribute)].Equals(BrowsableAttribute.Yes))
{
    // Insert code here.
}

// This is another way to see whether the property is browsable.
BrowsableAttribute myAttribute =
   (BrowsableAttribute)attributes[typeof(BrowsableAttribute)];
if (myAttribute.Browsable)
{
    // 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 BrowsableAttribute is Yes.
If attributes(GetType(BrowsableAttribute)).Equals(BrowsableAttribute.Yes) Then
    ' Insert code here.
End If 

' This is another way to see whether the property is browsable.
Dim myAttribute As BrowsableAttribute = _
    CType(attributes(GetType(BrowsableAttribute)), BrowsableAttribute)
If myAttribute.Browsable Then
    ' Insert code here.
End If

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

AttributeCollection^ attributes = TypeDescriptor::GetAttributes( MyProperty );
if ( attributes[ BrowsableAttribute::typeid ]->Equals( BrowsableAttribute::Yes ) )
{
   // Insert code here.
}

AttributeCollection attributes =
    TypeDescriptor.GetAttributes(MyProperty);
if (attributes[typeof(BrowsableAttribute)].Equals(BrowsableAttribute.Yes))
{
    // Insert code here.
}

Dim attributes As AttributeCollection = TypeDescriptor.GetAttributes(MyProperty)
If attributes(GetType(BrowsableAttribute)).Equals(BrowsableAttribute.Yes) Then
    ' Insert code here.
End If

Комментарии

Визуальный конструктор обычно отображается в окне свойств те элементы, которые либо не имеют атрибута просмотра, либо помечены BrowsableAttribute параметром trueконструктораbrowsable. Эти элементы можно изменить во время разработки. Элементы, BrowsableAttribute помеченные параметром конструктора browsablefalse , не подходят для редактирования во время разработки и поэтому не отображаются в визуальном конструкторе. Значение по умолчанию — true.

Замечание

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

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

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

Имя	Описание
BrowsableAttribute(Boolean)	Инициализирует новый экземпляр класса BrowsableAttribute.

Поля

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

Свойства

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

Методы

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

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

• Attribute
• PropertyDescriptor
• EventDescriptor
• AttributeCollection
• PropertyDescriptorCollection