Como desenvolver uma definição de lista e um receptor de evento no Visual Studio 2010 Laboratório prático Manual do laboratório SPCHOL300 SPCHOL300 Como compilar uma definição de lista e um receptor de eventos C#
Este documento é fornecido no estado em que se encontra. As informações e exibições expressas neste documento, incluindo URLs e outras referências a sites da Internet, podem ser alteradas sem aviso prévio. Você assume o risco de usá-lo. Este documento não oferece a você quaisquer direitos legais sobre propriedade intelectual em qualquer produto da Microsoft. Este documento pode ser copiado e usado para fins internos e de referência. 2010 Microsoft. Todos os direitos reservados.
Sumário COMO DESENVOLVER UMA DEFINIÇÃO DE LISTA E UM RECEPTOR DE EVENTO NO VISUAL STUDIO 20102 Objetivo do laboratório... 2 Recursos adicionais... 2 Guia de Introdução... 2 Como fazer logon na máquina virtual... 2 Locais... 2 Pré-requisitos para o laboratório... 3 Como copiar os exemplos de código do documento do Word... 3 Trechos de código... 4 Exercício 1 Criar um projeto de definição de lista do SharePoint com Instância de lista... 5 Tarefa 1 Criar um projeto de definição de lista do SharePoint... 5 Tarefa 2 Personalizar a definição de lista do SharePoint e a instância de lista... 8 Tarefa 3 Adicionar um Receptor de eventos... 20 Exercício 2 Como usar o Painel de Desenvolvimento para revisar o desempenho do receptor de eventos... 26 Tarefa 1 Habilitar o Painel de Desenvolvimento... 26 Tarefa 2 Como usar o Painel de Desenvolvimento... 28 Resumo do laboratório... 29 Página 1
Como desenvolver uma definição de lista e um receptor de evento no Visual Studio 2010 Tempo estimado para conclusão deste laboratório: 30 minutos Objetivo do laboratório Este laboratório demonstra como criar uma Definição de lista com uma Instância de lista correspondente e como anexar um receptor de eventos à lista, a fim de executar algumas tarefas. Os objetivos deste laboratório são aprender como compilar Definições de lista, Instâncias de lista e Receptores de evento, usando o Visual Studio 2010, e como usar o Painel de Desenvolvimento no SharePoint 2010. Criar um Projeto de definição de lista do SharePoint com Instância de lista Personalizar a Definição de lista do SharePoint e a Instância de lista Adicionar um Receptor de eventos Habilitar o Painel de Desenvolvimento Usar o Painel de Desenvolvimento Recursos adicionais Este laboratório inclui os seguintes recursos adicionais: Todos os recursos estão no diretório \Supporting Files\SPCHOL300\Resources\CS Este manual do laboratório SPCHOL300_Manual_CS.docx Este documento Código-fonte \Completed\CS\Ex1\End.sln Código-fonte completo do laboratório. Recursos \Resources\CS\Ex1 Diversos recursos usados em todo este laboratório. Guia de Introdução Como fazer logon na máquina virtual Faça logon na máquina virtual como o seguinte usuário: Nome de usuário: Administrador Senha: pass@word1 Locais Este Laboratório prático contém diversos recursos em locais fixos. Por padrão, supõe-se que o diretório HOL base seja C:\Content Packs\Packs\SharePoint 2010 Developer Labs 1.0\SUPPORTING FILES\SPCHOL300\Resources. A pasta de trabalho padrão para este laboratório é C:\SPHOLS\SPCHOL300. Página 2
Pré-requisitos para o laboratório Navegue até o diretório HOL base Supporting Files\SPCHOL300\Resources e execute o script do PowerShell optimize.ps1: 1. Clique com o botão direito do mouse em optimize.ps1 e selecione Executar com o PowerShell: Figura 1 - Executar o script do PowerShell 2. Isso abrirá uma janela do PowerShell para executar o script. Aguarde até a conclusão do script do PowerShell e o fechamento da janela do PowerShell: Figura 2 - Janela do PowerShell executando o script Como copiar os exemplos de código do documento do Word Copiar e colar o código desse documento do Word para o Visual Studio é seguro apenas para as seções de código formatado, por exemplo: Console.WriteLine("Este código é seguro!"); Página 3
O código que não estiver nessas seções poderá conter Unicode ou outros caracteres invisíveis que não são códigos XML ou C#/VB válidos, por exemplo: Console.WriteLine( Este código NÃO é seguro! ); Trechos de código Também é possível usar os trechos de código para inserir o código apropriado no laboratório. Para usar o trecho de código necessário para este laboratório: Clique com o botão direito do mouse no arquivo de código no qual você deseja inserir o trecho de código. Selecione Inserir Trecho: Figura 3 - Menu de contexto do código do Visual Studio. Selecione os trechos de código da galeria Meus Trechos de Código. Página 4
Exercício 1 Criar um projeto de definição de lista do SharePoint com Instância de lista Tarefa 1 Criar um projeto de definição de lista do SharePoint Esta tarefa o orientará pela criação da solução do Visual Studio 2010 usando o modelo de projeto do SharePoint 2010 para uma Definição de lista. 1. Abra o Visual Studio 2010 em Menu Iniciar Todos os Programas Microsoft Visual Studio 2010 Microsoft Visual Studio 2010. 2. No menu do Visual Studio 2010, selecione Arquivo Novo Projeto... 3. Selecione o modelo de projeto Visual C# SharePoint 2010 Definição de Lista. 4. Insira Bugs na caixa de texto Nome. 5. Insira C:\SPHOLS\SPCHOL300\CS\Ex1\ na caixa de texto Local. Figura 4 - Caixa de diálogo Novo Projeto 6. Clique em OK. Página 5
7. No SharePoint Customization Wizard: 8. Insira http://intranet.contoso.com/ para o site local. Figura 5 - Etapa 1 do SharePoint Customization Wizard. 9. Defina o nível de confiança como Deploy as a farm solution. 10. Clique em Avançar. 11. Insira Bugs na caixa de texto What is the display name of the list definition?. 12. Selecione Custom list na caixa suspensa What is the type of the list definition?. Página 6
13. Marque Add a list instance for this list definition.. Figura 6 - Etapa 2 do SharePoint Customization Wizard. 14. Clique em Concluir. Página 7
Tarefa 2 Personalizar a definição de lista do SharePoint e a instância de lista Esta tarefa o orientará pela personalização do modelo de projeto de Definição de lista alterando o nome da lista, o tipo de conteúdo que ela armazena e os campos exibidos nos formulários, novos, de edição e de exibição. 1. No Gerenciador de Soluções, expanda ListInstance1 e abra o arquivo Elements.xml. Figura 7 - Gerenciador de Soluções destacando Elements.xml 2. No elemento ListInstance, mude o atributo Título para Bugs e mude o atributo TemplateType para 10001. Figura 8 - Arquivo Elements.xml após a edição de Título e TemplateType Página 8
3. No Gerenciador de Soluções, abra o Elements.xml. Figura 9 - Gerenciador de Soluções destacando Elements.xml 4. No elemento ListTemplate, altere o atributo Type para 10001 e adicione o atributo DisallowContentTypes= FALSE, como mostrado. DisallowContentTypes="FALSE" Figura 10 - Arquivo Elements.xml após a edição de Type e a adição do atributo DisallowContentTypes Página 9
5. Insira o seguinte xml na parte superior do elemento Elements no arquivo Elements.xml. Este XML descreve o tipo de conteúdo Item de bug armazenado pela lista. Trecho de código: Meus Trechos de Xml spchol300_ex1_contenttype <!-- Start Add as part of SPCHOL300 Ex1 --> <ContentType ID="0x010089E3E6DB8C9B4B3FBB980447E313CE94" Name="Bug Item" Group="Custom Content Types" Description="Bug item content type." Version="0"> <FieldRefs> <FieldRef ID="{fa564e0f-0c70-4ab9-b863-0177e6ddd247}" /> <FieldRef ID="{cb55bba1-81a9-47b6-8e6c-6a7da1d25602}" /> <FieldRef ID="{0248c82f-9136-4b3a-b802-d0b77280b3bc}" /> <FieldRef ID="{aa4a82dd-5b32-4507-9874-4e1c7bca3279}" /> </FieldRefs> </ContentType> <!-- End Add as part of SPCHOL300 Ex1 --> 6. Insira o seguinte xml na parte superior do elemento Elements no arquivo Elements.xml. Este XML descreve os Campos usados pelo tipo de conteúdo Item de bug. Trecho de código: Meus Trechos de Xml spchol300_ex1_fields <!-- Start Add as part of SPCHOL300 Ex1 --> <Field Type="Note" DisplayName="Description" Required="FALSE" NumLines="6" RichText="FALSE" Sortable="FALSE" ID="{cb55bba1-81a9-47b6-8e6c-6a7da1d25602}" StaticName="BugDescription" Name="BugDescription" Group="Custom Columns" /> <Field Type="Text" DisplayName="Project" Required="FALSE" MaxLength="255" ID="{0248c82f-9136-4b3ab802-d0b77280b3bc}" StaticName="BugProject" Name="BugProject" Group="Custom Columns" /> <Field Type="Text" DisplayName="Assigned To" Required="FALSE" MaxLength="255" ID="{aa4a82dd-5b32-4507-9874-4e1c7bca3279}" StaticName="BugAssignedTo" Name="BugAssignedTo" Group="Custom Columns" /> <!-- End Add as part of SPCHOL300 Ex1 --> Página 10
7. O arquivo Elements.xml deve parecer com o seguinte. Figura 11 - Arquivo Elements.xml após a inserção de dois trechos de código. Página 11
8. No Gerenciador de Soluções, abra Schema.xml Figura 12 - Gerenciador de Soluções destacando Schema.xml 9. Adicione o atributo EnableContentTypes= TRUE ao elemento List dentro do arquivo Schema.xml. EnableContentTypes="TRUE" Figura 13 - Schema.xml após a adição do atributo EnableContentTypes 10. Insira o seguinte XML no elemento ContentTypes no arquivo schema.xml. Este XML descreve o tipo de conteúdo Item de bug armazenado por essa lista. Trecho de código: Meus Trechos de Xml spchol300_ex1_contenttyprefs <!-- Start Add as part of SPCHOL300 Ex1 --> <ContentTypeRef ID="0x010089E3E6DB8C9B4B3FBB980447E313CE94" /> <!-- End Add as part of SPCHOL300 Ex1 --> Página 12
Figura 14 - Schema.xml após a inserção do trecho ContentTypeRefs 11. Insira o seguinte XML no elemento Fields. Este XML descreve os campos armazenados pela lista. Eles estão diretamente relacionados aos campos no Tipo de conteúdo adicionado na etapa anterior. Trecho de código: Meus Trechos de Xml spchol300_ex1_fields <!-- Start Add as part of SPCHOL300 Ex1 --> <Field Type="Note" DisplayName="Description" Required="FALSE" NumLines="6" RichText="FALSE" Sortable="FALSE" ID="{cb55bba1-81a9-47b6-8e6c-6a7da1d25602}" StaticName="BugDescription" Name="BugDescription" Group="Custom Columns" /> <Field Type="Text" DisplayName="Project" Required="FALSE" MaxLength="255" ID="{0248c82f-9136-4b3ab802-d0b77280b3bc}" StaticName="BugProject" Name="BugProject" Group="Custom Columns" /> <Field Type="Text" DisplayName="Assigned To" Required="FALSE" MaxLength="255" ID="{aa4a82dd-5b32-4507-9874-4e1c7bca3279}" StaticName="BugAssignedTo" Name="BugAssignedTo" Group="Custom Columns" /> <!-- End Add as part of SPCHOL300 Ex1 --> Figura 15 - Schema.xml após a inserção de xml em Fields Página 13
12. Insira o seguinte XML no elemento ViewFields na 2 ª exibição, BaseViewID="1". Este XML descreve quais campos devem ficar visíveis nesta exibição específica. BaseView 1 é definido como a exibição padrão, e esta é a exibição na qual os campos recém-criados deverão aparecer. Trecho de código: Meus Trechos de Xml spchol300_ex1_fieldrefs <!-- Start Add as part of SPCHOL300 Ex1 --> <FieldRef Name="BugDescription"></FieldRef> <FieldRef Name="BugProject"></FieldRef> <FieldRef Name="BugAssignedTo"></FieldRef> <!-- End Add as part of SPCHOL300 Ex1 --> Figura 16 - Schema.xml após a inserção de XML em Fields 13. No menu, selecione Compilar Implantar Bugs. Página 14
14. Abra http://intranet.contoso.com em uma sessão do navegador. Em Listas, na navegação do lado esquerdo, clique em Bugs. Figura 17 - Link para lista de bugs no painel de navegação esquerdo Página 15
15. Essa é a lista de Bugs baseada na Definição de lista. Figura 18 - Painel da lista Página 16
16. Para adicionar um item, clique em Itens. Figura 19 - Guias do painel Ferramentas de Lista Página 17
17. Clique em Novo Item com a seta para baixo ao lado e selecione Bug Item. Figura 20 - Botão Novo Item Página 18
18. Insira Bug01 na caixa de texto Título. 19. Insira Who is going to track this bug? Na caixa de texto Description 20. Insira Writing developer articles na caixa de texto Project. 21. Clique em Salvar. Figura 21 - Caixa de diálogo Novo Item 22. Você personalizou com êxito a Definição de lista e a Instância de lista. Página 19
Tarefa 3 Adicionar um Receptor de eventos Esta tarefa o orientará pela criação e anexação de um Receptor de eventos à Definição de lista criada na etapa anterior. Este receptor de eventos impedirá a exclusão de itens de bug e a automatização do preenchimento do campo Atribuído a. 1. No Visual Studio 2010, clique com o botão direito do mouse no projeto Bugs e na cascata suspensa selecione Adicionar Novo Item. 2. Selecione o tipo de projeto Visual C# SharePoint 2010 Event Receiver. 3. Insira BugListItemEvent na caixa de texto Nome. Figura 22 - Caixa de diálogo Adicionar Novo Item 4. Clique em Adicionar. Página 20
5. No SharePoint Customization Wizard, marque os três eventos abaixo: An item is being added An item is being updated An item is being deleted Figura 23 - Caixa de diálogo Inserir configurações do Receptor de evento 6. Clique em Concluir. Página 21
7. No Gerenciador de Soluções, expanda BugListItemEvent e abra o arquivo Elements.xml. Figura 24 - Gerenciador de Soluções destacando Elements.xml 8. Para se certificar de que os receptores de evento se associam apenas à nossa lista personalizada, verifique se o ListTemplateId no elemento Receivers corresponde ao tipo de nossa lista. Se não corresponder, mude o atributo ListTemplateId para 10001. Figura 25 - Arquivo Elements.xml com ListTemplateId atualizado 9. No Gerenciador de Soluções, expanda BugListItemEvent e abra o arquivo BugListItemEvent.cs. Lá você deverá ver os três métodos de substituição marcados acima. Figura 26 - Gerenciador de Soluções destacando BugListItemEvent.cs Página 22
10. Insira o seguinte código no corpo de public override void ItemDeleting(SPItemEventProperties properties) após base.itemdeleting(properties);. Este código impedirá a exclusão de um item e apresentará ao usuário uma mensagem de erro quando ele tentar a exclusão. Trecho de código: Meus Trechos de Código spchol300_ex1_deleting try { properties.cancel = true; properties.errormessage = "Bugs can only be resolved not deleted!"; } catch (Exception ex) { //ToLog ex return; } finally { this.eventfiringenabled = true; } 11. Insira o seguinte código no corpo de public override void ItemAdding(SPItemEventProperties properties) após base.itemadding(properties);. Este código tentará resolver o campo Atribuído a analisando o Título do projeto na lista de projetos e mapeando a Pessoa de Contato da lista de projetos para o campo Atribuído a. Trecho de código: Meus Trechos de Código spchol300_ex1_adding try { this.eventfiringenabled = false; AutoAssign(properties); } catch (Exception ex) { //ToLog ex return; } finally { this.eventfiringenabled = true; } Página 23
12. Insira o seguinte código no corpo de public override void ItemUpdating(SPItemEventProperties properties) após base.itemupdating(properties);. Este código tentará resolver o campo Atribuído a analisando o Título do projeto na lista de projetos e mapeando a Pessoa de Contato da lista de projetos para o campo Atribuído a. a Trecho de código: Meus Trechos de Código spchol300_ex1_updating try { this.eventfiringenabled = false; AutoAssign(properties); } catch (Exception ex) { //ToLog ex return; } finally { this.eventfiringenabled = true; } 13. Insira o seguinte método no corpo da classe BugListItemEvent. Esse é o código usado por ItemAdding e ItemUpdating. Trecho de código: Meus Trechos de Código spchol300_ex1_autoassign private static void AutoAssign(SPItemEventProperties properties) { string projectname = properties.afterproperties["bugproject"].tostring(); SPList projectlist = properties.web.getlist("lists/projects"); foreach (SPListItem item in projectlist.items) { if (item.title.tolower().contains(projectname.tolower())) { string contact = item["primary Contact"].ToString(); if (contact.contains(";#")) { contact = contact.split('#')[1]; } properties.afterproperties["bugassignedto"] = contact; break; } } } 14. No menu, selecione Compilar Implantar Bugs. Página 24
15. Essa será a terceira vez que implantamos essa solução e, como estamos trabalhando com uma Instância de lista, teremos um Deployment Conflicts. Figura 27 - Caixa de diálogo Deployment Conflicts 16. O Visual Studio pode resolver esse conflito automaticamente. Nesse caso, ele excluirá e recriará a lista. Clique em Resolve Automatically. 17. Abra http://intranet.contoso.com em uma sessão do navegador. Clique no link Bugs em Listas no painel de navegação esquerdo. Figura 28 - Link para lista de bugs 18. Agora, você pode testar os três receptores de evento que adicionamos. Tente adicionar, atualizar e excluir itens. (Observe que se você tentar excluir um item, receberá uma caixa de diálogo de exceção e que é o comportamento esperado.) Página 25
Exercício 2 Como usar o Painel de Desenvolvimento para revisar o desempenho do receptor de eventos Tarefa 1 Habilitar o Painel de Desenvolvimento Esta tarefa mostrará como habilitar o painel de ferramentas de desenvolvimento por meio do prompt de comando, usando o stsadm.exe. 1. Para habilitar a barra de ferramentas de desenvolvimento, acesse Iniciar Executar. Digite cmd e clique em OK. 2. Figura 29 - Caixa de diálogo Executar 3. Digite C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\BIN\stsadm.exe -o setproperty -pn developer-dashboard -pv OnDemand "C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\BIN\stsadm.exe" -o setproperty -pn developer-dashboard -pv OnDemand 4. Pressione Enter. Página 26
Figura 30 - Janela do terminal após a execução de stsadm.exe 5. Isso habilitou o Painel de Desenvolvimento. 6. Digite iisreset e pressione Enter. Figura 31 - Janela do terminal após a execução de iisreset Página 27
Tarefa 2 Como usar o Painel de Desenvolvimento Esta tarefa demonstrará como ativar e desativar a exibição do Painel de Desenvolvimento e indicará alguns recursos interessantes. 1. Se você acabou de completar o Exercício 1, vá até a Etapa 4, caso contrário, abra a solução Exercício 1 Final, conforme descrito nas Etapas 2 e 3. 2. No menu, selecione Compilar Implantar Bugs. Figura 32 - Caixa de diálogo Deployment Conflicts 3. O Visual Studio pode resolver esse conflito automaticamente. Nesse caso, ele excluirá e recriará a lista. Clique em Resolve Automatically. 4. Abra http://intranet.contoso.com em uma sessão do navegador. Clique no link Bugs em Listas no painel de navegação esquerdo. Figura 33 - Link para lista de bugs Página 28
5. No navegador, ative o Painel de Navegação clicando no ícone no canto superior direito da janela do navegador. Figura 34 - Ícone Painel de Navegação 6. Isso atualizará o navegador e exibirá a barra de ferramentas na parte inferior da página. Figura 35 - Painel de Desenvolvimento 7. Entre as informações importantes exibidas no Painel de Desenvolvimento estão: As consultas de SQL realizadas e seus horários. Deslocamentos de eventos da WebPart para teste de desempenho com base em Web Parts personalizadas. Resumo do laboratório Neste laboratório, você realizou os seguintes exercícios. Criou um Projeto de definição de lista do SharePoint com Instância de lista. Personalizou a Definição de lista do SharePoint e a Instância de lista. Adicionou um Receptor de eventos. Habilitou o Painel de Desenvolvimento. Usou o Painel de Desenvolvimento. Página 29