BrowsableAttribute クラス

定義

名前空間:

System.ComponentModel

アセンブリ:

System.ComponentModel.Primitives.dll

ソース:

BrowsableAttribute.cs

プロパティまたはイベントを [プロパティ] ウィンドウに表示するかどうかを指定します。

public ref class BrowsableAttribute sealed : Attribute

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

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

Public NotInheritable Class BrowsableAttribute
Inherits Attribute

継承

Object

Attribute

BrowsableAttribute

属性

AttributeUsageAttribute

例

次の例では、プロパティをブロウズ可能としてマークします。

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

次の例では、 の 値をチェックする方法をBrowsableAttributeMyProperty示します。 最初に、コードは オブジェクトのすべてのプロパティを持つ を取得 PropertyDescriptorCollection します。 次に、コードが にインデックスを作成 PropertyDescriptorCollection して を取得 MyPropertyします。 次に、このプロパティの属性を返し、それらを attributes 変数に保存します。

この例では、 の値を確認する 2 つの異なる方法を示します BrowsableAttribute。 2 番目のコード フラグメントでは、 メソッドを呼び出します Equals 。 最後のコード フラグメントでは、 プロパティをBrowsable使用して値をチェックします。

// 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、次のコードを使用して値をチェックします。

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

注釈

ビジュアル デザイナーは、通常、browsable 属性を持たないメンバー、またはコンストラクターbrowsableの パラメーターが に設定されているBrowsableAttributeメンバーをプロパティ ウィンドウにtrue表示します。 これらのメンバーはデザイン時に変更できます。 コンストラクターの browsable パラメーターが BrowsableAttribute にfalse設定されているメンバーは、デザイン時の編集には適していないため、ビジュアル デザイナーには表示されません。 既定値は、true です。

Note

プロパティを に Browsable(true)マークすると、この属性の値は定数メンバー Yesに設定されます。 で Browsable(false)マークされたプロパティの場合、値は です No。 したがって、コードでこの属性の値をチェックする場合は、 属性を または BrowsableAttribute.NoとしてBrowsableAttribute.Yes指定する必要があります。

詳細については、「属性」を参照してください。

コンストラクター

BrowsableAttribute(Boolean)

BrowsableAttribute クラスの新しいインスタンスを初期化します。

フィールド

Default	BrowsableAttribute の既定値 (Yes) を指定します。 static フィールドは読み取り専用です。
No	特定のプロパティまたはイベントをデザイン時に変更できないことを指定します。 static フィールドは読み取り専用です。
Yes	特定のプロパティまたはイベントをデザイン時に変更できることを指定します。 static フィールドは読み取り専用です。

プロパティ

Browsable	オブジェクトが参照可能かどうかを示す値を取得します。
TypeId	派生クラスで実装されると、この Attribute の一意の識別子を取得します。 (継承元 Attribute)

メソッド

Equals(Object)	このインスタンスと指定したオブジェクトが等しいかどうかを示します。
GetHashCode()	このインスタンスのハッシュ コードを返します。
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
IsDefaultAttribute()	この属性が既定値かどうかを判断します。
Match(Object)	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 (継承元 Attribute)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

こちらもご覧ください

• Attribute
• PropertyDescriptor
• EventDescriptor
• AttributeCollection
• PropertyDescriptorCollection