DesignOnlyAttribute Classe

Definição

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

Herança

Object

Attribute

DesignOnlyAttribute

Atributos

AttributeUsageAttribute

Exemplos

O exemplo seguinte cria uma GetLanguage propriedade. A propriedade está marcada com um 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

O próximo exemplo obtém o valor do DesignOnlyAttribute. Primeiro, o código recebe uma PropertyDescriptorCollection com todas as propriedades do objeto. De seguida, indexa para encontrar PropertyDescriptorCollection a GetLanguage propriedade. Depois, devolve os atributos dessa propriedade e guarda-os na variável de atributos.

O exemplo então imprime se a propriedade é designada apenas ao recuperá-la DesignOnlyAttribute do AttributeCollection, e escrevê-la no ecrã da consola.

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

Observações

Os membros marcados com o DesignOnlyAttribute conjunto true só podem ser definidos no momento do design. Normalmente, estas propriedades existem apenas em tempo de projeto e não correspondem a uma propriedade real no objeto em tempo de execução.

Membros que não têm atributo ou são marcados com o DesignOnlyAttribute conjunto para false podem ser definidos durante a execução. A predefinição é false.

Uma propriedade com o definido DesignOnlyAttribute para true tem o seu valor serializado para o ficheiro .resx em vez do InitializeComponent método.

Para obter mais informações, consulte Atributos.

Ver também

• Attribute
• PropertyDescriptor