Partager via


Définition d'une propriété

Si vous n'êtes pas familiarisé avec les propriétés, consultez Vue d'ensemble des propriétés.

Le fragment de code suivant définit une propriété appelée Message sur le contrôle PropertySample.

public class PropertySample : Control {
   private string  message;
   [Category("Text")]
   [Description("The message to display")]
   public string Message {
       get {
          return message;
       }
       set {
          message = value;
       }
   }
   ...
}
[Visual Basic]
Option Explicit
Option Strict

Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.ComponentModel

Public Class PropertySample
   Inherits Control
   Private _message As String
   
   <Category("Text"), Description("The message to display")> _
   Public Property Message() As String
      Get
         Return _message
      End Get
      Set
         _message = value
      End Set
   End Property
   ...
End Class

Lorsque vous définissez une propriété, il est important de spécifier les métadonnées de la propriété à l'aide d'un ou plusieurs attributs, de la manière illustrée dans le fragment de code précédent. L'élément Description("The message to display") est un attribut. Pour qu'un concepteur visuel affiche votre contrôle correctement, vous devez lui fournir des métadonnées à l'aide d'attributs de propriété, d'événement et de classe. Si vous n'êtes pas familiarisé avec les attributs, consultez Attributs en mode design pour les composants.

**Remarque   **Le terme attribut tel qu'il est utilisé dans cette section désigne des attributs de métadonnées qui ciblent le Common Language Runtime ou des outils, par exemple des hôtes de design. Ne les confondez pas avec les attributs XML ou HTML utilisés dans la syntaxe de page ASP.NET.

Une propriété peut être un type primitif, un type classe ou une collection de types primitifs ou de types classe. Les différents types de propriétés sont décrits à la section Types de propriétés.

Remarque   La propriété définie dans l'exemple n'est pas rendue persistante pendant les allers-retours au client. Pour définir les propriétés persistantes, vous devez utiliser la propriété ViewState afin qu'elle contienne les données de propriété, comme décrit à la section Gestion de l'état dans un contrôle.

Voir aussi

Types de propriétés | Exemple de propriété personnalisée