DesignOnlyAttribute Класс

Определение

Пространство имен:

System.ComponentModel

Сборка:

System.dll

Указывает, может ли свойство быть задано только во время разработки.

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.
        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 свойства. Затем он возвращает атрибуты для этого свойства и сохраняет их в переменной атрибутов.

Затем в примере отображается, является ли свойство дизайном только путем извлечения DesignOnlyAttribute из AttributeCollectionконсоли и записи его на экран консоли.

// 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 могут быть заданы только во время разработки. Как правило, эти свойства существуют только во время разработки и не соответствуют реальному свойству объекта во время выполнения.

Элементы, у которых нет атрибутов или помечены набором DesignOnlyAttributefalse , можно задать во время выполнения. Значение по умолчанию — false.

Свойство с набором DesignOnlyAttributetrue , которое сериализуется в RESX-файл, а не InitializeComponent метод.

Дополнительные сведения см. в разделе Атрибуты.

Конструкторы

Имя	Описание
DesignOnlyAttribute(Boolean)	Инициализирует новый экземпляр класса DesignOnlyAttribute.

Поля

Имя	Описание
Default	Указывает значение по умолчанию для параметра DesignOnlyAttribute, которое является No. Это static поле доступно только для чтения.
No	Указывает, что свойство можно задать во время разработки или во время выполнения. Это static поле доступно только для чтения.
Yes	Указывает, что свойство можно задать только во время разработки. Это static поле доступно только для чтения.

Свойства

Имя	Описание
IsDesignOnly	Возвращает значение, указывающее, можно ли задать свойство только во время разработки.
TypeId	При реализации в производном классе получает уникальный идентификатор для этого Attribute. (Унаследовано от Attribute)

Методы

Имя	Описание
Equals(Object)	Возвращает значение, равное ли заданному объекту текущее DesignOnlyAttributeзначение.
GetHashCode()	Возвращает хэш-код для этого экземпляра.
GetType()	Возвращает Type текущего экземпляра. (Унаследовано от Object)
IsDefaultAttribute()	Определяет, является ли этот атрибут значением по умолчанию.
Match(Object)	При переопределении в производном классе возвращает значение, указывающее, равен ли этот экземпляр указанному объекту. (Унаследовано от Attribute)
MemberwiseClone()	Создает неглубокую копию текущей Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

Явные реализации интерфейса

Имя	Описание
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации. (Унаследовано от Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Извлекает сведения о типе объекта, который можно использовать для получения сведений о типе для интерфейса. (Унаследовано от Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1). (Унаследовано от Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Предоставляет доступ к свойствам и методам, предоставляемым объектом. (Унаследовано от Attribute)

См. также раздел

• Attribute
• PropertyDescriptor