Elemento módulo (Site)

Artigo
04/08/2023

Aplica-se a: SharePoint 2016 | SharePoint Foundation 2013 | | do SharePoint Online SharePoint Server 2013

Especifica arquivos e web parts "todos os usuários" com os quais provisionar um site.

<Module>
  HyperlinkBaseUrl = "Text"
  IncludeFolders = "Text"
  List = "Integer"
  Name = "Text"
  Path = "Text"
  RootWebOnly = "TRUE" | "FALSE"
  SetupPath = "Text"
  Url = "Text"
</Module>

Elementos e atributos

As seções a seguir descrevem os atributos, os elementos filhos e os elementos pai.

Atributos

Atributo	Descrição
HyperlinkBaseUrl	Texto opcional.
Includefolders	Texto opcional.
List	Inteiro opcional. Especifica o tipo de lista, que é definido dentro deOnet.xml.
Nome	Texto obrigatório. Contém o nome do conjunto de arquivos. Só pode conter os seguintes caracteres: Alfanumérico hifen (-) sublinhado (_) período (.) espaço ( )
Path	Texto opcional. Especifica o caminho físico para o conjunto de arquivos em relação a %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\SiteTemplates\ _Site_Definition_. Só pode conter os seguintes caracteres: Alfanumérico hifen (-) sublinhado (_) período (.) espaço ( )
RootWebOnly	Booliano opcional. TRUE se os arquivos especificados no módulo forem instalados apenas no site de nível superior da coleção de sites.
SetupPath	Texto opcional. Especifica o caminho físico para uma pasta no diretório de instalação do SharePoint Foundation %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE) que contém um arquivo a ser incluído no módulo. Só pode conter os seguintes caracteres: Alfanumérico hifen (-) sublinhado (_) período (.) espaço ( )
Url	Texto opcional. Especifica o caminho virtual da pasta na qual colocar os arquivos quando um site é instanciado. Se Path não for especificado, o valor da Url será usado para o caminho físico. Use o atributo Url para provisionar uma pasta por meio da definição do site. O atributo Url não pode conter os seguintes caracteres: " # % & * : < > ? \ { } \| ~ \x7f

Elementos filho

Arquivo

Elementos pai

Modules

Occurrences

Mínimo: 0
Máximo: Desvinculado

Comentários

Um elemento módulo detalhado aparece em um elemento Modules diretamente no elemento Project de um Onet.xml arquivo. Cada módulo desse tipo é referenciado por pelo menos um outro elemento Module que está em um elemento Configuration do mesmo arquivo.

O elemento Módulo especifica um arquivo ou coleção de arquivos e um local em que os arquivos são instalados durante a criação do site. Se o arquivo for uma página da Web Part, a definição do módulo poderá especificar quais web parts devem ser incluídas na página.

Exemplo

O exemplo a seguir de Onet.xml define as exibições e os arquivos a serem incluídos em um módulo.

<Module Name="Default" Url="" Path="">
  <File Url="default.aspx" NavBarHome="True">
    <View List="$Resources:core,lists_Folder;/$Resources:core,announce_Folder;" BaseViewID="0" WebPartZoneID="Left" />
    <View List="$Resources:core,lists_Folder;/$Resources:core,calendar_Folder;" BaseViewID="0" RecurrenceRowset="TRUE" WebPartZoneID="Left" WebPartOrder="2" />
    <AllUsersWebPart WebPartZoneID="Right" WebPartOrder="1"><![CDATA[
      <WebPart xmlns="http://schemas.microsoft.com/WebPart/v2" xmlns:iwp="http://schemas.microsoft.com/WebPart/v2/Image">
        <Assembly>Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c</Assembly>
        <TypeName>Microsoft.SharePoint.WebPartPages.ImageWebPart
        </TypeName>
        <FrameType>None</FrameType>
        <Title>$Resources:wp_SiteImage;</Title>
                        <iwp:ImageLink>/_layouts/images/homepage.gif</iwp:ImageLink>
      </WebPart>
    ]]></AllUsersWebPart>
    <View List="$Resources:core,lists_Folder;/$Resources:core,links_Folder;" BaseViewID="0" WebPartZoneID="Right" WebPartOrder="2" />
    <NavBarPage Name="$Resources:core,nav_Home;" ID="1002" Position="Start" />
    <NavBarPage Name="$Resources:core,nav_Home;" ID="0" Position="Start" />
  </File>
</Module>

Confira também

Como provisionar um arquivo

Compartilhar via