WebDescriptionAttribute Clase

Definición

Define el valor de cadena que se va a utilizar como información sobre herramientas de una propiedad de un control de elementos Web.Defines the string value to use as a ToolTip for a property of a Web Parts control.

public ref class WebDescriptionAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Property)]
public class WebDescriptionAttribute : Attribute
type WebDescriptionAttribute = class
    inherit Attribute
Public Class WebDescriptionAttribute
Inherits Attribute
Herencia
WebDescriptionAttribute
Atributos

Ejemplos

En el ejemplo de código siguiente se muestra cómo WebDescriptionAttribute utilizar el atributo para asignar una información sobre herramientas a una propiedad en un control de elementos Web.The following code example demonstrates how to use the WebDescriptionAttribute attribute to assign a ToolTip to a property on a Web Parts control. A la UserJobType propiedad personalizada se le proporciona la información sobre herramientas "seleccione la categoría que corresponde a su trabajo".The custom UserJobType property is given the ToolTip "Select the category that corresponds to your job." que se va a PropertyGridEditorPart Mostrar en el control.to display in the PropertyGridEditorPart control. Este ejemplo forma parte de un ejemplo más grande que se PropertyGridEditorPart encuentra en la información general de la clase.This example is part of a larger example found in the PropertyGridEditorPart class overview.

[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 (UI) genérica que permite a los usuarios editar las WebPart propiedades personalizadas en los controles WebPartZoneBase de servidor y colocados en zonas.The PropertyGridEditorPart control provides a generic user interface (UI) that enables users to edit custom properties on WebPart and server controls placed in WebPartZoneBase zones. La interfaz de usuario de edición se proporciona para las propiedades que están marcadas en WebBrowsable el código fuente con WebBrowsableAttribute el atributo (de la clase).The editing UI is provided for properties that are marked in the source code with the WebBrowsable attribute (from the WebBrowsableAttribute class). Cuando una propiedad se marca con este atributo, un PropertyGridEditorPart control crea la interfaz de usuario de edición basándose en el tipo de la propiedad PropertyDescriptor y utiliza un objeto si es necesario para convertir el valor de cada control de edición al tipo de la propiedad.When a property is marked with this attribute, a PropertyGridEditorPart control creates the editing UI based on the type of the property, and uses a PropertyDescriptor object if needed to convert the value in each editing control to the type of the property.

El WebDescription atributo (de la WebDescriptionAttribute clase) permite especificar la información sobre herramientas que aparece con cada control de la interfaz de usuario de edición cuando se coloca el puntero del mouse sobre el control.The WebDescription attribute (from the WebDescriptionAttribute class) allows you to specify the ToolTip that appears with each control in the editing UI when the mouse pointer is positioned over the control.

Constructores

WebDescriptionAttribute()

Inicializa una nueva instancia de la clase WebDescriptionAttribute.Initializes a new instance of the WebDescriptionAttribute class.

WebDescriptionAttribute(String)

Inicializa una nueva instancia de la clase WebDescriptionAttribute con la descripción especificada.Initializes a new instance of the WebDescriptionAttribute class with the specified description.

Campos

Default

Representa una instancia de la clase WebDescriptionAttribute con la propiedad Description establecida en una cadena vacía ("").Represents an instance of the WebDescriptionAttribute class with the Description property set to an empty string ("").

Propiedades

Description

Obtiene la información sobre herramientas de una propiedad que se va a mostrar en un control PropertyGridEditorPart.Gets the ToolTip for a property to display in a PropertyGridEditorPart control.

DescriptionValue

Obtiene o establece la información sobre herramientas que va a aparecer en el control PropertyGridEditorPart.Gets or sets the ToolTip to display in the PropertyGridEditorPart control.

TypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Heredado de Attribute)

Métodos

Equals(Object)

Devuelve un valor que indica si esta instancia es igual que un objeto especificado.Returns a value that indicates whether this instance is equal to a specified object.

GetHashCode()

Devuelve el código hash del valor del nombre para mostrar.Returns the hash code for the display name value.

GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Heredado de Object)
IsDefaultAttribute()

Determina si la instancia actual se establece en el valor predeterminado.Determines whether the current instance is set to the default value.

Match(Object)

Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Heredado de Attribute)
MemberwiseClone()

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

(Heredado de Object)
ToString()

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(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.Maps a set of names to a corresponding set of dispatch identifiers.

(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.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Heredado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1).Retrieves the number of type information interfaces that an object provides (either 0 or 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.Provides access to properties and methods exposed by an object.

(Heredado de Attribute)

Se aplica a