WebDescriptionAttribute Classe

Definizione

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

Ereditarietà

Object

Attribute

WebDescriptionAttribute

Attributi

AttributeUsageAttribute

Esempio

Nell'esempio di codice seguente viene illustrato come usare l'attributo WebDescriptionAttribute per assegnare una descrizione comando a una proprietà in un controllo Web part. Alla proprietà personalizzata UserJobType viene assegnata la descrizione comando "Selezionare la categoria corrispondente al processo" da visualizzare nel PropertyGridEditorPart controllo. Questo esempio fa parte di un esempio più ampio disponibile nella panoramica della PropertyGridEditorPart classe.

[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

Commenti

Il PropertyGridEditorPart controllo fornisce un'interfaccia utente generica che consente agli utenti di modificare le proprietà personalizzate nei WebPart controlli server e posizionati nelle WebPartZoneBase zone. L'interfaccia utente di modifica viene fornita per le proprietà contrassegnate nel codice sorgente con l'attributo WebBrowsable (dalla WebBrowsableAttribute classe ). Quando una proprietà è contrassegnata con questo attributo, un PropertyGridEditorPart controllo crea l'interfaccia utente di modifica in base al tipo della proprietà e usa un PropertyDescriptor oggetto, se necessario, per convertire il valore in ogni controllo di modifica nel tipo della proprietà.

L'attributo WebDescription (dalla WebDescriptionAttribute classe ) consente di specificare la descrizione comando visualizzata con ogni controllo nell'interfaccia utente di modifica quando il puntatore del mouse viene posizionato sul controllo.