BrowsableAttribute Класс

Определение

Указывает, следует ли отображать свойство или событие в окне "Свойства".Specifies whether a property or event should be displayed in a Properties window.

public ref class BrowsableAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.All)]
public sealed class BrowsableAttribute : Attribute
type BrowsableAttribute = class
    inherit Attribute
Public NotInheritable Class BrowsableAttribute
Inherits Attribute
Наследование
BrowsableAttribute
Атрибуты

Примеры

В следующем примере свойство помечается как отображаемое.The following example marks a property as browsable.

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

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

В примере представлены два разных способа проверки значения BrowsableAttribute.The example presents two different ways of checking the value of the BrowsableAttribute. Во втором фрагменте кода в примере вызывается Equals метод.In the second code fragment, the example calls the Equals method. В последнем фрагменте кода в примере используется Browsable свойство для проверки значения.In the last code fragment, the example uses the Browsable 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 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помощью, используйте следующий код для проверки значения.If you marked a class with the BrowsableAttribute, use the following code to check the value.

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.A visual designer typically displays in the Properties window those members that either have no browsable attribute or are marked with the BrowsableAttribute constructor's browsable parameter set to true. Эти члены можно изменять во время разработки.These members can be modified at design time. Члены, помеченные BrowsableAttribute с помощью browsable параметра false конструктора, не подходят для редактирования во время разработки и поэтому не отображаются в визуальном конструкторе.Members marked with the BrowsableAttribute constructor's browsable parameter set to false are not appropriate for design-time editing and therefore are not displayed in a visual designer. Значение по умолчанию — true.The default is true.

Примечание

При пометке свойства с Browsable(true)значение этого атрибута устанавливается равным элементу YesConstant.When you mark a property with Browsable(true), the value of this attribute is set to the constant member Yes. Для свойства, помеченного Browsable(false)атрибутом, значением Noявляется.For a property marked with Browsable(false), the value is No. Поэтому при проверке значения этого атрибута в коде необходимо указать атрибут как BrowsableAttribute.Yes или. BrowsableAttribute.NoTherefore, when you check the value of this attribute in your code, you must specify the attribute as BrowsableAttribute.Yes or BrowsableAttribute.No.

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

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

BrowsableAttribute(Boolean)

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

Поля

Default

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

No

Указывает, что свойство или событие нельзя изменять во время разработки.Specifies that a property or event cannot be modified at design time. Это статическое (static) поле доступно только для чтения.This static field is read-only.

Yes

Указывает, что свойство или событие можно изменять во время разработки.Specifies that a property or event can be modified at design time. Это статическое (static) поле доступно только для чтения.This static field is read-only.

Свойства

Browsable

Возвращает значение, показывающее, будет ли объект отображаться в окне свойств.Gets a value indicating whether an object is browsable.

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()

Определяет, является ли этот атрибут используемым по умолчанию.Determines if this attribute is the default.

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)

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

Дополнительно