WebDescriptionAttribute Classe

Definição

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 seguinte demonstra como usar o WebDescriptionAttribute atributo para atribuir uma ToolTip a uma propriedade num controlo Web Parts. A propriedade personalizada UserJobType recebe a dica de ferramenta "Selecione a categoria que corresponde ao seu trabalho." para ser exibida no PropertyGridEditorPart controlo. Este exemplo faz parte de um exemplo maior encontrado na PropertyGridEditorPart visão geral da 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

Observações

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

O WebDescription atributo (da WebDescriptionAttribute classe) permite-te especificar a ToolTip que aparece com cada controlo na interface de edição quando o ponteiro do rato está posicionado sobre o controlo.