DesignOnlyAttribute クラス

定義

プロパティを設定できるのがデザイン時だけかどうかを指定します。Specifies whether a property can only be set at design time.

public ref class DesignOnlyAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.All)]
public sealed class DesignOnlyAttribute : Attribute
type DesignOnlyAttribute = class
    inherit Attribute
Public NotInheritable Class DesignOnlyAttribute
Inherits Attribute
継承
DesignOnlyAttribute
属性

次の例では、GetLanguage プロパティを作成します。The following example creates a GetLanguage property. プロパティは、DesignOnlyAttributeでマークされます。The property is marked with a DesignOnlyAttribute.

public:
   [DesignOnly(true)]
   property CultureInfo^ GetLanguage 
   {
      CultureInfo^ get()
      {
         // Insert code here.
         return myCultureInfo;
      }
      void set( CultureInfo^ value )
      {
         // Insert code here.
      }
   }
[DesignOnly(true)]
 public CultureInfo GetLanguage {
    get {
       // Insert code here.
       return myCultureInfo;
    }
    set {
       // Insert code here.
    }
 }
<DesignOnly(True)> _
Public Property GetLanguage() As CultureInfo
    Get
        ' Insert code here.
        Return myCultureInfo
    End Get
    Set
        ' Insert code here.
    End Set
End Property

次の例では、DesignOnlyAttributeの値を取得します。The next example gets the value of the DesignOnlyAttribute. まず、このコードでは、オブジェクトのすべてのプロパティを含む PropertyDescriptorCollection を取得します。First the code gets a PropertyDescriptorCollection with all the properties for the object. 次に、GetLanguage プロパティを検索するために PropertyDescriptorCollection にインデックスを付けます。Next it indexes into the PropertyDescriptorCollection to find the GetLanguage property. 次に、このプロパティの属性を返し、それらを attributes 変数に保存します。Then it returns the attributes for this property and saves them in the attributes variable.

この例では、AttributeCollectionから DesignOnlyAttribute を取得し、コンソール画面に書き込むことによって、プロパティがデザインのみであるかどうかを出力します。The example then prints whether the property is design only by retrieving DesignOnlyAttribute from the AttributeCollection, and writing it to the console screen.

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

/* Prints whether the property is marked as DesignOnly 
by retrieving the DesignOnlyAttribute from the AttributeCollection. */
DesignOnlyAttribute^ myAttribute = dynamic_cast<DesignOnlyAttribute^>(attributes[ DesignOnlyAttribute::typeid ]);
Console::WriteLine( "This property is design only :{0}", myAttribute->IsDesignOnly );
// Gets the attributes for the property.
 AttributeCollection attributes = 
    TypeDescriptor.GetProperties(this)["GetLanguage"].Attributes;

 /* Prints whether the property is marked as DesignOnly 
  * by retrieving the DesignOnlyAttribute from the AttributeCollection. */
 DesignOnlyAttribute myAttribute = 
    (DesignOnlyAttribute)attributes[typeof(DesignOnlyAttribute)];
 Console.WriteLine("This property is design only :" +
    myAttribute.IsDesignOnly.ToString());
' Gets the attributes for the property.
Dim attributes As AttributeCollection = _
    TypeDescriptor.GetProperties(Me)("GetLanguage").Attributes

' Prints whether the property is marked as DesignOnly 
' by retrieving the DesignOnlyAttribute from the AttributeCollection.
Dim myAttribute As DesignOnlyAttribute = _
    CType(attributes(GetType(DesignOnlyAttribute)), DesignOnlyAttribute)
Console.WriteLine(("This property is design only :" & _
    myAttribute.IsDesignOnly.ToString()))

注釈

DesignOnlyAttributetrue に設定してマークされたメンバーは、デザイン時にのみ設定できます。Members marked with the DesignOnlyAttribute set to true can be set only at design time. 通常、これらのプロパティはデザイン時にのみ存在し、オブジェクトの実際のプロパティには実行時には対応しません。Typically, these properties exist only at design time and do not correspond to a real property on the object at run time.

属性を持たないメンバー、または false に設定された DesignOnlyAttribute でマークされているメンバーは、実行時に設定できます。Members that either have no attribute or are marked with the DesignOnlyAttribute set to false can be set during run time. 既定値は、false です。The default is false.

DesignOnlyAttributetrue に設定されたプロパティの値は、InitializeComponent メソッドではなく .resx ファイルにシリアル化されます。A property with the DesignOnlyAttribute set to true has its value serialized to the .resx file instead of the InitializeComponent method.

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

コンストラクター

DesignOnlyAttribute(Boolean)

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

フィールド

Default

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

No

プロパティをデザイン時に設定できるか、または実行時に設定できるかを指定します。Specifies that a property can be set at design time or at run time. static フィールドは読み取り専用です。This static field is read-only.

Yes

プロパティを設定できるのがデザイン時だけであることを指定します。Specifies that a property can be set only at design time. static フィールドは読み取り専用です。This static field is read-only.

プロパティ

IsDesignOnly

プロパティを設定できるのがデザイン時だけかどうかを示す値を取得します。Gets a value indicating whether a property can be set only at design time.

TypeId

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

(継承元 Attribute)

メソッド

Equals(Object)

指定したオブジェクトの値が現在の DesignOnlyAttribute と等しいかどうかを示す値を返します。Returns whether the value of the given object is equal to the current DesignOnlyAttribute.

GetHashCode()

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

GetType()

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

(継承元 Object)
IsDefaultAttribute()

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

Match(Object)

派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(継承元 Attribute)
MemberwiseClone()

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

(継承元 Object)
ToString()

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

(継承元 Object)

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

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

一連の名前を対応する一連のディスパッチ識別子に割り当てます。Maps a set of names to a corresponding set of dispatch identifiers.

(継承元 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.

(継承元 Attribute)
_Attribute.GetTypeInfoCount(UInt32)

オブジェクトが提供する型情報インターフェイスの数 (0 または 1) を取得します。Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(継承元 Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

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

(継承元 Attribute)

適用対象

こちらもご覧ください