Criando uma Web Part Básica com o Visual Studio .NET 2003

Neste artigo você verá como criar passo a passo uma Web Part através do Microsoft Visual Studio .NET.

por Maycol Sneider Romelli

using Microsoft.SharePoint.WebPartPages;
using System.Xml.Serialization;
using System.Web.UI.HtmlControls;

Definindo dados na caixa de ferramentas

A classe ToolboxDataAttribute é gerada para um custom control quando é arrastada de uma caixa de ferramentas em uma ferramenta como o Microsoft Visual Studio .NET.

Para definir dados na caixa de ferramentas

[ToolboxData("<{0}:WebCustomControl1 runat=server></{0}:WebCustomControl1>")]

por esta linha

[ToolboxData("<{0}:SimpleWebPart runat=server></{0}:SimpleWebPart>")]

Herdando da Classe de Web Part

Uma Web Part é compatível com um server controls ASP.NET porque a classe básica Microsoft.SharePoint.WebPartPages.WebPart herda da mesma classe pai class server controls, System.Web.UI.Control.

Herdar da classe base WebPart

public class WebCustomControl1 : System.Web.UI.WebControls.WebControl

por esta linha

public class SimpleWebPart : WebPart

Definindo o namespace XML

Para importar com sucesso sua Web Part, você tem que definir um namespace XML para todas as propriedades da Web Part.Você pode fazer isto globalmente declarando o XmlRoot atribuindo no topo a definição de sua Web Part, ou declarando um atributo XmlElement para cada propriedade customizável de sua classe. Os passos seguintes descrevem uso do XmlRoot atribuindo o nível de classe. Para exemplos que usam oatributo XmlElement, veja Criando uma Web Part com Propriedades Customizáveis.

Para definir o namespace XML para uma classe Web Part inteira

Usando o método RenderWebPart

A base class WebPart anula o método Render da System.Web.UI.Control e a infra-estrutura de uma Web Part precisa controlar a reenderização dos conteúdos de uma Web Part.Para isto, uma custom Web Part tem que anular o método RenderWebPart da base class WebPart.

Para implementar a class WebPart e o método RenderWebPart

Substitua esta linha de código
protected override void Render(HtmlTextWriter output)

Por esta linha
protected override void RenderWebPart(HtmlTextWriter output)

Modificando o namespace Web Part"s (usando Web Control Library Template ou Web Part Library Template)

Se você estiver criando múltiplas Web Parts, você geralmente deveria usar o mesmo namespace para todas as Web Parts. Por default, a Web Control Library e a Web Part Library Templates nomeiam para o namespace o mesmo nome como seu projeto. Para este exemplo, nós estamos usando o namespace arbitrário de MyWebParts para ambos e a classe WebPart e o namespace de XML para as propriedades da Web Part.

Para modificar o namespace Web Part

Substitua esta linha de código
namespace SimpleWebPart

Por esta linha
namespace MyWebParts

Para modificar o namespace XML

Substitua esta linha de código
[XmlRoot(Namespace="SimpleWebPart")]

Por esta linha
[XmlRoot(Namespace="MyWebParts")] Definindo a lógica e a renderização da Web Part

Depois que você completou os passos anteriores, você pode definir a lógica e renderização de sua Web Part. Para esta parte, escreveremos um código ASP.NET básico para criar dois HTML server controls: um text box, e um button terão alterados a propriedade Title de sua Web Part. Os códigos seguintes completarão o arquivo SimpleWebPart.cs com todas as modificações descritas nos passos anteriores. O código adicional que defini a funcionalidade da Web Part esta realçado em negrito:

