WebDescriptionAttribute Třída

Definice

Obor názvů:

System.Web.UI.WebControls.WebParts

Sestavení:

System.Web.dll

Definuje řetězcovou hodnotu, která se má použít jako popis vlastnosti ovládacího prvku Webové části.

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

Dědičnost

Object

Attribute

WebDescriptionAttribute

Atributy

AttributeUsageAttribute

Příklady

Následující příklad kódu ukazuje, jak pomocí atributu WebDescriptionAttribute přiřadit popis vlastnosti na Webové části ovládací prvek. Vlastní UserJobType vlastnost má popis "Vybrat kategorii, která odpovídá vaší úloze". zobrazí se v ovládacím PropertyGridEditorPart prvku. Tento příklad je součástí většího příkladu, který se nachází v přehledu PropertyGridEditorPart třídy.

[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

Poznámky

Ovládací PropertyGridEditorPart prvek poskytuje obecné uživatelské rozhraní (UI), které uživatelům umožňuje upravovat vlastní vlastnosti a WebPart ovládací prvky serveru umístěné v WebPartZoneBase zónách. Uživatelské rozhraní pro úpravy je poskytováno pro vlastnosti, které jsou označené ve zdrojovém kódu atributem WebBrowsable (ze WebBrowsableAttribute třídy). Pokud je vlastnost označena tímto atributem, PropertyGridEditorPart ovládací prvek vytvoří uživatelské rozhraní pro úpravy na základě typu vlastnosti a v případě potřeby použije PropertyDescriptor objekt k převodu hodnoty v každém ovládacím prvku pro úpravy na typ vlastnosti.

Atribut WebDescription (z WebDescriptionAttribute třídy) umožňuje zadat popis, který se zobrazí s jednotlivými ovládacími prvky v uživatelském rozhraní pro úpravy, když je ukazatel myši umístěn nad ovládacím prvku.

Konstruktory

WebDescriptionAttribute()	Inicializuje novou instanci WebDescriptionAttribute třídy.
WebDescriptionAttribute(String)	Inicializuje novou instanci WebDescriptionAttribute třídy se zadaným popisem.

Pole

Default

Představuje instanci WebDescriptionAttribute třídy s Description vlastností nastavenou na prázdný řetězec ("").

Vlastnosti

Description	Získá popis vlastnosti k zobrazení v ovládacím PropertyGridEditorPart prvku.
DescriptionValue	Získá nebo nastaví popis pro zobrazení v ovládacím PropertyGridEditorPart prvku.
TypeId	Při implementaci v odvozené třídě získá jedinečný identifikátor pro tento Attribute. (Zděděno od Attribute)

Metody

Equals(Object)	Vrací hodnotu, která určuje, zda je tato instance rovna zadanému objektu.
GetHashCode()	Vrátí kód hash pro hodnotu zobrazovaného názvu.
GetType()	Type Získá aktuální instanci. (Zděděno od Object)
IsDefaultAttribute()	Určuje, jestli je aktuální instance nastavená na výchozí hodnotu.
Match(Object)	Při přepsání v odvozené třídě vrátí hodnotu, která označuje, zda se tato instance rovná zadanému objektu. (Zděděno od Attribute)
MemberwiseClone()	Vytvoří použádnou kopii aktuálního souboru Object. (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Explicitní implementace rozhraní

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Mapuje sadu názvů na odpovídající sadu identifikátorů pro rozesílání. (Zděděno od Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Načte informace o typu objektu, který lze použít k získání informací o typu rozhraní. (Zděděno od Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Získá počet rozhraní typu informací, které objekt poskytuje (0 nebo 1). (Zděděno od Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Poskytuje přístup k vlastnostem a metodám vystaveným objektem. (Zděděno od Attribute)