BrowsableAttribute BrowsableAttribute BrowsableAttribute BrowsableAttribute Class

定義

プロパティまたはイベントを [プロパティ] ウィンドウに表示するかどうかを指定します。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
継承
BrowsableAttributeBrowsableAttributeBrowsableAttributeBrowsableAttribute
属性

次の例では、プロパティを参照可能としてマークします。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

次の例では、 BrowsableAttribute MyPropertyのの値を確認する方法を示します。The next example shows how to check the value of the BrowsableAttribute for MyProperty. まず、このコードはオブジェクトPropertyDescriptorCollectionのすべてのプロパティを使用してを取得します。First, the code gets a PropertyDescriptorCollection with all the properties for the object. 次に、コードはにインデックスPropertyDescriptorCollectionを付けMyPropertyて取得します。Next, the code indexes into the PropertyDescriptorCollection to get MyProperty. 次に、このプロパティの属性を返し、それらを attributes 変数に保存します。Then it returns the attributes for this property and saves them in the attributes variable.

この例では、 BrowsableAttributeの値を確認する2つの異なる方法を示します。The example presents two different ways of checking the value of the BrowsableAttribute. 2番目のコード片では、このEquals例はメソッドを呼び出します。In the second code fragment, the example calls the Equals method. 最後のコードフラグメントでは、 Browsableプロパティを使用して値をチェックします。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 

クラスをでBrowsableAttributeマークした場合は、次のコードを使用して値を確認します。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 

注釈

ビジュアルデザイナーは、通常、参照可能な属性がないか、 BrowsableAttributeコンストラクターのbrowsableパラメーターをに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. これらのメンバーは、デザイン時に変更できます。These members can be modified at design time. コンストラクターのBrowsableAttribute browsableパラメーターをにfalse設定してマークされたメンバーは、デザイン時編集に適していないため、ビジュアルデザイナーに表示されません。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. 既定値は、true です。The default is true.

注意

プロパティをでBrowsable(true)マークすると、この属性の値は定数メンバー Yesに設定されます。When you mark a property with Browsable(true), the value of this attribute is set to the constant member Yes. Browsable(false)マークされたプロパティの場合、 No値はになります。For a property marked with Browsable(false), the value is No. したがって、コード内でこの属性の値を確認する場合は、属性をまたはBrowsableAttribute.Yes 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.

詳細については、「属性」を参照してください。For more information, see Attributes.

コンストラクター

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

BrowsableAttribute クラスの新しいインスタンスを初期化します。Initializes a new instance of the BrowsableAttribute class.

フィールド

Default Default Default Default

BrowsableAttribute の既定値 (Yes) を指定します。Specifies the default value for the BrowsableAttribute, which is Yes. static フィールドは読み取り専用です。This static field is read-only.

No No No No

特定のプロパティまたはイベントをデザイン時に変更できないことを指定します。Specifies that a property or event cannot be modified at design time. static フィールドは読み取り専用です。This static field is read-only.

Yes Yes Yes Yes

特定のプロパティまたはイベントをデザイン時に変更できることを指定します。Specifies that a property or event can be modified at design time. static フィールドは読み取り専用です。This static field is read-only.

プロパティ

Browsable Browsable Browsable Browsable

オブジェクトが参照可能かどうかを示す値を取得します。Gets a value indicating whether an object is browsable.

TypeId TypeId TypeId TypeId

派生クラスで実装されると、この Attribute の一意の識別子を取得します。When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

メソッド

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

このインスタンスと指定したオブジェクトが等しいかどうかを示します。Indicates whether this instance and a specified object are equal.

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

このインスタンスのハッシュ コードを返します。Returns the hash code for this instance.

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

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

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

この属性が既定値かどうかを判断します。Determines if this attribute is the default.

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

派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。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()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

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

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)

明示的なインターフェイスの実装

_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)

一連の名前を対応する一連のディスパッチ識別子に割り当てます。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)

オブジェクトの型情報を取得します。この情報はインターフェイスの型情報の取得に使用できます。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)

オブジェクトが提供する型情報インターフェイスの数 (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)

オブジェクトによって公開されたプロパティおよびメソッドへのアクセスを提供します。Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

適用対象

こちらもご覧ください