WebDescriptionAttribute Klasse

Definition

Definiert den Zeichenfolgenwert, der für eine Eigenschaft eines Webparts-Steuerelements als QuickInfo verwendet werden soll.Defines the string value to use as a ToolTip for a property of a Web Parts control.

public ref class WebDescriptionAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Property)]
public class WebDescriptionAttribute : Attribute
type WebDescriptionAttribute = class
    inherit Attribute
Public Class WebDescriptionAttribute
Inherits Attribute
Vererbung
WebDescriptionAttribute
Attribute

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie das WebDescriptionAttribute -Attribut verwendet wird, um einer Eigenschaft in einem Webparts Steuerelement eine QuickInfo zuzuweisen.The following code example demonstrates how to use the WebDescriptionAttribute attribute to assign a ToolTip to a property on a Web Parts control. Die Benutzer UserJobType definierte Eigenschaft erhält die QuickInfo "wählen Sie die Kategorie aus, die Ihrem Auftrag entspricht."The custom UserJobType property is given the ToolTip "Select the category that corresponds to your job." , um im PropertyGridEditorPart -Steuerelement angezeigt zu werden.to display in the PropertyGridEditorPart control. Dieses Beispiel ist Teil eines größeren Beispiels in der Übersicht über PropertyGridEditorPart die-Klasse.This example is part of a larger example found in the PropertyGridEditorPart class overview.

[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 stellt eine generische Benutzeroberfläche bereit, die es Benutzern ermöglicht, benutzerdefinierte WebPart Eigenschaften für-und- WebPartZoneBase Server Steuerelemente in Zonen zu bearbeiten.The PropertyGridEditorPart control provides a generic user interface (UI) that enables users to edit custom properties on WebPart and server controls placed in WebPartZoneBase zones. Die Bearbeitungs Benutzeroberfläche wird für Eigenschaften bereitgestellt, die im Quellcode mit dem WebBrowsable -Attribut (aus der WebBrowsableAttribute -Klasse) gekennzeichnet sind.The editing UI is provided for properties that are marked in the source code with the WebBrowsable attribute (from the WebBrowsableAttribute class). Wenn eine Eigenschaft mit diesem Attribut markiert ist, erstellt PropertyGridEditorPart ein Steuerelement die Bearbeitungs Benutzeroberfläche basierend auf dem Typ der Eigenschaft und verwendet ein PropertyDescriptor -Objekt, wenn es erforderlich ist, um den Wert in jedem Bearbeitungs Steuerelement in den Typ der Eigenschaft zu konvertieren.When a property is marked with this attribute, a PropertyGridEditorPart control creates the editing UI based on the type of the property, and uses a PropertyDescriptor object if needed to convert the value in each editing control to the type of the property.

Mit WebDescription dem-Attribut ( WebDescriptionAttribute aus der-Klasse) können Sie die QuickInfo angeben, die mit jedem Steuerelement in der Bearbeitungs Benutzeroberfläche angezeigt wird, wenn sich der Mauszeiger über dem Steuerelement befindet.The WebDescription attribute (from the WebDescriptionAttribute class) allows you to specify the ToolTip that appears with each control in the editing UI when the mouse pointer is positioned over the control.

Konstruktoren

WebDescriptionAttribute()

Initialisiert eine neue Instanz der WebDescriptionAttribute-Klasse.Initializes a new instance of the WebDescriptionAttribute class.

WebDescriptionAttribute(String)

Initialisiert eine neue Instanz der WebDescriptionAttribute-Klasse mit der angegebenen Beschreibung.Initializes a new instance of the WebDescriptionAttribute class with the specified description.

Felder

Default

Stellt eine Instanz der WebDescriptionAttribute-Klasse dar, für die die Description-Eigenschaft auf eine leere Zeichenfolge ("") festgelegt ist.Represents an instance of the WebDescriptionAttribute class with the Description property set to an empty string ("").

Eigenschaften

Description

Ruft die QuickInfo für eine Eigenschaft ab, die in einem PropertyGridEditorPart-Steuerelement anzeigt werden soll.Gets the ToolTip for a property to display in a PropertyGridEditorPart control.

DescriptionValue

Ruft die im PropertyGridEditorPart-Steuerelement anzuzeigende Quickinfo ab oder legt diese fest.Gets or sets the ToolTip to display in the PropertyGridEditorPart control.

TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Geerbt von Attribute)

Methoden

Equals(Object)

Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist.Returns a value that indicates whether this instance is equal to a specified object.

GetHashCode()

Gibt den Hashcode für den Wert des Anzeigenamens zurück.Returns the hash code for the display name value.

GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
IsDefaultAttribute()

Bestimmt, ob die aktuelle Instanz auf den Standardwert festgelegt ist.Determines whether the current instance is set to the default value.

Match(Object)

Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Geerbt von Attribute)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)

Explizite Schnittstellenimplementierungen

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

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(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.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).Retrieves the number of type information interfaces that an object provides (either 0 or 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.Provides access to properties and methods exposed by an object.

(Geerbt von Attribute)

Gilt für: