BrowsableAttribute BrowsableAttribute BrowsableAttribute BrowsableAttribute Class

Definition

Especifica si una propiedad o evento se debería mostrar en una ventana Propiedades. 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
Inheritance
BrowsableAttributeBrowsableAttributeBrowsableAttributeBrowsableAttribute
Attributes

Examples

El ejemplo siguiente marca una propiedad como explorable.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

El ejemplo siguiente muestra cómo comprobar el valor de la BrowsableAttribute para MyProperty.The next example shows how to check the value of the BrowsableAttribute for MyProperty. En primer lugar, el código obtiene una PropertyDescriptorCollection con todas las propiedades del objeto.First, the code gets a PropertyDescriptorCollection with all the properties for the object. A continuación, el código se indiza en la PropertyDescriptorCollection obtener MyProperty.Next, the code indexes into the PropertyDescriptorCollection to get MyProperty. A continuación, devuelve los atributos de esta propiedad y los guarda en la variable de atributos.Then it returns the attributes for this property and saves them in the attributes variable.

En el ejemplo se muestra dos formas diferentes de comprobar el valor de la BrowsableAttribute.The example presents two different ways of checking the value of the BrowsableAttribute. En el segundo fragmento de código, se llama el Equals método.In the second code fragment, the example calls the Equals method. En el último fragmento de código, el ejemplo se usa el Browsable propiedad para comprobar el 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 

Si marca una clase con el BrowsableAttribute, use el código siguiente para comprobar el 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 

Remarks

Un diseñador visual muestra normalmente en la ventana Propiedades de esos miembros que no tienen ningún atributo browsable o se marcan con el BrowsableAttribute del constructor browsable parámetro establecido en 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. Estos miembros pueden modificarse en tiempo de diseño.These members can be modified at design time. Los miembros marcados con el BrowsableAttribute del constructor browsable parámetro establecido en false no son adecuadas para su edición de tiempo de diseño y, por tanto, no se muestran en un diseñador 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. El valor predeterminado es true.The default is true.

Nota

Cuando se marca una propiedad con Browsable(true), el valor de este atributo se establece en el miembro constante Yes.When you mark a property with Browsable(true), the value of this attribute is set to the constant member Yes. Para una propiedad marcada con Browsable(false), el valor es No.For a property marked with Browsable(false), the value is No. Por lo tanto, si se selecciona el valor de este atributo en el código, debe especificar el atributo como BrowsableAttribute.Yes o BrowsableAttribute.No.Therefore, when you check the value of this attribute in your code, you must specify the attribute as BrowsableAttribute.Yes or BrowsableAttribute.No.

Para obtener más información, consulte Attributes (Atributos).For more information, see Attributes.

Constructors

BrowsableAttribute(Boolean) BrowsableAttribute(Boolean) BrowsableAttribute(Boolean) BrowsableAttribute(Boolean)

Inicializa una nueva instancia de la clase BrowsableAttribute. Initializes a new instance of the BrowsableAttribute class.

Fields

Default Default Default Default

Especifica el valor predeterminado de BrowsableAttribute, que es Yes. Specifies the default value for the BrowsableAttribute, which is Yes. Este campo static es de solo lectura. This static field is read-only.

No No No No

Especifica que no se puede modificar una propiedad o un evento en tiempo de diseño. Specifies that a property or event cannot be modified at design time. Este campo static es de solo lectura. This static field is read-only.

Yes Yes Yes Yes

Especifica que se puede modificar una propiedad o un evento en tiempo de diseño. Specifies that a property or event can be modified at design time. Este campo static es de solo lectura. This static field is read-only.

Properties

Browsable Browsable Browsable Browsable

Obtiene un valor que indica si un objeto se puede examinar. Gets a value indicating whether an object is browsable.

TypeId TypeId TypeId TypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute. When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Methods

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Indica si esta instancia y un objeto especificado son iguales. Indicates whether this instance and a specified object are equal.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Devuelve el código hash de esta instancia. Returns the hash code for this instance.

GetType() GetType() GetType() GetType()

Obtiene el Type de la instancia actual. Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

Determina si este atributo es el valor predeterminado. Determines if this attribute is the default.

Match(Object) Match(Object) Match(Object) Match(Object)

Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado. When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crea una copia superficial del Object actual. Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Devuelve una cadena que representa el objeto actual. Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

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

Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío. Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz. Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1). Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Proporciona acceso a las propiedades y los métodos expuestos por un objeto. Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Applies to

See Also