WebDescriptionAttribute Klasa

Definicja

Przestrzeń nazw:

System.Web.UI.WebControls.WebParts

Zestaw:

System.Web.dll

Definiuje wartość ciągu do użycia jako etykietkę narzędzia dla właściwości kontrolki składniki Web Part.

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

Dziedziczenie

Object

Attribute

WebDescriptionAttribute

Atrybuty

AttributeUsageAttribute

Przykłady

W poniższym przykładzie kodu pokazano, jak za pomocą atrybutu WebDescriptionAttribute przypisać etykietkę narzędzia do właściwości w kontrolce składniki Web Part. Właściwość niestandardowa UserJobType ma etykietkę narzędzia "Wybierz kategorię odpowiadającą zadaniu". aby wyświetlić w kontrolce PropertyGridEditorPart . Ten przykład jest częścią większego przykładu znalezionego w przeglądzie PropertyGridEditorPart klasy.

[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

Uwagi

Kontrolka PropertyGridEditorPart udostępnia ogólny interfejs użytkownika, który umożliwia użytkownikom edytowanie właściwości niestandardowych w WebPart systemach i kontrolek serwera umieszczonych w WebPartZoneBase strefach. Interfejs użytkownika edycji jest udostępniany dla właściwości oznaczonych w kodzie źródłowym z atrybutem WebBrowsable (z WebBrowsableAttribute klasy). Gdy właściwość jest oznaczona tym atrybutem, PropertyGridEditorPart kontrolka tworzy interfejs użytkownika edycji na podstawie typu właściwości i używa PropertyDescriptor obiektu, jeśli jest to konieczne, aby przekonwertować wartość w każdej kontrolce edycji na typ właściwości.

Atrybut WebDescription (z WebDescriptionAttribute klasy) umożliwia określenie etykietki narzędzia wyświetlanej z każdą kontrolką w interfejsie użytkownika edycji, gdy wskaźnik myszy jest umieszczony nad kontrolką.

Konstruktory

WebDescriptionAttribute()	Inicjuje nowe wystąpienie klasy WebDescriptionAttribute.
WebDescriptionAttribute(String)	Inicjuje WebDescriptionAttribute nowe wystąpienie klasy z określonym opisem.

Pola

Default

Reprezentuje wystąpienie WebDescriptionAttribute klasy z właściwością Description ustawioną na pusty ciąg ("").

Właściwości

Description	Pobiera etykietkę narzędzia dla właściwości do wyświetlenia w kontrolce PropertyGridEditorPart .
DescriptionValue	Pobiera lub ustawia etykietkę narzędzia do wyświetlenia w kontrolce PropertyGridEditorPart .
TypeId	Po zaimplementowaniu w klasie pochodnej pobiera unikatowy identyfikator dla tego Attributeelementu . (Odziedziczone po Attribute)

Metody

Equals(Object)	Zwraca wartość wskazującą, czy to wystąpienie jest równe podanemu obiektowi.
GetHashCode()	Zwraca kod skrótu dla wartości nazwy wyświetlanej.
GetType()	Type Pobiera wartość bieżącego wystąpienia. (Odziedziczone po Object)
IsDefaultAttribute()	Określa, czy bieżące wystąpienie jest ustawione na wartość domyślną.
Match(Object)	Po przesłonięciu w klasie pochodnej zwraca wartość wskazującą, czy to wystąpienie jest równe określonemu obiektowi. (Odziedziczone po Attribute)
MemberwiseClone()	Tworzy płytkią kopię bieżącego Objectelementu . (Odziedziczone po Object)
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)

Jawne implementacje interfejsu

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Zestaw nazw jest mapowany na odpowiedni zestaw identyfikatorów wysyłania. (Odziedziczone po Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Pobiera informacje o typie dla obiektu, który może służyć do pobierania informacji o typie dla interfejsu. (Odziedziczone po Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Pobiera informację o liczbie typów interfejsów, jakie zawiera obiekt (0 lub 1). (Odziedziczone po Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Umożliwia dostęp do właściwości i metod udostępnianych przez obiekt. (Odziedziczone po Attribute)