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. Затем он индексирует в, PropertyDescriptorCollection чтобы GetLanguage найти свойство.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.

Затем в примере распечатывается, является ли свойство конструктором только путем DesignOnlyAttribute извлечения AttributeCollectionиз и записи в экран консоли.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()))

Комментарии

Члены, помеченные DesignOnlyAttribute true атрибутом, могут быть установлены только во время разработки.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.

Элементы, которые либо не имеют атрибута, либо помечены DesignOnlyAttribute false набором, могут быть установлены во время выполнения.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.

Свойство со свойством DesignOnlyAttribute , для true которого установлено значение, сериализовано в RESX-файл, а не InitializeComponent в метод.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()

Возвращает строку, представляющую текущий объект.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)

Применяется к

Дополнительно