ControlBuilderAttribute Classe

Referência

Definição

Namespace:: System.Web.UI

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.

Especifica uma classe ControlBuilder para criar um controle personalizado no analisador de ASP.NET. Essa classe não pode ser herdada.

public ref class ControlBuilderAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Class)]
public sealed class ControlBuilderAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class)>]
type ControlBuilderAttribute = class
    inherit Attribute

Public NotInheritable Class ControlBuilderAttribute
Inherits Attribute

Herança: Object

Attribute
ControlBuilderAttribute

Atributos: AttributeUsageAttribute

Exemplos

O exemplo de código a SelectedIndex seguir cria uma lista de seleção personalizada que é usada para exibir uma mensagem com base nos valores definidos em tempo de execução.Message A linha de comando a seguir é usada para criar o executável.

vbc /r:System.dll /r:System.Web.dll /r:System.Drawing.dll /t:library /out:myWebAppPath/Bin/vb_MyControlBuilderAtt.dll ControlBuilderAtt.vb

csc /t:library /out:myWebAppPath/Bin/cs_MyControlBuilderAtt.dll ControlBuilderAtt.cs


/* File name: controlBuilderAttribute.cs. */

using System;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Collections;

namespace CustomControls

{
  public class MyCS_Item : Control 
  /* Class name: MyCS_Item. 
   * Defines the child control class.
   */
    {

      private String _message;

      public String Message 
      {
        get 
        {
          return _message;
        }
        set 
        {
           _message = value;
        }
     }
    }

    public class CustomParseControlBuilder : ControlBuilder 
    /* Class name: CustomParserControlBuilder.
     * Defines the functions and data to be used in building custom controls. 
     * This class is referenced using the ControlBuilderAttribute class. See class below.
     */
    {
      [System.Security.Permissions.PermissionSet(System.Security.Permissions.SecurityAction.Demand, Name="FullTrust")] 
      public override Type GetChildControlType(String tagName, IDictionary attributes) 
      {
        if (String.Compare(tagName, "customitem", true) == 0) 
        {
           return typeof(MyCS_Item);
        }
        return null;
      }
    }

    [ 
       ControlBuilderAttribute(typeof(CustomParseControlBuilder)) 
    ]
    public class MyCS_CustomParse : Control 
    /* Class name: MyCS_CustomParse.
     * Performs custom parsing of a MyCS_CustomParse control type 
     * child control. 
     * If the child control is of the allowed type, it is added to an 
     * array list. This list is accessed, using the container control attribute 
     * SelectedIndex, to obtain the related child control Message attribute to be displayed.
     */
    {

       private ArrayList _items         = new ArrayList();
       private int       _selectedIndex = 0;

       public int SelectedIndex 
       { 
           get 
           {
              return _selectedIndex;
           }
           set 
           {
              _selectedIndex = value;
           }
       }

       [System.Security.Permissions.PermissionSet(System.Security.Permissions.SecurityAction.Demand, Name="FullTrust")] 
       protected override void AddParsedSubObject(Object obj) 
       /* Function name: AddParsedSubObject.
        * Updates the array list with the allowed child objects.
        * This function is called during the parsing of the child controls and 
        * after the GetChildControlType function defined in the associated control 
        * builder class.
        */
       {
          if (obj is MyCS_Item) 
         {
              _items.Add(obj);
           }
       }

       [System.Security.Permissions.PermissionSet(System.Security.Permissions.SecurityAction.Demand, Name="FullTrust")] 
       protected override void Render(HtmlTextWriter output) 
       /* Function name: Render.
        * Establishes the rules to render the built control. In this case, a message is
        * rendered that is a function of the parent control SelectedIndex attribute and 
        * the related child Message attribute.
        */
       {
          if (SelectedIndex < _items.Count) 
         {
              output.Write("<span style='background-color:aqua; color:red; font:8pt tahoma, verdana;'><b>" +
              ((MyCS_Item) _items[SelectedIndex]).Message + "</b></span>" );
         }
       }
    }    
}


'File name: controlBuilderAttribute.vb.

Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Collections



Namespace CustomControls

