BrowsableAttribute Clase

Definición

public ref class BrowsableAttribute sealed : Attribute

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

public sealed class BrowsableAttribute : Attribute

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

type BrowsableAttribute = class
    inherit Attribute

Public NotInheritable Class BrowsableAttribute
Inherits Attribute

Herencia

Object

Attribute

BrowsableAttribute

Atributos

AttributeUsageAttribute

Ejemplos

En el ejemplo siguiente se marca una propiedad como explorable.

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

En el ejemplo siguiente se muestra cómo comprobar el valor de para BrowsableAttributeMyProperty. En primer lugar, el código obtiene con PropertyDescriptorCollection todas las propiedades del objeto . A continuación, el código indexa en para PropertyDescriptorCollection obtener MyProperty. A continuación, devuelve los atributos de esta propiedad y los guarda en la variable attributes.

En el ejemplo se presentan dos formas diferentes de comprobar el valor de BrowsableAttribute. En el segundo fragmento de código, el ejemplo llama al Equals método . En el último fragmento de código, en el ejemplo se usa la Browsable propiedad para comprobar el valor.

// 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

Si marcó una clase con BrowsableAttribute, use el código siguiente para comprobar el valor.

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

Comentarios

Normalmente, un diseñador visual se muestra en el ventana Propiedades los miembros que no tienen ningún atributo de exploración o se marcan con el BrowsableAttribute parámetro del browsable constructor establecido trueen . Estos miembros se pueden modificar en tiempo de diseño. Los miembros marcados con el BrowsableAttribute parámetro del browsable constructor establecido false en no son adecuados para la edición en tiempo de diseño y, por tanto, no se muestran en un diseñador visual. El valor predeterminado es true.

Para obtener más información, consulte Attributes (Atributos).

Constructores

Campos

Propiedades

Métodos

Implementaciones de interfaz explícitas

Se aplica a

Consulte también

• Attribute
• PropertyDescriptor
• EventDescriptor
• AttributeCollection
• PropertyDescriptorCollection