DesignOnlyAttribute 類別

定義

命名空間:

System.ComponentModel

組件:

System.ComponentModel.Primitives.dll

來源:

DesignOnlyAttribute.cs

指定屬性是否只能在設計階段進行設定。

public ref class DesignOnlyAttribute sealed : Attribute

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

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

Public NotInheritable Class DesignOnlyAttribute
Inherits Attribute

繼承

Object

Attribute

DesignOnlyAttribute

屬性

AttributeUsageAttribute

範例

下列範例會 GetLanguage 建立 屬性。 屬性會標示為 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。 首先，程式代碼會取得 PropertyDescriptorCollection 具有物件之所有屬性的 。 接下來，它會編製索引到 PropertyDescriptorCollection ，以尋找 GetLanguage 屬性。 然後它會傳回此屬性的屬性，並將其儲存在屬性變數中。

然後，此範例會列印屬性的設計方式是只藉由從 AttributeCollection擷取 DesignOnlyAttribute ，並將它寫入控制台畫面。

// 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()))

備註

標示為 DesignOnlyAttribute 集合 true 的成員只能在設計時間設定。 一般而言，這些屬性只存在於設計時間，而且不會對應至運行時間物件上的實際屬性。

在運行時間期間，沒有屬性或標記為 DesignOnlyAttribute 要設定 false 的成員。 預設為 false。

設定為 DesignOnlyAttributetrue 的屬性，其值會串行化為 .resx 檔案，而不是 InitializeComponent 方法。

如需詳細資訊，請參閱屬性。

建構函式

DesignOnlyAttribute(Boolean)

初始化 DesignOnlyAttribute 類別的新執行個體。

欄位

Default	指定 DesignOnlyAttribute 的預設值，就是 No。 這個 static 欄位是唯讀的。
No	指定屬性可在設計階段或 Run Time 進行設定。 這個 static 欄位是唯讀的。
Yes	指定屬性只能在設計階段進行設定。 這個 static 欄位是唯讀的。

屬性

IsDesignOnly	取得值，表示屬性是否只能在設計階段進行設定。
TypeId	在衍生類別中實作時，取得這個 Attribute 的唯一識別碼。 (繼承來源 Attribute)

方法

Equals(Object)	傳回值，表示指定的物件值是否等於目前的 DesignOnlyAttribute。
GetHashCode()	傳回這個執行個體的雜湊碼。
GetType()	取得目前執行個體的 Type。 (繼承來源 Object)
IsDefaultAttribute()	判斷這個屬性是否為預設值。
Match(Object)	在衍生類別中覆寫時，會傳回值，表示這個執行個體是否等於指定物件。 (繼承來源 Attribute)
MemberwiseClone()	建立目前 Object 的淺層複製。 (繼承來源 Object)
ToString()	傳回代表目前物件的字串。 (繼承來源 Object)

另請參閱

• Attribute
• PropertyDescriptor