BrowsableAttribute Класс

Определение

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

System.ComponentModel

Сборка:

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.
        return 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

В следующем примере показано, как проверка значение для BrowsableAttributeMyProperty. Во-первых, код получает со 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 конструктораbrowsable, имеющим значение true. Эти элементы можно изменять во время разработки. Элементы, помеченные параметром BrowsableAttributefalse конструктораbrowsable, не подходят для редактирования во время разработки и, следовательно, не отображаются в визуальном конструкторе. Значение по умолчанию — 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