Walkthrough: Criando uma básica da Web Part

Artigo
11/27/2008

Esta explicação passo a passo fornece as etapas para criar um personalizado básico que podem ser adicionados ao seu Web Part Pages Web Part. Ele é uma Web Part simples que permite que o usuário para definir um personalizado mensagem a ser exibido dentro de Web Part. Esta Web Part será derivar da classe de Web Part ASP.NET 2.0, qual é a prática recomendada para Windows SharePoint Services. Observe que este explicação passo a passo descreve como criar uma Parte da Web sem as extensões Visual Studio para Windows SharePoint Services.

Para obter mais informações sobre ASP.NET Web Parts, consulte a seguinte documentação ASP.NET: Inicialização Rápida do ASP.NET tutoriais e ASP.NET Web Parts controles .

Observação

Você também pode desenvolver o Web Parts, usando as extensões Visual Studio de Windows SharePoint Services.Usando essas extensões, você pode reduzir bastante o trabalho envolvido na criação e implantando o Web Parts.As extensões requerem desenvolvimento em um ambiente servidor e oferecem a seguinte benefícios:

Geração automática do seu pacote solução
Geração automática de arquivo XML de WebPart
Capacidade para implantar Web Parts diretamente de dentro Visual Studio para seu site

Para obter orientação sobre usando as extensões ou para baixar extensões para Visual Studio 2005 ou Visual Studio 2008, consulte

Pré-requisitos

Windows SharePoint Services 3.0

Visual Studio 2005

Etapa 1: Criar um assembly ASP.NET Web Part

Para criar uma Web Part, você iniciar criando um projeto de biblioteca de classes que deriva do classe base System.Web.UI.WebControls.WebParts.WebPart System.Web.UI.WebControls.WebParts.WebPart.

Para criar uma ASP.NET da Web Part Conjunto de Módulos (Assembly)

Iniciar Visual Studio 2005
No menu Arquivo , apontar para nova e, em seguida, clique Project .
In Project Types, under Visual Basic or C#, select Windows.
No painel de modelos, selecione da biblioteca de classes .
Tipo Sample.DisplayMessage como nome do projeto.

Etapa 2: Renomear a classe base e exigido adicionar espaços para nome

Depois de criar o projeto, um em branco arquivo classe é exibido. Você pode alteração nome classe do Class1 para identificar facilmente seu novo Web Part usar como padrão. Em um biblioteca de classes, apenas poucos espaços para nome são incluídos. Você deve adicionar exigido dois espaços para nome e referências aos seus conjuntos de módulos (assemblies). Você também deve derivar de classe base de System.Web.UI.WebControls.WebParts.WebPart.

Para adicionar espaço para nome referências e rebase a Web Part

Renomeie a classe usar como padrão selecionando Class1 na Gerenciador de Soluções, clique com o botão direito do mouse, clique Renomear e tipo DisplayMessageWebPart como nome de arquivo.
O menu do projeto, clique em Adicionar Referência .
No Add Reference diálogo na guia Net, selecione system.web clique e OK .

Na área de referências do arquivo de classe, adicionar uma referência ao System.Web.UI.WebControls.WebParts e rebase sua classe para herdar de WebPart, conforme o seguinte amostra de código.

                          using System;
using System.Collections.Generic;
using System.Text;
using System.Web;
using System.Web.UI.WebControls.WebParts;

namespace Sample.DisplayMessage
{
    public class DisplayMessageWebPart : WebPart
    {
    }
}

                          Imports System
Imports System.Collections.Generic
Imports System.Text
Imports System.Web
Imports System.Web.UI.WebControls.WebParts

Public Class DisplayMessage
    Inherits WebPart

End Class

Agora você criou uma estrutura básica para a Web Part.

Etapa 3: Adicionar uma propriedade Web Part User-customizable

Depois de configurar a nova classe para trabalhar como um Web Part, adicionar uma propriedade personalizável para o Web Part.

A propriedade Web Part determina o texto que é processado dentro da Web Part. Isso é personalizado on the basis of o individual usuário.

