lunes, 22 de agosto de 2011

Metodo Generico

Objectivo
Crear un metodo que no este sujeto a un query especifico y que retorne un control poblado de datos.
Requisito:
  • Visual Estudio 2008 o Superior
  • Agregar una conexion a la base de datos con la que quiere interactual, para este ejemplo se utilizo la base de datos AdventureWorks descargada del site codeplex
  • Agregar un label al formulario para reflejar el valor selecciona del control
Nota:
  • Para realizar esta practica agregue u projecto tipo web y pegue este codigo en el codebehind de la pagina Default.aspx
  • Este codigo trabaja bien con controles de lista de aplicaciones web y aplicaciones winform, tales como:
  1. CheckBoxList
  2. DropDownList
  3. ListBox y
  4. RadioButtonList


Codigo C#
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Reflection;
using System.Globalization;
using System.ComponentModel;

public partial class _Default : System.Web.UI.Page
{
    #region Evento Load de la pagina
    protected void Page_Load(object sender, EventArgs e)
    {
        AdventureWorks_DataModel.AdventureWorks_DataEntities db = new AdventureWorks_DataModel.AdventureWorks_DataEntities();

        form1.Controls.Add(ControlBuilder<AdventureWorks_DataModel.Product, DropDownList>(db.Products.Select(dd => dd).ToList(), "ProductID", "Name", "dd1", "hola"));
    }
    #endregion Evento Load de la pagina

    #region Generic Method
    private static U ControlBuilder<T, U>(List<T> row, string datavaluefieldname, string datatextfieldname, string id, string Etiqueta)
        where T : class
        where U : class
    {
        Type ControlToReturnType = typeof(U);

        DropDownList ControlToReturn = (DropDownList)ControlToReturnType.InvokeMember
            (
            null,
            BindingFlags.Public |
            BindingFlags.Instance |
            BindingFlags.CreateInstance,
            null,
            null,
            null
            );
        
        ControlToReturn.ID = id;
        ControlToReturn.AutoPostBack = true;
        ControlToReturn.CausesValidation = false;
        ControlToReturn.Width = System.Web.UI.WebControls.Unit.Percentage(100);
        ControlToReturn.SelectedIndexChanged += new EventHandler(ControlToReturn_SelectedIndexChanged);

        foreach (T item in row)
        {
            PropertyDescriptorCollection properties = TypeDescriptor.GetProperties(item);

            System.ComponentModel.PropertyDescriptor MyProperty1 = properties.Find(datatextfieldname, false);
            System.ComponentModel.PropertyDescriptor MyProperty2 = properties.Find(datavaluefieldname, false);

            ListItem li = new ListItem();

            li.Text = MyProperty1.GetValue(item).ToString();
            li.Value = MyProperty2.GetValue(item).ToString();
            ControlToReturn.Items.Add(li);
        }

        ListItem EtiquetaApertura = new ListItem();
        EtiquetaApertura.Enabled = true;
        EtiquetaApertura.Selected = true;
        EtiquetaApertura.Value = null;
        EtiquetaApertura.Text = Etiqueta;
        ControlToReturn.Items.Insert(0, EtiquetaApertura);

        return ControlToReturn as U;
    }
    #endregion GenericMethod

    #region Manejador de evento para el control
    static void ControlToReturn_SelectedIndexChanged(object sender, EventArgs e)
    {
        DropDownList dl = (DropDownList)sender;
        Page page = (Page)dl.NamingContainer;

        Label lb = (Label)page.FindControl("lb1");

        lb.Text = dl.SelectedValue;

    }
    #endregion Manejador de evento para el control
}
            
