WebDisplayNameAttribute Classe

Définition

Espace de noms:

System.Web.UI.WebControls.WebParts

Assembly:

System.Web.dll

Définit le nom convivial d'une propriété d'un contrôle WebPart.

public ref class WebDisplayNameAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Property)]
public class WebDisplayNameAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Property)>]
type WebDisplayNameAttribute = class
    inherit Attribute

Public Class WebDisplayNameAttribute
Inherits Attribute

Héritage

Object

Attribute

WebDisplayNameAttribute

Attributs

AttributeUsageAttribute

Exemples

L’exemple de code suivant montre comment utiliser l’attribut WebDisplayNameAttribute pour affecter un nom complet à une propriété sur un contrôle composants WebPart. La propriété personnalisée UserJobType a un nom convivial « Type de travail » à afficher dans le PropertyGridEditorPart contrôle. Cet exemple fait partie d’un exemple plus grand 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 WebPart et des 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 WebDisplayName (de la WebDisplayNameAttribute classe) vous permet de spécifier le texte de l’étiquette qui apparaît avec chaque contrôle dans l’interface utilisateur d’édition.

Constructeurs

WebDisplayNameAttribute()	Initialise une nouvelle instance de la classe WebDisplayNameAttribute sans utiliser un nom spécifié.
WebDisplayNameAttribute(String)	Initialise une nouvelle instance de la classe WebDisplayNameAttribute à l'aide d'un nom complet spécifié.

Champs

Default

Représente une instance de la classe WebDisplayNameAttribute avec le jeu de propriétés DisplayName ayant pour valeur une chaîne vide ("").

Propriétés

DisplayName	Obtient le nom d'une propriété à afficher dans un contrôle PropertyGridEditorPart.
DisplayNameValue	Obtient ou définit le nom à afficher dans le contrôle PropertyGridEditorPart.
TypeId	Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute. (Hérité de Attribute)

Méthodes

Equals(Object)	Retourne une valeur qui indique si cette instance est égale à un objet spécifié.
GetHashCode()	Retourne le code de hachage pour la valeur nom complet.
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
IsDefaultAttribute()	Détermine si l'instance actuelle a la valeur par défaut.
Match(Object)	En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié. (Hérité de Attribute)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

Implémentations d’interfaces explicites

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Mappe un jeu de noms avec un jeu correspondant d'identificateurs de dispatch. (Hérité de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Récupère les informations de type pour un objet, qui peuvent être utilisées pour obtenir les informations de type d'une interface. (Hérité de Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Récupère le nombre d'interfaces d'informations de type fourni par un objet (0 ou 1). (Hérité de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Fournit l'accès aux propriétés et aux méthodes exposées par un objet. (Hérité de Attribute)