//--------------------------------------------------------------------
// Arquivo: SimpleWebPart.cs
//
// Informação: Neste exemplo de Web Part demonstraremos a criação de um
// uma Web Part básica.
//--------------------------------------------------------------------
using System;
using System.ComponentModel;
using System.Runtime.InteropServices;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Xml.Serialization;
using Microsoft.SharePoint;
using Microsoft.SharePoint.WebPartPages;
using Microsoft.SharePoint.Utilities;
using System.Web.UI.HtmlControls;
namespace MyWebParts
{
    /// <summary>
    /// This Web Part changes it"s own title and implements a custom property.
    /// </summary>
    [XmlRoot(Namespace="MyWebParts")]    
    public class SimpleWebPart : WebPart
    {
        private const string defaultText = "hello";
        private string text=defaultText;
        // Declare variables for HtmlControls user interface elements.
        HtmlButton _mybutton;
        HtmlInputText _mytextbox;
        // Event handler for _mybutton control that sets the
        // Title property to the value in _mytextbox control.
        public void _mybutton_click (object sender, EventArgs e)
        {
            this.Title = _mytextbox.Value;
            try
            {
                this.SaveProperties=true;
            }
            catch
            {
                Caption = "Error... Could not save property.";
            }
        }
        // Override the ASP.NET Web.UI.Controls.CreateChildControls 
        // method to create the objects for the Web Part"s controls.      
        protected override void CreateChildControls ()
        {         
            // Create _mytextbox control.
            _mytextbox = new HtmlInputText();
            _mytextbox.Value="";
            Controls.Add(_mytextbox);

            // Create _mybutton control and wire its event handler.
            _mybutton = new HtmlButton();
            _mybutton.InnerText = "Set Web Part Title";
            _mybutton.ServerClick += new EventHandler (_mybutton_click);
            Controls.Add (_mybutton);
        }

        [Browsable(true),Category("Miscellaneous"),
        DefaultValue(defaultText),
        WebPartStorage(Storage.Personal),
        FriendlyName("Text"),Description("Text Property")]
        public string Text
        {
            get
            {
                return text;
            }

            set
            {
                text = value;
            }
        }
        protected override void RenderWebPart(HtmlTextWriter output)
        {
            RenderChildren(output);
            // Securely write out HTML
            output.Write("<BR>Text Property: " + SPEncode.HtmlEncode(Text));    
        }
    }
}

Depois que você inseriu todo o código, você pode construir sua Web Part. Assumindo que você está construindo sua Web Part em seu servidor, isto criará um assembly de nome SimpleWebPart.dll na pasta C:\inetpub\wwwroot\bin.

Para construir sua Web Part

Deploying da Web Part

Além de copiar o assembly para a pasta C:\inetpub\wwwroot\bin no seu servidor Sharepoint ( ou para a Global Assembly Cache folder C:\windows\assembly), você tem que executar três passos adicionais para fazer o deploy de sua Web Part:

• Registre sua Web Part como um safe control.
• Crie um arquivo Definition Web Part (.dwp).
• Importe sua Web Part para dentro de uma Web Part Page.

Registre sua Web Part como um SafeControl

Como uma medida de segurança, o Windows SharePoint Services requer que você (ou o administrador do servidor) registre o assembly de sua Web Part e o namespace como um SafeControl no arquivo web.config do servidor.

Para registrar o assembly da Web Part com um SafeControl

1. Abra o c:\inetpub\wwwroot\web.config no Visual Studio .NET ou no Notepad.

2. Adicione as linhas dentro do bloco <SafeControls>:

3. <SafeControl

4. Assembly="SimpleWebPart, Version=1.0.0.0, Culture=neutral, PublicKeyToken=def148956c61a16b"

5. Namespace="MyWebParts"

6. TypeName="*"

7. />

Nota: Altere o valor de PublicKeyToken (def148956c61a16b) com o atual valor para o assembly da sua Web Part.Para determinar o valor correto para o atributo do assembly <SafeControl> da sua Web Part, use o utilitário sn.exe em linha de comando: sn.exe -T c:\inetpub\wwwroot\bin\SimpleWebPart.dll

Nota: Você também pode determinar o valor de PublicKeyToken correto para o assembly de sua Web Part, executando de outra forma:

8. Dentro do Windows Explorer, abra a pasta C:\inetpub\wwwroot\bin.

9. Em uma janela separada, abra a pasta C:\Windows\Assembly. (C:\Windows\Assembly expõe os conteúdos do GAC.)