Observação

Para obter mais informações sobre personalização e individualização, consulte Web Parts personalização.

Para Web Parts baseia a ASP.NET Web Parts páginas classe base, as marcas que são usadas para as Propriedades personalizáveis são nomeado de maneira diferente de Web Parts que se baseiam o classe base Microsoft.SharePoint.WebPartPages.WebPart Microsoft.SharePoint.WebPartPages.WebPart. A seguinte lista descreve cada um dessas propriedades:

O WebBrowsableAttribute atributo classe garante que seu personalizado propriedade processa na edição painel ferramenta em Windows SharePoint Services.
O WebDescriptionAttribute atributo classe exibe uma dica de ferramenta para ajudar os usuários guia Quando edição seu personalizado propriedade.
O WebDisplayNameAttribute atributo classe mostra um nome para seu personalizado exibir propriedade.
O PersonalizableAttribute atributo classe determina se altera para seu personalizado propriedade afeta todos os usuários ou em um por-usuário base.

Para criar a propriedade Web Part

No arquivo DisplayMessageWebPart DisplayMessageWebPart, copiar e colar o seguinte codificar para criar uma propriedade personalizável básica.

                          private string customMessage = “Hello, world!”;

public string DisplayMessage
{
    get { return customMessage; }
    set { customMessage = value; }
}

                          Private customMessage As String = “Hello, world!”

Public Property DisplayMessage() as String
    Get
        Return customMessage
    End Get
    Set(ByVal value as String)
        customMessage = value
    End Set
End Property

Então, adicionar o seguinte marcas acima a declaração pública para permitir que as alterações em um por-usuário base:

                          [WebBrowsable(true),
WebDescription("Displays a custom message"),
WebDisplayName("Display Message"),
Personalizable(PersonalizationScope.User)]

                          <WebBrowsable(True), _
WebDescription("Displays a custom message"), _
WebDisplayName("Display Message"), _
Personalizable(PersonalizationScope.User)> _

Agora você criou uma propriedade Web Part personalizável.

Etapa 4: substituir o método de processamento e compilar a Web Part

Agora você deve adicionar funcionalidade para a Web Part. Por substituindo o Método Control.Render , você pode dizer a Web Part que operações para executar quando a página é visitada. Neste exemplo, a Web Part será processar o texto User-defined.

Para substituir o método de processamento e compilação de assembly

No arquivo DisplayMessageWebPart DisplayMessageWebPart, copiar e colar o seguinte codificar para substituir o Render de processamento.

                          protected override void Render(System.Web.UI.HtmlTextWriter writer)
{
    writer.Write(DisplayMessage);
}

                          Protected Overrides Sub Render(ByVal writer As System.Web.UI.HtmlTextWriter)
    writer.Write(DisplayMessage)
End Sub

Compile a solução. Agora você tem um assembly que contém o DisplayMessageWebPart Web Part.

Etapa 5: colocar o assembly no bin Diretório ou cache global de assemblies

Em um site do SharePoint, você pode implantar um assembly Web Part para um dos dois locais listados abaixo. Observe que a prática recomendada é implantar conjuntos para o Diretório bin.

bin Diretório ? O Diretório bin é uma pasta armazenada em sua raiz Diretório aplicativo da Web.bin directory For most installations, this is located in the %SYSTEMDRIVE%\inetpub\wwwroot\wss\VirtualDirectories\<port number>\bin directory, but if you need more information, see Como a: Localizar a raiz de aplicativo da Web .
Global Assembly Cache (GAC) ? The GAC permite conjuntos de módulos (assemblies) compartilhar entre diversos aplicativos. O GAC é automaticamente instalado com a estrutura .NET tempo de execução. Os componentes são geralmente instalados no Diretório %SYSTEMDRIVE%\WINDOWS\Assembly %SYSTEMDRIVE%\WINDOWS\Assembly.

Para obter mais informações sobre como escolher a localidade implantação correta, consulte Implantando Web Parts nos serviços SharePoint Windows.