Public Class MyVB_Item: Inherits Control
      
      Private _message As String
      
      Public Property Message() As String
         Get
            Return _message
         End Get
         Set
            _message = value
         End Set
      End Property
   End Class
   
   Public Class VB_CustomParseControlBuilder: Inherits ControlBuilder

      <System.Security.Permissions.PermissionSetAttribute(System.Security.Permissions.SecurityAction.Demand, Name:="FullTrust")>  _
      Public Overrides Function GetChildControlType(TagName As String, attributes As IDictionary) As Type
          If (TagName = "customitem")  Then
            Return GetType(CustomControls.MyVB_Item)
         End If
         Return Nothing
      End Function 'GetChildControlType
   End Class
   
   <ControlBuilderAttribute(GetType(VB_CustomParseControlBuilder))>  Public Class MyVB_CustomParse: Inherits Control
      
      Private _items As New ArrayList
      Private _selectedIndex As Integer = 0
      
      
      Public Property SelectedIndex() As Integer
         Get
            Return _selectedIndex
         End Get
         Set
            _selectedIndex = value
         End Set
      End Property
      
      <System.Security.Permissions.PermissionSetAttribute(System.Security.Permissions.SecurityAction.Demand, Name:="FullTrust")> _
      Protected Overrides Sub AddParsedSubObject(obj As Object)
         If TypeOf obj Is MyVB_Item Then
            _items.Add(obj)
         End If
      End Sub
      
      <System.Security.Permissions.PermissionSetAttribute(System.Security.Permissions.SecurityAction.Demand, Name:="FullTrust")> _
      Protected Overrides Sub Render(output As HtmlTextWriter)        
        output.Write(("<span style='background-color:aqua; color:red; font:8pt tahoma, verdana;'><b>" + CType(_items(SelectedIndex), MyVB_Item).Message + "</b></span>"))
      End Sub
   End Class
   
End Namespace 'CustomControls

O exemplo a seguir usa o controle personalizado definido acima. Em particular, ele atribui os valores e Message valores SelectedIndex em tempo de execução para determinar a mensagem a ser renderizada. Observe que os valores mostrados na Register diretiva refletem a linha de comando anterior.

<%@ Register TagPrefix="custom" Assembly="myControlBuilderAtt" Namespace="CustomControls" %>  
 <h4>Using ControlBuilderAttribute Class<h4>  
 <form runat="server">  
  <custom:MyVB_CustomParse SelectedIndex="3" runat=server>  
  <customitem Message="Visual Basic version. Item One selected"/>  
  <customitem Message="Visual Basic version. Item Two selected"/>  
  <customitem Message="Visual Basic version. Item Three selected"/>  
  <customitem Message="Visual Basic version. Item Four selected"/>  
  </custom:MyVB_CustomParse>  
 </form>

<%@ Register TagPrefix="custom" Assembly="myControlBuilderAtt" Namespace="CustomControls" %>  
 <h4>Using ControlBuilderAttribute Class<h4>  
 <form runat="server">  
  <custom:MyCS_CustomParse SelectedIndex="2" runat=server>  
  <customitem Message="C# version. Item One selected"/>  
  <customitem Message="C# version. Item Two selected"/>  
  <customitem Message="C# version. Item Three selected"/>  
  <customitem Message="C# version. Item Four selected"/>  
  </custom:MyCS_CustomParse>  
 </form>

Comentários

Esse atributo especifica o construtor Type a ser usado para criar um controle personalizado, conforme mostrado no código a seguir:

[ControlBuilderAttribute(typeof(ControlBuilderType))]

Construtores

ControlBuilderAttribute(Type)

Especifica o construtor de controle para um controle personalizado.

Campos

Default

Especifica o novo objeto ControlBuilderAttribute. Por padrão, o novo objeto é definido como null. Este campo é somente leitura.

Propriedades

BuilderType	Obtém o Type do controle associado ao atributo. Esta propriedade é somente para leitura.
TypeId	Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute. (Herdado de Attribute)

Métodos

Equals(Object)	Obtém um valor que indica se o ControlBuilderAttribute atual é idêntico ao objeto especificado.
GetHashCode()	Retorna o código hash do objeto ControlBuilderAttribute.
GetType()	Obtém o Type da instância atual. (Herdado de Object)
IsDefaultAttribute()	Determina se o construtor de controle atual é o 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