WebDisplayNameAttribute Clase

Definición

Espacio de nombres:

System.Web.UI.WebControls.WebParts

Ensamblado:

System.Web.dll

Define el nombre descriptivo de una propiedad de un control de elementos Web.

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

Herencia

Object

Attribute

WebDisplayNameAttribute

Atributos

AttributeUsageAttribute

Ejemplos

En el ejemplo de código siguiente se muestra cómo usar el WebDisplayNameAttribute atributo para asignar un nombre para mostrar a una propiedad en un control elementos web. A la propiedad personalizada UserJobType se le asigna un nombre descriptivo "Tipo de trabajo" para mostrarlo en el PropertyGridEditorPart control. Este ejemplo forma parte de un ejemplo más grande que se encuentra en la información general de la PropertyGridEditorPart clase.

[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

Comentarios

El PropertyGridEditorPart control proporciona una interfaz de usuario genérica (UI) que permite a los usuarios editar propiedades personalizadas en WebPart y controles de servidor colocados en WebPartZoneBase zonas. La interfaz de usuario de edición se proporciona para las propiedades marcadas en el código fuente con el WebBrowsable atributo (de la WebBrowsableAttribute clase ). Cuando una propiedad está marcada con este atributo, un PropertyGridEditorPart control crea la interfaz de usuario de edición basada en el tipo de la propiedad y usa un PropertyDescriptor objeto si es necesario para convertir el valor en cada control de edición al tipo de la propiedad.

El WebDisplayName atributo (de la WebDisplayNameAttribute clase ) permite especificar el texto de la etiqueta que aparece con cada control de la interfaz de usuario de edición.

Constructores

WebDisplayNameAttribute()	Inicializa una nueva instancia de la clase WebDisplayNameAttribute para la que no se ha especificado ningún nombre.
WebDisplayNameAttribute(String)	Inicializa una nueva instancia de la clase WebDisplayNameAttribute con un nombre para mostrar especificado.

Campos

Default

Representa una instancia de la clase WebDisplayNameAttribute con la propiedad DisplayName establecida en una cadena vacía ("").

Propiedades

DisplayName	Obtiene el nombre de una propiedad que se va a mostrar en un control PropertyGridEditorPart.
DisplayNameValue	Obtiene o establece el nombre que va a aparecer en el control PropertyGridEditorPart.
TypeId	Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute. (Heredado de Attribute)

Métodos

Equals(Object)	Devuelve un valor que indica si esta instancia es igual que un objeto especificado.
GetHashCode()	Devuelve el código hash del valor del nombre para mostrar.
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
IsDefaultAttribute()	Determina si la instancia actual se establece en el valor predeterminado.
Match(Object)	Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado. (Heredado de Attribute)
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)

Implementaciones de interfaz explícitas

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío. (Heredado de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz. (Heredado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1). (Heredado de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Proporciona acceso a las propiedades y los métodos expuestos por un objeto. (Heredado de Attribute)