Definieren einer Eigenschaft

Wenn Sie mit Eigenschaften noch nicht vertraut sind, finden Sie unter Übersicht über Eigenschaften einführende Informationen.

Im folgenden Codefragment wird für das Steuerelement PropertySample eine Eigenschaft namens Message definiert.

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

In diesem Codefragment wird außerdem gezeigt, wie bei der Definition von Eigenschaften auch dazugehörige Metadaten definiert werden, indem ein oder mehr Attribute verwendet werden. Das Element Description("The message to display") ist ein Attribut. Um das Steuerelement in einem visuellen Designer korrekt anzuzeigen, müssen dem Designer mit Hilfe von Eigenschaften, Ereignissen und Klassenattributen entsprechende Metadaten bereitgestellt werden. Wenn Sie mit Attributen noch nicht vertraut sind, finden Sie unter Entwurfszeitattribute für Komponenten entsprechende Informationen.

**Hinweis   **In diesem Abschnitt werden unter Attributen Metadatenattribute verstanden, die sich auf die Common Language Runtime oder auf Tools wie Entwurfszeithosts beziehen. Diese sind nicht mit XML- oder HTML-Attributen zu verwechseln, die in der Syntax von ASP.NET-Seiten verwendet werden.

Bei einer Eigenschaft kann es sich um einen primitiven Typ, einen Klassentyp oder eine Auflistung von primitiven Typen bzw. Klassentypen handeln. Weitere Informationen zu den unterschiedlichen Eigenschaftstypen finden Sie unter Eigenschaftentypen.

Hinweis   Die im Beispiel definierte Eigenschaft bleibt im Fall von Schleifen für den Client nicht erhalten. Für die Definition von dauerhaften Eigenschaften ist die ViewState-Eigenschaft zu verwenden, mit deren Hilfe die Eigenschaftsdaten festgehalten werden können. Weitere Informationen dazu finden Sie unter Beibehalten des Status in einem Steuerelement.

Siehe auch

Eigenschaftentypen | Beispiel für eine benutzerdefinierte Eigenschaft