WebDescriptionAttribute Classe

Referência

Definição

Namespace:: System.Web.UI.WebControls.WebParts

Assembly:: System.Web.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Define o valor de cadeia de caracteres a ser usado como uma dica de ferramenta para uma propriedade de um controle de Web Parts.

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

Herança: Object

Attribute
WebDescriptionAttribute

Atributos: AttributeUsageAttribute

Exemplos

O exemplo de código a seguir demonstra como usar o WebDescriptionAttribute atributo para atribuir uma Dica de Ferramenta a uma propriedade em um controle Web Parts. A propriedade personalizada UserJobType recebe a Dica de Ferramenta "Selecione a categoria que corresponde ao seu trabalho". para exibir no PropertyGridEditorPart controle. Este exemplo faz parte de um exemplo maior encontrado na visão geral da 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

Comentários

O PropertyGridEditorPart controle fornece uma interface do usuário genérica que permite aos usuários editar propriedades WebPart personalizadas e controles de servidor colocados em WebPartZoneBase zonas. A interface do usuário de edição é fornecida para propriedades marcadas no código-fonte com o WebBrowsable atributo (da WebBrowsableAttribute classe). Quando uma propriedade é marcada com esse atributo, um PropertyGridEditorPart controle cria a interface do usuário de edição com base no tipo da propriedade e usa um PropertyDescriptor objeto, se necessário, para converter o valor em cada controle de edição para o tipo da propriedade.

O WebDescription atributo (da WebDescriptionAttribute classe) permite que você especifique a Dica de Ferramenta que aparece com cada controle na interface do usuário de edição quando o ponteiro do mouse é posicionado sobre o controle.

Construtores

WebDescriptionAttribute()	Inicializa uma nova instância da classe WebDescriptionAttribute.
WebDescriptionAttribute(String)	Inicializa uma nova instância da classe WebDescriptionAttribute com a descrição especificada.

Campos

Default

Representa uma instância da classe WebDescriptionAttribute com a propriedade Description definida como uma cadeia de caracteres vazia ("").

Propriedades

Description	Obtém a dica de ferramenta de uma propriedade a ser exibida em um controle PropertyGridEditorPart.
DescriptionValue	Obtém ou define a dica de ferramenta a ser exibida no controle PropertyGridEditorPart.
TypeId	Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute. (Herdado de Attribute)

Métodos

Equals(Object)	Retorna um valor que indica se essa instância é igual a um objeto especificado.
GetHashCode()	Retorna o código hash do valor de nome de exibição.
GetType()	Obtém o Type da instância atual. (Herdado de Object)
IsDefaultAttribute()	Determina se a instância atual está definida para o valor padrão.
Match(Object)	Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)

Implantações explícitas de interface

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Mapeia um conjunto de nomes para um conjunto correspondente de identificadores de expedição. (Herdado de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Recupera as informações de tipo para um objeto, que pode ser usado para obter as informações de tipo para uma interface. (Herdado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Retorna o número de interfaces de informações do tipo que um objeto fornece (0 ou 1). (Herdado de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Fornece acesso a propriedades e métodos expostos por um objeto. (Herdado de Attribute)

Aplica-se a

Compartilhar via