Para o seguinte exemplo, o assembly no Diretório bin local.

Etapa 6: Adicionar a Web Part para a lista SafeControls

Windows SharePoint Services 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 que são específicos de 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.

Observação

O arquivo web.config web.config está localizado na pasta onde o diretório virtual para o site está localizado.This is normally c:\inetpub\wwwroot\wss\VirtualDirectories\<port number>\, 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 com 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:

Clique em iniciar , apontar para programas , apontar para Administrative Tools e clique Gerenciador Serviços de Informações da Internet (IIS).
Expanda o nó que é o nome do seu computador, e expansão o Web Sites item na árvore
Localize o site que está 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 adicionar sua Web Part para a lista SafeControls

Abra o arquivo web.config web.config na raiz de aplicativo.

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

                          <SafeControl Assembly="Sample.DisplayMessage, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" Namespace="Sample.DisplayMessage" Typename="DisplayMessageWebPart" Safe="True" />

Etapa 7: Adicionar a Web Part à galeria de Web Parts

Em ordem para adicionar a Web Part para uma página Web Part, você deve adicioná-lo para a galeria.

Para adicionar sua Web Part para a Web Part Gallery

Navegue até a página no seu site do SharePoint onde você desejar o Web Part ser acessível.
A página Web Part, clique em ações site e selecione definições do site .
A página Site Settings, clique em Web Parts sob o cabeçalho galeria.
Sobre a barra de ferramentas na Galeria de Web Part, clique nova .
Na lista de New Web Parts, verificar a caixa próximo para Sample.DisplayMessage.DisplayMessageWebPart clique e Preencher Galeria .
Sua Web Part agora pode ser adicionada a qualquer página Web Part.

Etapa 8: adicionar a Web Part a uma Página de Web Parts

Nesta etapa, você importação a Web Part para uma página em qualquer site do SharePoint e testar o personalizado propriedade você adicionou à Web Part. O seguinte procedimento explica as etapas para adicionar a Web Part para uma página e alterando o personalizado Display Message propriedade.

Para adicionar e testar sua Parte da Web

Navegue até a página no seu site do SharePoint Web Part onde você desejar para adicionar o Web Part.
A página Web Part, clique em ações site e selecione Editar Página .
Na zona de Web Part onde você desejar para adicionar o DisplayMessageWebPart , clique adicionar uma Web Part .
Sobre o diálogo Add Web Parts, a categoria diversos sob All Web Parts e verificar a caixa localizar próximo para DisplayMessageWebPart . Clique em adicionar.
Para modificar o texto exibido na Web Part, escolher Modificar Web Part compartilhada a partir de drop-down list de cromo.
No DisplayMessageWebPart Propriedades painel, expansão a categoria diversos e alteração de Display Message valor. Clique em aplicar.
Agora a Web Part está exibindo o valor dentro de Web Part User-defined.

Consulte também

Tarefas

Walkthrough: criando uma Web Part SharePoint básica

Compartilhar via

Walkthrough: Criando uma básica da Web Part

Pré-requisitos

Etapa 1: Criar um assembly ASP.NET Web Part

Para criar uma ASP.NET da Web Part Conjunto de Módulos (Assembly)

Etapa 2: Renomear a classe base e exigido adicionar espaços para nome

Para adicionar espaço para nome referências e rebase a Web Part

Etapa 3: Adicionar uma propriedade Web Part User-customizable

Para criar a propriedade Web Part

Etapa 4: substituir o método de processamento e compilar a Web Part

Para substituir o método de processamento e compilação de assembly

Etapa 5: colocar o assembly no bin Diretório ou cache global de assemblies

Etapa 6: Adicionar a Web Part para a lista SafeControls

Para adicionar sua Web Part para a lista SafeControls

Etapa 7: Adicionar a Web Part à galeria de Web Parts

Para adicionar sua Web Part para a Web Part Gallery

Etapa 8: adicionar a Web Part a uma Página de Web Parts

Para adicionar e testar sua Parte da Web

Consulte também

Tarefas

Recursos adicionais