Compartilhar via

Usar módulos para incluir arquivos na solução

  • Artigo

Pode haver ocasiões em que você queira implantar arquivos no servidor do SharePoint independentemente do tipo de arquivo, como novas páginas mestras. Para fazer isso, você pode usar Módulos (não confundir com módulos de código do Visual Basic). Módulos são contêineres para arquivos em uma solução do SharePoint. Quando a solução é implantada, os arquivos no módulo são copiados para as pastas especificadas no servidor do SharePoint.

Elementos e itens de módulo

Para criar um módulo, adicione-o a um projeto escolhendo-o na caixa de diálogo Adicionar Novo Item. Em seguida, modifique o arquivo Elements.xml para incluir os nomes dos arquivos que você deseja implantar, onde eles estão localizados no sistema e onde devem ser copiados no servidor do SharePoint.

Este é um exemplo do arquivo Elements.xml para um módulo:

<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="http://schemas.microsoft.com/sharepoint/">
    <Module Name="Module1">
        <File Path="Module1\Sample.txt" Url="Module1/Sample.txt" />
    </Module>
</Elements>

Módulos recém-criados contêm os seguintes arquivos padrão:

Nome do Arquivo Descrição
Elements.xml O arquivo de definição do módulo.
Sample.txt Um arquivo de espaço reservado que serve como exemplo de um arquivo no módulo.

O arquivo Elements.xml contém os seguintes elementos:

Nome do elemento Descrição
Elementos Contém todos os elementos definidos no módulo.
Módulo O elemento de módulo tem apenas um atributo, Nome, que especifica o nome do módulo no formato <Module Name="Module1">.

Observe que, se você alterar o nome do módulo (ou sua propriedade Nome da Pasta), precisará atualizar manualmente o nome no elemento Módulo.

Se você especificar um subdiretório para os arquivos no elemento Módulo, o WSS (Windows SharePoint Services) criará automaticamente uma estrutura de diretório correspondente para eles.
Arquivo O elemento Arquivo tem dois parâmetros, Caminho e URL.

– Caminho: o nome e o local do arquivo na solução do SharePoint. O formato é Path="Module1\Sample.txt".

– URL: o local onde o arquivo será implantado no servidor do SharePoint. O formato é Url="Module1/Sample.txt".

– Tipo: um atributo opcional que tem duas configurações: GhostableInLibrary e Ghostable. O formato é Type="GhostableInLibrary". Especificar GhostableInLibrary significa que o arquivo será adicionado a uma biblioteca de documentos no SharePoint junto com um item de lista para acompanhar o arquivo quando ele for adicionado à biblioteca. Especificar Ghostable faz com que o arquivo seja adicionado ao SharePoint fora da biblioteca de documentos.

Cada arquivo que você deseja implantar requer uma entrada de elemento <File> separada em Elements.xml.

Confira também