DesignOnlyAttribute DesignOnlyAttribute DesignOnlyAttribute DesignOnlyAttribute Class

Definition

Especifica si una propiedad sólo se puede establecer en tiempo de diseño. 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
Inheritance
DesignOnlyAttributeDesignOnlyAttributeDesignOnlyAttributeDesignOnlyAttribute
Attributes

Examples

En el ejemplo siguiente se crea un GetLanguage propiedad.The following example creates a GetLanguage property. La propiedad se marca con un 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

En el ejemplo siguiente se obtiene el valor de la DesignOnlyAttribute.The next example gets the value of the DesignOnlyAttribute. En primer lugar, el código obtiene una PropertyDescriptorCollection con todas las propiedades del objeto.First the code gets a PropertyDescriptorCollection with all the properties for the object. A continuación indiza en la PropertyDescriptorCollection para encontrar el GetLanguage propiedad.Next it indexes into the PropertyDescriptorCollection to find the GetLanguage property. A continuación, devuelve los atributos de esta propiedad y los guarda en la variable de atributos.Then it returns the attributes for this property and saves them in the attributes variable.

El ejemplo se imprime, a continuación, si la propiedad es el diseño mediante la recuperación DesignOnlyAttribute desde el AttributeCollectiony escribirlo en la pantalla de la consola.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()))

Remarks

Los miembros marcados con el DesignOnlyAttribute establecido en true puede establecerse solo en tiempo de diseño.Members marked with the DesignOnlyAttribute set to true can be set only at design time. Normalmente, estas propiedades solo existen en tiempo de diseño y no se corresponden con una propiedad real del objeto en tiempo de ejecución.Typically, these properties exist only at design time and do not correspond to a real property on the object at run time.

Los miembros que no tienen ningún atributo o se marcan con el DesignOnlyAttribute establecido en false se pueden establecer durante el tiempo de ejecución.Members that either have no attribute or are marked with the DesignOnlyAttribute set to false can be set during run time. El valor predeterminado es false.The default is false.

Una propiedad con el DesignOnlyAttribute establecido en true tiene su valor serializado en el archivo .resx en lugar de la InitializeComponent método.A property with the DesignOnlyAttribute set to true has its value serialized to the .resx file instead of the InitializeComponent method.

Para obtener más información, consulte Attributes (Atributos).For more information, see Attributes.

Constructors

DesignOnlyAttribute(Boolean) DesignOnlyAttribute(Boolean) DesignOnlyAttribute(Boolean) DesignOnlyAttribute(Boolean)

Inicializa una nueva instancia de la clase DesignOnlyAttribute. Initializes a new instance of the DesignOnlyAttribute class.

Fields

Default Default Default Default

Especifica el valor predeterminado de DesignOnlyAttribute, que es No. Specifies the default value for the DesignOnlyAttribute, which is No. Este campo static es de solo lectura. This static field is read-only.

No No No No

Especifica que una propiedad puede establecerse en tiempo de diseño o en tiempo de ejecución. Specifies that a property can be set at design time or at run time. Este campo static es de solo lectura. This static field is read-only.

Yes Yes Yes Yes

Especifica que una propiedad sólo se puede establecer en tiempo de diseño. Specifies that a property can be set only at design time. Este campo static es de solo lectura. This static field is read-only.

Properties

IsDesignOnly IsDesignOnly IsDesignOnly IsDesignOnly

Obtiene un valor que indica si una propiedad sólo se puede establecer en tiempo de diseño. Gets a value indicating whether a property can be set only at design time.

TypeId TypeId TypeId TypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute. When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Methods

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Devuelve un valor que indica si el valor del objeto especificado es igual al atributo DesignOnlyAttribute actual. Returns whether the value of the given object is equal to the current DesignOnlyAttribute.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Devuelve el código hash de esta instancia. Returns the hash code for this instance.

GetType() GetType() GetType() GetType()

Obtiene el Type de la instancia actual. Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

Determina si este atributo es el valor predeterminado. Determines if this attribute is the default.

Match(Object) Match(Object) Match(Object) Match(Object)

Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado. When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crea una copia superficial del Object actual. Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Devuelve una cadena que representa el objeto actual. Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

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

Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío. Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz. Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1). Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Proporciona acceso a las propiedades y los métodos expuestos por un objeto. Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Applies to

See Also