BrowsableAttribute Classe

Definição

Especifica se uma propriedade ou evento deve ser exibido em uma janela Propriedades.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
Herança
BrowsableAttribute
Atributos

Exemplos

O exemplo a seguir marca uma propriedade como navegável.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

O exemplo a seguir mostra como verificar o valor de BrowsableAttribute para. MyPropertyThe next example shows how to check the value of the BrowsableAttribute for MyProperty. Primeiro, o código obtém um PropertyDescriptorCollection com todas as propriedades do objeto.First, the code gets a PropertyDescriptorCollection with all the properties for the object. Em seguida, o código é indexado PropertyDescriptorCollection no MyPropertypara get.Next, the code indexes into the PropertyDescriptorCollection to get MyProperty. Em seguida, ele retorna os atributos dessa propriedade e os salva na variável attributes.Then it returns the attributes for this property and saves them in the attributes variable.

O exemplo apresenta duas maneiras diferentes de verificar o valor de BrowsableAttribute.The example presents two different ways of checking the value of the BrowsableAttribute. No segundo fragmento de código, o exemplo chama o Equals método.In the second code fragment, the example calls the Equals method. No último fragmento de código, o exemplo usa a Browsable propriedade para verificar o valor.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 

Se você marcou uma classe com o BrowsableAttribute, use o código a seguir para verificar o valor.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 

Comentários

Um designer visual normalmente é exibido na janela Propriedades os membros que não têm nenhum atributo navegável ou são marcados com BrowsableAttribute o parâmetro browsable do Construtor definido truecomo.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. Esses membros podem ser modificados em tempo de design.These members can be modified at design time. Os membros marcados com BrowsableAttribute o parâmetro browsable do Construtor definido false como não são apropriados para a edição de tempo de design e, portanto, não são exibidos em um designer visual.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. O padrão é true.The default is true.

Observação

Quando você marca uma propriedade com Browsable(true), o valor desse atributo é definido como o membro Yesconstante.When you mark a property with Browsable(true), the value of this attribute is set to the constant member Yes. Para uma propriedade marcada com Browsable(false), o valor é No.For a property marked with Browsable(false), the value is No. Portanto, ao verificar o valor desse atributo em seu código, você deve especificar o atributo como BrowsableAttribute.Yes ou. BrowsableAttribute.NoTherefore, when you check the value of this attribute in your code, you must specify the attribute as BrowsableAttribute.Yes or BrowsableAttribute.No.

Para obter mais informações, consulte Atributos.For more information, see Attributes.

Construtores

BrowsableAttribute(Boolean)

Inicializa uma nova instância da classe BrowsableAttribute.Initializes a new instance of the BrowsableAttribute class.

Campos

Default

Especifica o valor padrão para o BrowsableAttribute, que é Yes.Specifies the default value for the BrowsableAttribute, which is Yes. Esse campo static é somente leitura.This static field is read-only.

No

Especifica se uma propriedade ou um evento não pode ser modificado no tempo de design.Specifies that a property or event cannot be modified at design time. Esse campo static é somente leitura.This static field is read-only.

Yes

Especifica se uma propriedade ou um evento pode ser modificado no tempo de design.Specifies that a property or event can be modified at design time. Esse campo static é somente leitura.This static field is read-only.

Propriedades

Browsable

Obtém um valor que indica se um objeto é navegável.Gets a value indicating whether an object is browsable.

TypeId

Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Herdado de Attribute)

Métodos

Equals(Object)

Indica se essa instância e um objeto especificado são iguais.Indicates whether this instance and a specified object are equal.

GetHashCode()

Retorna o código hash para essa instância.Returns the hash code for this instance.

GetType()

Obtém o Type da instância atual.Gets the Type of the current instance.

(Herdado de Object)
IsDefaultAttribute()

Determina se este atributo é o padrão.Determines if this attribute is the default.

Match(Object)

Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Herdado de Attribute)
MemberwiseClone()

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

(Herdado de Object)
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object.

(Herdado de Object)

Implantações explícitas de interface

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

Mapeia um conjunto de nomes para um conjunto correspondente de identificadores de expedição.Maps a set of names to a corresponding set of dispatch identifiers.

(Herdado de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Recupera as informações de tipo para um objeto, que pode ser usado para obter as informações de tipo para uma interface.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Herdado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Retorna o número de interfaces de informações do tipo que um objeto fornece (0 ou 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Herdado de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Fornece acesso a propriedades e métodos expostos por um objeto.Provides access to properties and methods exposed by an object.

(Herdado de Attribute)

Aplica-se a

Veja também