<Preencher Dropdown com informação de um ficheiro XML ⁄ >

9484

2007-06-02

mySnippets asp.net

Download

Bookmark This

Aqui vai um exemplo simples de como poderá ser preenchida uma dropdown, tendo como fonte de informação um ficheiro em XML. A utilização da dropdown é somente uma hipótese, o código facilmente é adaptado para qualquer outro tipo de situação.

Poderá ser importante se por exemplo quiserem obter informação cross-domain e não possuem maneira de aceder por ex. a uma base de dados ou a uma listagem de ficheiros, etc, etc; basicamente, poderá ser comparado a um web-service bastante arcaico e/ou simples.

Vamos ter como base o seguinte ficheiro xml:

<xml>
  <pedrocorreia.net>
    <artes_marciais>
 
      <arte_marcial>
        <name>taichichuan</name>
        <description>Tai Chi Chuan</description>
      </arte_marcial>
 
      <arte_marcial>
        <name>aikido</name>
        <description>Aikido</description>
      </arte_marcial>
 
      <arte_marcial>
        <name>kendo</name>
        <description>Kendo</description>
      </arte_marcial>
 
      <arte_marcial>
        <name>taekwondo</name>
        <description>Taekwon-Do</description>
      </arte_marcial>
 
    </artes_marciais>
  </pedrocorreia.net>
</xml>

De salientar que vai existir uma colecção de artes marciais, em que cada item é composto por uma arte marcial, que por sua vez possui 2 atributos, o seu nome e a sua descrição, este 2 atributos será usados para preencher a dropdown, os atributos "name" irão ter a seguinte correspondência:
< option value="name">description</option>

nota: estes 2 campos não são fixos, são totalmente configuráveis. Aquando a criação da Class, são apenas 2 dos vários parâmetros que constituem a sua assinatura, mas isso fica lá mais para a frente ...

Vamos utilizar o web.config para guardar a informação de onde está localizado o ficheiro, adicionando a seguinte app setting:

    <!-- Application Custom Configs -->
    <appSettings>
      <add key="UrlXML" value="http://www.pedrocorreia.net/_snippets_/aspnet/dropdown_xml/xml.xml"/>
    </appSettings>

Usar o web.config não é obrigatório, como poderão ver posteriormente pela construção da Class.

A class responsável pela leitura e preenchimento do webcontrol será esta:

using System;
using System.Data;
using System.Configuration;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;
 
/// <summary>
/// Class responsável pela preenchimento da dropdown
/// </summary>
public class FillDropdownList{
 
    private DropDownList _ddl;
    private string _ddlText;
    private string _ddlValue;
    private string _nodeElement;
    private string _urlXml;
 
    /// <summary>
    /// Obter ou alterar o nome do campo que irá preencher o texto dos itens
    /// </summary>
    public string DDLText { get { return _ddlText; } set { _ddlText = value; } }
 
    /// <summary>
    /// Obter ou alterar o nome do campo que irá preencher o valor dos itens
    /// </summary>
    public string DDLValue { get { return _ddlValue; } set { _ddlValue = value; } }
 
    /// <summary>
    /// Obter ou alterar o endereço do ficheiro xml a ser lido
    /// </summary>
    public string UrlXml { get { return _urlXml; } set { _urlXml = value; } }
 
    /// <summary>
    /// Obter ou alterar o nome dos elementos que vão ser lidos
    /// </summary>
    public string NodeElement { get { return _nodeElement; } set { _nodeElement = value; } }
 
    /// <summary>
    /// Método construtor
    /// </summary>
    /// <param name="dropdown">Dropdown a ser preenchida</param>
    /// <param name="urlXml">Endereço do xml a ser lido</param>
    /// <param name="fieldText">Campo que possui o valor dos itens</param>
    /// <param name="fieldValue">Campo que possui o texto dos itens</param>
    /// <param name="nodeElement">Identificação do elemento onde estão guardados os itens a processar</param>
    public FillDropdownList(DropDownList dropdown, string urlXml, string fieldText, string fieldValue, string nodeElement) {
        this._ddl= dropdown;
        this._ddlText = fieldText;
        this._ddlValue = fieldValue;
        this._urlXml = urlXml;
        this._nodeElement = nodeElement;
    }
 
    /// <summary>
    /// Preencher DropdownList
    /// 
    /// nota: o tratamento de erros deverá ser mais elaborado ...
    /// </summary>
    public void FillDropdown() {
        DataSet dataSet = new DataSet();
 
        dataSet = new DataSet(this._nodeElement);
        dataSet.ReadXml(this._urlXml);
 
        this._ddl.DataSource = dataSet.Tables[this._nodeElement];
        this._ddl.DataTextField = this._ddlText;
        this._ddl.DataValueField = this._ddlValue;
        this._ddl.DataBind();
 
        this._ddl.Items.Insert(0, new ListItem("(escolha um item)", ""));
 
        dataSet.Dispose();
    }
 
}

Construindo a interface com o utilizar ...

<%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="Default" %>
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Preencher DropdownList usando conteúdos fornecidos por xml</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <label for="DDList" id="lblDDList" title="Escolha uma Arte Marcial">Arte Marcial</label>
      <asp:DropDownList ID="DDList" runat="server"></asp:DropDownList>
    </div>
    </form>
</body>
</html>

Last, but no the least, na nossa code-behind file iremos invocar no Page_Load a class responsável pelo tratamento da dropdown e o seu consequemente o preenchimento;

using System;
using System.Data;
using System.Configuration;
using System.Collections;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;
 
using System.Web.Configuration;
 
public partial class Default : System.Web.UI.Page{
    protected void Page_Load(object sender, EventArgs e){
        if (!IsPostBack) {
            string urlXmlService = WebConfigurationManager.AppSettings["UrlXML"].ToString();
            FillDropdownList ddl = new FillDropdownList(this.DDList, urlXmlService, "description", "name", "arte_marcial");
            ddl.FillDropdown();
        }
    }
}

Qualquer erro/ dúvida é só dizer!

9484

2007-06-02

mySnippets asp.net

Download

Bookmark This