Walkthrough: criando uma Web Part SharePoint básica

Artigo
11/27/2008

Esta tarefa programação inclui as etapas para criar um personalizado básico Windows SharePoint Services de Web Parts. Ele é uma Web Part simples que permite que você alteração do Web Part Title P:Microsoft.SharePoint.WebPartPages.WebPart.Title, que é um Windows SharePoint Services WebPart T:Microsoft.SharePoint.WebPartPages.WebPart classe base propriedade que define o texto na barra de título da Web Part.

Importante

Começando com Windows SharePoint Services 3.0, a infra-estrutura de SharePoint Web Parts é compilado no parte superior dos infra-estrutura Web Part Microsoft ASP.NET 2.0 e Web Parts que derivado de ASP.NETWindows SharePoint Services WebPartclasse são completamente com suporte em Windows SharePoint Services.Você deve criar ASP.NET Web Parts sempre que possível.

Para obter mais informações sobre como escolher o melhor classe base Web Part a partir da qual derivam, consulte Desenvolvendo Web Parts nos serviços SharePoint Windows no Windows SharePoint Services Software Development Kit (SDK).Para obter mais informações sobre ASP.NET Web Parts, consulte oVisão geral sobre conjunto de controles Web Parts na documentação de ASP.NET.

Pré-requisitos

Visual Studio 2005 Microsoft

Windows SharePoint Services 3.0

Etapa 1: Criar um projeto Web Control Library

Web Parts baseiam-se nos controles Web Forms do ASP.NET. Você cria Web Parts no Microsoft Visual C# ou Microsoft Visual Basic usando o modelo ASP.NET Web Control Library.

Para criar um novo projeto Web Control Library

Inicie Visual Studio 2005.
No menu Arquivo , apontar para nova e, em seguida, clique Project .
In the New Project dialog box, click Visual C# Projects or Visual Basic Projects, and then select the Web Control Library template.
Tipo SimpleWebPart como o nome e especificar a localidade para os arquivos projeto e, em seguida, clique OK .

Etapa 2: Adicionar uma referência para Microsoft.SharePoint.dll

Para criar uma Web Part, você precisa adicionar uma referência para o Microsoft.SharePoint Microsoft.SharePoint assembly (Microsoft.SharePoint.dll) no seu projeto Web Control Library.

Para adicionar uma referência ao Microsoft.SharePoint.dll

O menu do projeto, clique em Adicionar Referência .
Na guia .NET, clique duplo serviços SharePoint Windows .
Clique em OK .

Etapa 3: Definir o número da versão e configurar parcialmente de confiança chamadores

Por padrão, a AssemblyVersion AssemblyVersion propriedade de seu projeto é definido como incremento cada tempo você recompilar o Web Part. Uma página Web Part identifica uma Web Part com número de versão de aula especificado no arquivo web.config web.config. Com a propriedade AssemblyVersion AssemblyVersion definida como incremento, se você recompilar seu Web Part depois importando-lo para uma página, a estrutura Web Part Web Part será aspecto para número de versão que você especificou no arquivo web.config web.config. Se não for igual ao número de versão, um erro irá ocorrer. Para evitar a número de versão de seu Web Part de incremento cada tempo você recompilar, você precisa definir número de versão no arquivo AssemblyInfo AssemblyInfo.

Desde que você está criando assinado codificar, você deve também informar o assembly para permitir chamadas código parcialmente confiado. Por padrão, qualquer strong-named assembly que não explicitamente OPT para seu uso por código parcialmente confiado será que pode ser chamado pelo somente por outros conjuntos de módulos (assemblies) que recebem confiança completa por política de segurança.

Para definir o número versão e permitir parcialmente de confiança chamadores

Em Gerenciador de Soluções , clique duplo o arquivo AssemblyInfo

Edite a linha:

                          [assembly: AssemblyVersion(“1.0.*”)]

                          <Assembly: AssemblyVersion(“1.0.*”)>

