BrowsableAttribute.Browsable Property

Definition

Namespace:

System.ComponentModel

Assembly:

System.ComponentModel.Primitives.dll

Source:

BrowsableAttribute.cs

Gets a value indicating whether an object is browsable.

public:
 property bool Browsable { bool get(); };

public bool Browsable { get; }

member this.Browsable : bool

Public ReadOnly Property Browsable As Boolean

Property Value

Boolean

true if the object is browsable; otherwise, false.

Examples

The following example checks to see whether MyProperty is browsable. First the code gets the attributes for MyProperty by:

• Retrieving a PropertyDescriptorCollection with all the properties for the object.

• Indexing into the PropertyDescriptorCollection to get MyProperty.

• Saving the attributes for this property in the attributes variable.

Then the code sets myAttribute to the value of the BrowsableAttribute in the AttributeCollection and checks whether the property is browsable.

// Gets the attributes for the property.
AttributeCollection^ attributes = TypeDescriptor::GetProperties( this )[ "MyProperty" ]->Attributes;

// Checks to see if 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 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 property is browsable.
Dim myAttribute As BrowsableAttribute = CType(attributes(GetType(BrowsableAttribute)), BrowsableAttribute)
If myAttribute.Browsable Then
    ' Insert code here.
End If

See also

• BrowsableAttribute
• Attribute
• PropertyDescriptor
• EventDescriptor
• AttributeCollection
• PropertyDescriptorCollection