WebDescriptionAttribute Klasse

Referenz

Definition

Namespace:: System.Web.UI.WebControls.WebParts

Assembly:: System.Web.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Definiert den Zeichenfolgenwert, der für eine Eigenschaft eines Webparts-Steuerelements als QuickInfo verwendet werden soll.

public ref class WebDescriptionAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Property)]
public class WebDescriptionAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Property)>]
type WebDescriptionAttribute = class
    inherit Attribute

Public Class WebDescriptionAttribute
Inherits Attribute

Vererbung: Object

Attribute
WebDescriptionAttribute

Attribute: AttributeUsageAttribute

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie sie das WebDescriptionAttribute Attribut zum Zuweisen einer QuickInfo zu einer Eigenschaft in einem Webparts-Steuerelement verwenden. Die benutzerdefinierte UserJobType Eigenschaft erhält die QuickInfo "Wählen Sie die Kategorie aus, die Ihrem Auftrag entspricht." so wird das PropertyGridEditorPart Steuerelement angezeigt. In diesem Beispiel handelt es sich um ein größeres Beispiel, das in der PropertyGridEditorPart Klassenübersicht gefunden wurde.

[Personalizable(), WebBrowsable(), WebDisplayName("Job Type"), 
  WebDescription("Select the category that corresponds to your job.")]
public JobTypeName UserJobType
{
  get
  {
    object o = ViewState["UserJobType"];
    if (o != null)
      return (JobTypeName)o;
    else
      return _userJobType;
  }

  set { _userJobType = (JobTypeName)value; }
}

<Personalizable(), WebBrowsable(), WebDisplayName("Job Type"), _
  WebDescription("Select the category that corresponds to your job.")> _
Public Property UserJobType() As JobTypeName
  Get
    Dim o As Object = ViewState("UserJobType")
    If Not (o Is Nothing) Then
      Return CType(o, JobTypeName)
    Else
      Return _userJobType
    End If
  End Get
  Set(ByVal value As JobTypeName)
    _userJobType = CType(value, JobTypeName)
  End Set
End Property

Hinweise

Das PropertyGridEditorPart Steuerelement bietet eine generische Benutzeroberfläche (UI), mit der Benutzer benutzerdefinierte Eigenschaften auf WebPart und Serversteuerelemente bearbeiten können, die in WebPartZoneBase Zonen platziert sind. Die Bearbeitungsbenutzeroberfläche wird für Eigenschaften bereitgestellt, die im Quellcode mit dem Attribut (aus der WebBrowsable WebBrowsableAttribute Klasse) gekennzeichnet sind. Wenn eine Eigenschaft mit diesem Attribut markiert wird, erstellt ein PropertyGridEditorPart Steuerelement die Bearbeitungsoberfläche basierend auf dem Typ der Eigenschaft und verwendet ein PropertyDescriptor Objekt, wenn erforderlich, um den Wert in jedes Bearbeitungssteuerelement in den Typ der Eigenschaft zu konvertieren.

Mit WebDescription dem Attribut (aus der WebDescriptionAttribute Klasse) können Sie die QuickInfo angeben, die mit jedem Steuerelement in der Bearbeitungsoberfläche angezeigt wird, wenn der Mauszeiger über das Steuerelement positioniert wird.

Konstruktoren

WebDescriptionAttribute()	Initialisiert eine neue Instanz der WebDescriptionAttribute-Klasse.
WebDescriptionAttribute(String)	Initialisiert eine neue Instanz der WebDescriptionAttribute-Klasse mit der angegebenen Beschreibung.

Felder

Default

Stellt eine Instanz der WebDescriptionAttribute-Klasse dar, für die die Description-Eigenschaft auf eine leere Zeichenfolge ("") festgelegt ist.

Eigenschaften

Description	Ruft die QuickInfo für eine Eigenschaft ab, die in einem PropertyGridEditorPart-Steuerelement anzeigt werden soll.
DescriptionValue	Ruft die im PropertyGridEditorPart-Steuerelement anzuzeigende Quickinfo ab oder legt diese fest.
TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute)

Methoden

Equals(Object)	Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist.
GetHashCode()	Gibt den Hashcode für den Wert des Anzeigenamens zurück.
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Bestimmt, ob die aktuelle Instanz auf den Standardwert festgelegt ist.
Match(Object)	Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht. (Geerbt von Attribute)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Explizite Schnittstellenimplementierungen

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu. (Geerbt von Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können. (Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1). (Geerbt von Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit. (Geerbt von Attribute)

Gilt für

Freigeben über