Descripcion:
  1. En el evento load de la pagina agregamos el contexto de la base de datos que utilizaremos para realizar el query de los campos que queremos que se vizualicen en el control
    protected void Page_Load(object sender, EventArgs e)
        {
            AdventureWorks_DataModel.AdventureWorks_DataEntities db = new AdventureWorks_DataModel.AdventureWorks_DataEntities();
        }
  2. Agregamos el control a la coleccion de controles del formulario de la pagina invocando el metodo y pasandoles los argumentos requerido. Al metodo les estamo diciendo:
    • Que como parametro de entrada utilizaremos el tipo Product.
    • Que como parametro de salida nos retorne un DropDownList para visualizacion los datos.
    Y como argumento les estamos pasando:
    • Query que retorna una lista con todas las filas de la base de datos.
    • "ProductID", como el valor del control ListItems.
    • "Name", como el valor a mostrar en el control ListItems.
    • "dd1", como el ID del control.
    • "Seleccione una Opcion", como Etiqueta del control.
    protected void Page_Load(object sender, EventArgs e)
        {
            form1.Controls.Add(ControlBuilder<AdventureWorks_DataModel.Product, DropDownList>(db.Products.Select(dd => dd).ToList(), "ProductID", "Name", "dd1", "Seleccione una Opcion"));
        }
  3. Procedemos a la declaracion del metodo que contiene la siguiente firma
    • Un parametro Generico de entrada de Tipo T.
    • Un parametro Generico de salida de Tipo U.
    Y como Parametros Formales:
    • Una lista de tipo T.
    • Un valor para el control ListItems.
    • Un valor para mostrar en el control ListItems.
    • El ID del control.
    • Una etiqueta de apertura.
    • Y por ultimo restringimos el argumento de tipo a tipo de referencia
    private static U ControlBuilder<T, U>(List<T> row, string datavaluefieldname, string datatextfieldname, string id, string Encabezado)
            where T : class
            where U : class
        {
        }
                        
  4. Pasamos a la implementacion del metodo en donde obtenemos el tipo de valor pasado para la creacion de nuestra instancia
  5. Type ControlToReturnType = typeof(U);
  6. Creamos una instancia del tipo suministrado, para crear la instancia invocamos el metodo InvokeMember() del tipo.
  7. DropDownList ControlToReturn = (DropDownList)ControlToReturnType.InvokeMember
                (
                null,
                BindingFlags.Public |
                BindingFlags.Instance |
                BindingFlags.CreateInstance,
                null,
                null,
                null
                );
  8. Seteamos las propiedades e instanciamos nuestro manejador de evento
  9. ControlToReturn.ID = id;
    ControlToReturn.AutoPostBack = true;
    ControlToReturn.CausesValidation = false;
    ControlToReturn.Width = System.Web.UI.WebControls.Unit.Percentage(100);
    ControlToReturn.SelectedIndexChanged += new EventHandler(ControlToReturn_SelectedIndexChanged);
    
  10. Procesamos las filas pasada al metodo mediante el parametro formal "List<T> Rows" para poder almar nuestro control ListItems
  11. foreach (T item in row)
            {
                // Creo una nueva colleccion y le asigno a esta las prepiedades de item.
                PropertyDescriptorCollection properties = TypeDescriptor.GetProperties(item);
    
                // Seteo el PropertyDescriptor a la propiedad especificada.
                System.ComponentModel.PropertyDescriptor MyProperty1 = properties.Find(datatextfieldname, false);
                System.ComponentModel.PropertyDescriptor MyProperty2 = properties.Find(datavaluefieldname, false);
    
                ListItem li = new ListItem();
    
                li.Text = MyProperty1.GetValue(item).ToString();
                li.Value = MyProperty2.GetValue(item).ToString();
                ControlToReturn.Items.Add(li);
            }
    
            ListItem EtiquetaApertura = new ListItem();
            EtiquetaApertura.Enabled = true;
            EtiquetaApertura.Selected = true;
            EtiquetaApertura.Value = null;
            EtiquetaApertura.Text = Encabezado;
            ControlToReturn.Items.Insert(0, EtiquetaApertura);
    
            return ControlToReturn as U;
        }
    • Descompongo la fila en cada uno de sus columnas o campos mediante TypeDescriptor.GetProperties (Método) y se los agregos a mi coleccion
      PropertyDescriptorCollection properties = TypeDescriptor.GetProperties(item);;;;
      
    • Localizo los campos DataTextField y DataValueField dentro de la coleccion para asignarselo a la propiedad Text y Value respectivamente del control ListItem
    • System.ComponentModel.PropertyDescriptor MyProperty1 = properties.Find(datatextfieldname, falseSystem.ComponentModel.PropertyDescriptor MyProperty2 = properties.Find(datavaluefieldname, false);
      
    •  Creo mi instancia del control ListItem, pasandole el valor de los campos: DataTextField y DataValueField mediante PropertyDescriptor.GetValue (Método), a sus propiedades: Text y Value respectivamente y lo agrego a la coleccion de controles ListItem del control a retornar en el parametro generico del metodo
    • ListItem li = new ListItem();m();
      
      li.Text = MyProperty1.GetValue(item).ToString();
      li.Value = MyProperty2.GetValue(item).ToString();
      
      ControlToReturn.Items.Add(li);
    • Creamos una instancia del control ListItem que servira como etiqueta de apertura del control a retornar seteando sus propiedades y agregando a la posicion cero dentro de la coleccion de controles ListItem del control a retornar en el parametro generico del metodo
    • ListItem EtiquetaApertura = new ListItem();
      EtiquetaApertura.Enabled = true;
      EtiquetaApertura.Selected = true;
      EtiquetaApertura.Value = null;
      EtiquetaApertura.Text = Encabezado;
      ControlToReturn.Items.Insert(0, EtiquetaApertura);
  12. Retornamos el control
  13. return ControlToReturn as U;
  14. Por ultimo implementamos el metodo manejador para el evento OnSelectedIndexChanged del control retornado
  15. static void ControlToReturn_SelectedIndexChanged(object sender, EventArgs e)
        {
            DropDownList dl = (DropDownList)sender;
            Page page = (Page)dl.NamingContainer;
    
            Label lb = (Label)page.FindControl("lb1");
    
            lb.Text = dl.SelectedValue;
    
        }