WebDescriptionAttribute Classe

Définition

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

Héritage

Object

Attribute

WebDescriptionAttribute

Attributs

AttributeUsageAttribute

Exemples

L’exemple de code suivant montre comment utiliser l’attribut WebDescriptionAttribute pour affecter une info-bulle à une propriété sur un contrôle WebPart. La propriété personnalisée UserJobType reçoit l’info-bulle « Sélectionner la catégorie qui correspond à votre travail » pour l’afficher dans le PropertyGridEditorPart contrôle. Cet exemple fait partie d’un exemple plus large trouvé dans la vue d’ensemble de la 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

Remarques

Le PropertyGridEditorPart contrôle fournit une interface utilisateur générique qui permet aux utilisateurs de modifier des propriétés personnalisées sur et des WebPart contrôles serveur placés dans WebPartZoneBase des zones. L’interface utilisateur d’édition est fournie pour les propriétés marquées dans le code source avec l’attribut WebBrowsable (à partir de la WebBrowsableAttribute classe). Lorsqu’une propriété est marquée avec cet attribut, un PropertyGridEditorPart contrôle crée l’interface utilisateur d’édition en fonction du type de la propriété et utilise un PropertyDescriptor objet si nécessaire pour convertir la valeur dans chaque contrôle d’édition en type de propriété.

L’attribut WebDescription (de la WebDescriptionAttribute classe) vous permet de spécifier l’info-bulle qui apparaît avec chaque contrôle dans l’interface utilisateur d’édition lorsque le pointeur de la souris est positionné sur le contrôle.