Para que ele lê:

                          [assembly: AssemblyVersion(“1.0.0.0”)]

                          <Assembly: AssemblyVersion(“1.0.0.0”>

Adicione a seguinte linha para o parte superior do arquivo:

                          using System.Security;

                          Imports System.Security;

Adicione a seguinte linha para a inferior do arquivo:

                          [assembly: AllowPartiallyTrustedCallers]

                          <Assembly: AllowPartiallyTrustedCallers()>

Etapa 4: Renomear a classe e namespace

Se você estiver criando múltiplo Web Parts, você deve geralmente usa o mesmo espaço para nome em todos a Web Parts. Por padrão, a biblioteca de controle da Web atribui o espaço para nome o mesmo nome de seu projeto. Para esse exemplo, estamos usando o espaço para nome arbitrário de MyWebParts para o WebPart WebPart classe. Depois de criar o projeto, um em branco arquivo classe é exibido. Você pode alteração nome classe do WebCustomControl para identificar facilmente seu novo Web Part usar como padrão.

Para renomear a classe e espaço para nome

Renomeie a classe usar como padrão selecionando WebCustomControl1 Gerenciador de Soluções , clique com o botão direito do mouse, clique no Renomear e tipo SimpleWebPart como nome de arquivo.

Para C#, alteração o namespace Web Part por edição da linha:

                          namespace SimpleWebPart

Para que ele lê:

                          namespace MyWebParts

Para Visual Basic, clique com o botão direito do mouse do projeto SimpleWebPart no Gerenciador de Soluções clique e propriedades . Substituir o texto no conjunto de módulos (assembly) Nome e caixas de texto raiz namespace para MyWebParts.SimpleWebPart

Etapa 5: Adicionar uma diretiva namespace

Para torná-lo mais fácil gravar uma básico WebPart WebPart classe, você deve usar o using C# ou a diretiva Imports importações em Visual Basic para fazer referência a seguinte espaço para nome no seu codificar:

O espaço para nome Microsoft.SharePoint.WebPartPages N:Microsoft.SharePoint.WebPartPages fornece os tipos para Páginas de Web Parts, como a Microsoft.SharePoint.WebPartPages.WebPart T:Microsoft.SharePoint.WebPartPages.WebPart classe.

Para adicionar uma diretiva de espaço para nome

Adicione o seguinte using ou diretiva Imports importações perto de parte superior de seu codificar:

                          using Microsoft.SharePoint.WebPartPages;

                          Imports Microsoft.SharePoint.WebPartPages

Etapa 6: herdar da classe a Parte da Web

Por padrão, o modelo Web Control Library cria uma controle personalizado que herda do System.Web.UI.Control System.Web.UI.Control classe (uma classe pai das classes WebPart tanto a ASP.NET e SharePoint). Para criar uma Web Part SharePoint, você deve herdam a classe base Microsoft.SharePoint.WebPartPages.WebPart T:Microsoft.SharePoint.WebPartPages.WebPart.

Para herdar de classe base de Web Part.

Substitua essa linha de codificar:

                          public class SimpleWebPart : WebControl

                          Public Class SimpleWebPart
   Inherits WebControl

Com esta linha:

                          public class SimpleWebPart : WebPart

                          Public Class SimpleWebPart
   Inherits WebPart

Etapa 7: Usar o método RenderWebPart

O classe base WebPart WebPart lacra o Render método de processamento de System.Web.UI.Control porque a infra-estrutura de Web Parts precisa para controle processamento o conteúdo de uma Web. Por esse motivo, personalizado Web Parts deve substituir o RenderWebPartWebPart RenderWebPart.

Para usar o método RenderWebPart.

Substitua essa linha de codificar:

                          protected override void Render(HtmlTextWriter output)

                          Protected Overrides Sub RenderContents(ByVal output as HtmlTextWriter)

Com esta linha:

                          protected override void RenderWebPart(HtmlTextWriter output)

                          Protected Overrides Sub RenderWebPart(ByVal output as HtmlTextWriter)

Etapa 8: definir a lógica e processamento de sua Web Part

Depois que você completo as etapas anteriores, você pode definir a lógica e processamento para sua Web Part. Para esta parte, irá escrevemos alguns codificar ASP.NET básica criar dois controles: um caixa de texto e um botão que irá definir o Title P:Microsoft.SharePoint.WebPartPages.WebPart.Title da Web Part.

Para definir a lógica e processamento de sua Web Part

Criar dois objetos interface do usuário adicionando o seguinte codificar perto de parte superior do arquivo SimpleWebPart SimpleWebPart.

                          Button saveTitle;
TextBox newTitle;

                          Public saveTitle as Button
Public newTitle as TextBox

Criar o evento manipulação botão adicionando o seguinte codificar dentro de classe.

                          public void saveTitle_click(object sender, EventArgs e)
{
     this.Title = newTitle.Text;
     try
     {
          this.SaveProperties = true;
     }
     catch (Exception ex)
     {
          this.Title = "Error: " + ex.Message;
     }
}

                          Public Sub saveTitle_Click(ByVal sender As Object, ByVal e As EventArgs)
    Me.Title = newTitle.Text
    Try
        Me.SaveProperties = True
    Catch ex As Exception
        Me.Title = "Error: " & ex.Message
    End Try
End Sub

Substituir o CreateChildControls() CreateChildControls() método adicionando o seguinte codificar dentro de classe.

                          protected override void CreateChildControls()
{
     //Create text box
     newTitle = new TextBox();
     newTitle.Text = "";
     Controls.Add(newTitle);

     //Create button
     saveTitle = new Button();
     saveTitle.Text = "Set Web Part Title";
     saveTitle.Click += new EventHandler(saveTitle_click);
     Controls.Add(saveTitle);
}

                          Protected Overrides Sub CreateChildControls()
    'Create text box
    newTitle = New TextBox()
    newTitle.Text = ""
    Controls.Add(newTitle)

    'Create button
    saveTitle = New Button()
    saveTitle.Text = "Set Web Part Title"
    AddHandler saveTitle.Click, AddressOf saveTitle_Click
    Controls.Add(saveTitle)
End Sub

Substituir o RenderWebPart() método RenderWebPart() a seguinte linha de codificar.

                          protected override void  RenderWebPart(HtmlTextWriter output)
{
     RenderChildren(output);
}

                          Protected Overrides Sub RenderWebPart(ByVal output as HtmlTextWriter)
    RenderChildren(output)
End Sub

A etapa 9: Criar um nome de alta segurança válido para o conjunto de módulos (assembly)

Web Parts projetados para ser distribuído pela Internet ou uma intranet. Por motivos de segurança, quando você cria um personalizado Web Part, você deve fornecê-lo um nome forte para assegurar que os Web Part podem ser de confiança pelos usuários. Para obter mais informações sobre a nomeação de alta segurança, consulte Implantando Web Parts nos serviços SharePoint Windows e também Related Topics no final deste explicação passo a passo.

Para atribuir um nome forte para um assembly

Gerenciador de Soluções , clique com o botão direito do mouse no projeto SimpleWebPart e clique em propriedades .
Nas propriedades SimpleWebPart, clique o assinatura guia no lado esquerdo.
Na guia Assinatura, verificar o assinar a caixa de seleção assembly.
Selecione nova no escolher uma chave nome forte arquivo drop-down menu.
No diálogo de Create Strong Name Key, tipo SimpleWebPartKey e desmarcar proteger minha chave arquivo com uma senha .
Agora, o assembly será assinado quando for compilado.

A etapa 10: criar A Web Part

Depois de adicionar todos as acima codificar, você pode compilar seu exemplo Web Part.

Para compilar a Web Part

O menu criação, clique em Solução de Compilação .

A etapa 11: Copiar O DLL para Diretório a Lixeira

Depois que a Web Part for compilado, você deve copiar o DLL resultante para o Diretório bin.

Para copiar o DLL para o Diretório bin

Sobre o sistema de arquivos, localizar o arquivo SimpleWebPart.dll SimpleWebPart.dll. A localidade usar como padrão para Visual Studio 2005 é C:\Documents and Settings\ username \My Documents\Visual Studio 2005\Projects\SimpleWebPart\SimpleWebPart\bin\Debug.
Copie o arquivo SimpleWebPart.dll SimpleWebPart.dll de Diretório de saída para o Diretório aplicativo da Web raiz bin. É a localidade usar como padrão de raiz o aplicativo da Web para C:\Inetpub\wwwroot\wss\VirtualDirectories\ PortNumber \bin.

Para obter mais informações, consulte Como a: Localizar a raiz de aplicativo da Web.

A etapa 12: aumentar o nível de confiança padrão e adicionar uma entrada SafeControl para a Web Part

fornece uma lista SafeControls para evitar usuários adicionando arbitrariamente codificar server-side em páginas ASPX. A lista SafeControls é uma lista de controles aprovados e Web Parts específicas para seu site do SharePoint que você designou como seguro para a chamada em qualquer página ASPX no seu site. Essa lista está contida no arquivo web.config web.config em sua raiz aplicativo da Web. O local caminho contém o físico localidade do arquivo web.config web.config.

Por padrão, o nível de confiabilidade para este servidor é WSS_Minimal, que não permite acessar para o modelo de objeto Windows SharePoint Services wssnoversshort. Para esta Web Part definir o SaveProperties P:Microsoft.SharePoint.WebPartPages.WebPart.SaveProperties propriedade, você deve executar uma do seguinte três ações:

Criar um personalizado arquivo de política para o assembly, ou
Instalar o assembly no cache global de assemblies, ou
Aumente o nível de confiabilidade para o servidor virtual inteiro.

Neste exemplo, você aumentará a confiança usar como padrão de WSS_Minimal a WSS_Medium no arquivo web.config web.config.

Observação

O arquivo web.config web.config está localizado na pasta onde o diretório virtual para o site é executado.It is usually located in the following directory: c:\inetpub\wwwroot\wss\VirtualDirectories\PortNumber, but your administrator may have set up your directory differently and this may not be the location of the file.

Você pode localizar a localidade do seu arquivo web.config web.config usando o snap-in Serviços de Informações da Internet (IIS).Snap o IIS-in é uma ferramenta de administração de IIS que foi integrado com outros administrativo funções.Para iniciar o snap-in IIS e localizar o arquivo web.config web.config:

Click Start, point to Programs, point to Administrative Tools, and click Internet Information Services (IIS) Manager.
Expanda o nó que é o nome do seu computador, e expansão o Web Sites item na árvore.
Localize o site W3 (World Wide Web) que execução sua instalação Windows SharePoint Services wssnoversshort (geralmente é Default Web Site ).
Clique com o botão direito do mouse e selecione propriedades .
Selecione a guia Home Directory.

Para aumentar a usar como padrão nível de confiabilidade e adicionar uma entrada SafeControl para seu Web Part

Abra o arquivo web.config web.config na raiz de aplicativo da Web.
No leveltrust WSS_Minimal a WSS_Medium .

No SafeControls SafeControls seção do seu arquivo web.config web.config, adicionar um SafeControl entrada para seu personalizado assembly como segue.

                          <SafeControl Assembly="SimpleWebPart, Version=1.0.0.0, Culture=neutral, PublicKeyToken=PublicKeyToken" Namespace="MyWebParts" Typename="SimpleWebPart" Safe="True"/>

Substituir o PublicKeyToken o real valor para do o Web Part assembly. Para determinar o correto PublicKeyToken para sua Parte da Web, use o utilitário de linha de comando sn.exe.
```
                          sn.exe -T C:\inetpub\wwwroot\wss\VirtualDirectories\PortNumber\bin\SimpleWebPart.dll
```

A etapa 13: criar um arquivo DWP para implantar a Web Part

Um arquivo definição Web Part (.dwp) é um arquivo XML simples que contém as configurações propriedade para um único Web Part. A importação da Web Part em uma página, basta carregar o arquivo .dwp Web Part. Após carregar a Web Part, você pode exibir a Web Part ao arrastá-la em uma das zonas da página de Web Part.

Duas propriedades são exigido no arquivo .dwp: Assembly e TypeName. No entanto, para exibir um usar como padrão Nome e descrição para o Web Part depois dela é importado, você também deve incluir o Title e Description Descrição propriedades. Se você desejar definir outras propriedades Web Part durante importação, você também pode defini-los em um arquivo .dwp. Um arquivo .dwp leva a seguinte forma.

                    <?xml version="1.0"?>
<WebPart xmlns="https://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>

Para criar um arquivo DWP

Copiar e colar o seguinte XML em um novo arquivo de texto.

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