EditorBrowsableAttribute Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Specifies that a property or method is viewable in an editor. This class cannot be inherited.
public ref class EditorBrowsableAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Constructor | System.AttributeTargets.Delegate | System.AttributeTargets.Enum | System.AttributeTargets.Event | System.AttributeTargets.Field | System.AttributeTargets.Interface | System.AttributeTargets.Method | System.AttributeTargets.Property | System.AttributeTargets.Struct)]
public sealed class EditorBrowsableAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Constructor | System.AttributeTargets.Delegate | System.AttributeTargets.Enum | System.AttributeTargets.Event | System.AttributeTargets.Field | System.AttributeTargets.Interface | System.AttributeTargets.Method | System.AttributeTargets.Property | System.AttributeTargets.Struct)>]
type EditorBrowsableAttribute = class
inherit Attribute
Public NotInheritable Class EditorBrowsableAttribute
Inherits Attribute
- Inheritance
- Attributes
Examples
The following sample demonstrates how to hide a property of a class from IntelliSense by setting the appropriate value for the EditorBrowsableAttribute attribute. Build Class1
in its own assembly.
In Visual Studio, create a new Windows Application solution, and add a reference to the assembly which contains Class1
. In the Form1 constructor, declare an instance of Class1
, type the name of the instance, and press the period key to activate the IntelliSense drop-down list of Class1
members. The Age
property does not appear in the drop-down list.
#using <system.dll>
using namespace System;
using namespace System::ComponentModel;
namespace EditorBrowsableDemo
{
public ref class Class1
{
public:
Class1()
{
//
// TODO: Add constructor logic here
//
}
private:
int ageval;
public:
[EditorBrowsable(EditorBrowsableState::Never)]
property int Age
{
int get()
{
return ageval;
}
void set( int value )
{
if ( ageval != value )
{
ageval = value;
}
}
}
};
}
using System;
using System.ComponentModel;
namespace EditorBrowsableDemo
{
public class Class1
{
public Class1()
{
//
// TODO: Add constructor logic here
//
}
int ageval;
[EditorBrowsable(EditorBrowsableState.Never)]
public int Age
{
get { return ageval; }
set
{
if (!ageval.Equals(value))
{
ageval = value;
}
}
}
}
}
Imports System.ComponentModel
Public Class Class1
Private ageval As Integer
<EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)> _
Public Property Age() As Integer
Get
Return ageval
End Get
Set(ByVal Value As Integer)
If Not ageval.Equals(Value) Then
ageval = Value
End If
End Set
End Property
End Class
Remarks
EditorBrowsableAttribute is a hint to a designer indicating whether a property or method is to be displayed. You can use this type in a visual designer or text editor to determine what is visible to the user. For example, the IntelliSense engine in Visual Studio uses this attribute to determine whether to show a property or method.
In Visual C#, you can control when advanced properties appear in IntelliSense and the Properties Window with the Hide Advanced Members setting under Tools | Options | Text Editor | C#. The corresponding EditorBrowsableState is Advanced.
Note
In Visual C#, EditorBrowsableAttribute does not suppress members from a class in the same assembly.
Constructors
EditorBrowsableAttribute() |
Initializes a new instance of the EditorBrowsableAttribute class with State set to the default state. |
EditorBrowsableAttribute(EditorBrowsableState) |
Initializes a new instance of the EditorBrowsableAttribute class with an EditorBrowsableState. |
Properties
State |
Gets the browsable state of the property or method. |
TypeId |
When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute) |
Methods
Equals(Object) |
Returns whether the value of the given object is equal to the current EditorBrowsableAttribute. |
GetHashCode() |
Returns the hash code for this instance. |
GetType() |
Gets the Type of the current instance. (Inherited from Object) |
IsDefaultAttribute() |
When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute) |
Match(Object) |
When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute) |
MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
ToString() |
Returns a string that represents the current object. (Inherited from Object) |
Explicit Interface Implementations
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) |
Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from 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. (Inherited from Attribute) |
_Attribute.GetTypeInfoCount(UInt32) |
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) |
Provides access to properties and methods exposed by an object. (Inherited from Attribute) |