10. Arraste seu assembly Web Part ( seu exemplo para esses procedimentos deve ser nomeado para SimpleWebPart.dll) da pasta C:\inetpub\wwwroot\bin para a pasta C:\Windows\Assembly.

11. Na pasta C:\Windows\Assembly, clique com o botão direito no assembly, e então clique em Properties.

12. Copie o valor de PublicKeyToken, e cole dentro da tag <SafeControl> do seu assembly.

13. Na pasta C:\Windows\Assembly, clique com o botão direito no assembly, e clique em Delete.

Criando o arquivo Web Part Definition (.dwp)

Um arquivo Web Part Definition (. dwp) é um arquivo simples XML que contém property settings de uma única Web Part. Para importar sua Web Part em uma Web Part Page, simplesmente faça o upload do arquivo .dwp. Depois de feito o upload da sua Web Part , você pode exibir a Web Part arrastando para uma das zonas de uma Web Part Page.

Duas properties são requeridas dentro do arquivo .dwp: Assembly e TypeName. Porém, para exibir o nome default e a descrição da sua Web Part depois que foi importada, você também deveria incluir as propriedades de Título e Descrição. Se você quiser setar outras propriedades da sua Web Part durante a importação, você também pode definir dentro do arquivo .dwp. Um arquivo .dwp tem o seguinte formato:

<?xml version="1.0"?>
<WebPart xmlns="http://schemas.microsoft.com/WebPart/v2">
   <Assembly>AssemblyName(with no .dll extension), Version=VersionNumber, Culture=Culture, 
PublicKeyToken=PublicKeyToken</Assembly>
   <TypeName>WebPartNamespace.WebPartClassName</TypeName>
   <Title>DefaultWebPartTitle</Title>
   <Description>WebPartDescription</Description>
</WebPart>

Se você usasse os Web Part Templates, o arquivo .dwp terá sido criado automaticamente para você; há pouco tenha certeza que depois que você também mudou o nome da sua Web Part você terá que mudar o TypeName correspondente dentro o. arquivo .dwp. Se você não usar os Web Part Templates para criar um arquivo .dwp como mostrado no exemplo da sua Web Part, digite as seguintes linhas em um novo documento Notepad e salve como SimpleWebPart.dwp no diretório C:\Inetpub\wwwroot\bin.

<?xml version="1.0"?>
<WebPart xmlns="http://schemas.microsoft.com/WebPart/v2">
   <Assembly>SimpleWebPart, Version=1.0.0.0, Culture=Neutral, 
PublicKeyToken=def148956c61a16b</Assembly>
   <TypeName>MyWebParts.SimpleWebPart</TypeName>
   <Title>My Simple Web Part</Title>
   <Description>A sample Web Part</Description>
</WebPart>

Nota: No exemplo anterior, substitua o valor de PublicKeyToken (def148956c61a16b) com o valor atual para o assembly da sua Web Part.

Importe sua Web Part em uma Web Part Page

Para usar e testar sua Web Part, importe em uma Web Part Page em um servidor Windows SharePoint Service ou SharePoint Portal Server.

Para importar sua Web Part

1. Abra a Web Part Page no seu servidor.

2. Clique em Modify My Page ou Modify Shared Page (dependendo se você esta em Personal View ou Shared View) no canto superior direito da página clique em Add Web Parts no menu.

3. Clique Import.

4. Localize na pasta o arquivo SimpleWebPart.dwp e clique no botão de Upload. Depois de realizado o upload, a página dará um refresh e "My Simple Web Part" deverá ser exibida debaixo Import Web Part.

5. Arraste o ícone próximo a "My Simple Web Part " para uma zona na Web Part Page.

Digite algum texto dentro do textbox, e então clique em Set Web Part Title para testá-la, boa sorte.

Conclusão

Neste artigo, nós vimos como criar uma Web Part, efetuar o deployment, registrá-la, criar o arquivo Web Part Definition (.dwp), importá-la e ultilizá-la em uma intranet corporativa.

Até o próximo artigo...