SharePoint - 功能和元素 - Gingerdoc 姜知笔记

笔记首页 >> sharepoint >> SharePoint – 功能和元素

SharePoint – 功能和元素

在本章中，我们将了解功能和元素。功能在某些方面是 SharePoint 中的组件模型。它们允许您定义功能的逻辑单元。

例如，您可能希望在站点内拥有能力 –

要创建具有特定架构的列表，
有一个页面将显示该列表中的数据，然后
在站点内的某处有一个链接或菜单选项以导航到该页面。

您可以创建一个功能，它定义功能的逻辑分组。功能的各个部分由元素定义。

所以会有一个元素 –

创建列表并设置架构。
将页面预配到您的 SharePoint 网站，以及
创建菜单选项或链接。

该功能定义了单元，然后元素定义了该单元内部的各个功能块。我们讨论了三种元素 –

用于创建列表的列表实例。
提供页面的模块。
创建菜单选项或链接的自定义操作。

但是，可以在 SharePoint 中创建许多其他类型的元素。另一个需要了解的关于功能的重要概念是激活和停用的概念。

例如，如果最终用户希望将上述功能添加到他的站点，他将激活相应的功能来创建列表、添加菜单选项或链接，并将页面提供到他们的站点。稍后他可以停用该功能以删除该功能。

请务必注意，在停用某个功能时，会自动删除某些元素。例如，SharePoint 会自动删除由自定义操作定义的菜单选项或链接。

其他的不会自动删除。因此，在我们的例子中，列表实例和页面不会被自动删除。

因此，作为开发人员，您需要了解哪些元素会被自动删除，哪些不会。如果您想删除那些不会自动删除的内容，您可以在功能接收器中编写代码。

让我们看看功能和元素的使用。我们将从最终用户的功能视图开始。

步骤 1 – 打开您的 SharePoint 网站。

SharePoint 网站

第 2 步– 要转到站点设置，您有两个链接可让您管理功能。

第一个链接管理站点功能位于站点操作下，它使您能够管理站点范围功能。
网站集管理下的其他链接网站集功能，它使您能够管理网站集范围功能。

管理站点功能

步骤 3 – 如果您单击这些链接中的任何一个，您将被带到一个页面，该页面显示当前活动和非活动功能。对于每个功能，您都可以选择激活或停用该功能。

网站特色

让我们通过创建一个新的 SharePoint 解决方案空项目来查看一个简单的示例。

第 1 步– 让我们将此称为FeaturesAndElements，然后单击确定。

功能和元素

步骤 2 – 指定要使用的站点并选择部署为场解决方案选项，然后单击完成。

部署为场解决方案

我们要创建的第一件事是特征。在解决方案资源管理器中，您可以看到一个 Features 文件夹，该文件夹当前为空。

功能文件夹

步骤 3 – 右键单击Features文件夹并选择Add Feature。它创建一个名为Feature1的功能，并打开功能设计器。默认标题是项目的标题，加上功能的标题。

添加功能

步骤 4 – 将特征从 Feature1 重命名为 Sample。

标题和描述是用户在激活和停用功能的页面中看到的内容。

将标题设置为示例功能，将描述设置为添加联系人列表，该页面用于查看列表。我们需要设置的另一件事是功能的作用域，也就是激活作用域。

它可以是农场、Web 应用程序、站点集合或站点。在这种情况下，我们将提供一个列表和一个页面。由于两者都位于 SharePoint 站点中，因此我们将在此处选择 Web。

示例功能

第 5 步– 让我们开始在我们的元素中添加功能。第一个元素是列表，我们将创建一个联系人列表。右键单击您的项目并选择添加 → 新项目…

步骤 6 – 在中间窗格中选择列表，然后在名称字段中输入联系人。单击添加。

选择列表

步骤 7 – 您将看到列表创建向导。根据联系人列表创建一个名为联系人的列表。单击完成以创建列表或至少创建元素，这将最终创建列表。

SharePoint 自定义向导

下面给出的是列表设计器的屏幕截图。

列表设计器

第 8 步– 这个设计器只是一个 XML 编辑器。打开联系人下的文件 Elements.xml 并添加以下数据。

<?xml version = "1.0" encoding = "utf-8"?>

<Elements xmlns = "http://schemas.microsoft.com/sharepoint/">
   <ListInstance Title = "Contacts" OnQuickLaunch = "TRUE" TemplateType = "105" 
      FeatureId = "00bfea71-7e6d-4186-9ba8-c047ac750105"
      Url = "Lists/Contacts" Description = "">
      <Data>
         <Rows>

            <Row>
               <Field Name = "ID">1</Field>
               <Field Name = "Last Name">Anders</Field>
               <Field Name = "First Name">Maria</Field>
               <Field Name = "Company">Alfreds Futerkiste</Field>
               <Field Name = "Business Phone">030-0074321</Field>
            </Row>

            <Row>
               <Field Name = "ID">2</Field>
               <Field Name = "Last Name">Hardy</Field>
               <Field Name = "First Name">Thomas</Field>
               <Field Name = "Company">Around the Horn</Field>
               <Field Name = "Business Phone">(171) 555-7788</Field>
            </Row>

            <Row>
               <Field Name = "ID">3</Field>
               <Field Name = "Last Name">Lebihan</Field>
               <Field Name = "First Name">Laurence</Field>
               <Field Name = "Company">Bon app'</Field>
               <Field Name = "Business Phone">91.24.45.40</Field>
            </Row>

            <Row>
               <Field Name = "ID">4</Field>
               <Field Name = "Last Name">Ashworth</Field>
               <Field Name = "First Name">Victoria</Field>
               <Field Name = "Company">B's Beverages</Field>
               <Field Name = "Business Phone">(171) 555-1212</Field>
            </Row>

            <Row>
               <Field Name = "ID">5</Field>
               <Field Name = "Last Name">Mendel</Field>
               <Field Name = "First Name">Roland</Field>
               <Field Name = "Company">Ernst Handel</Field>
               <Field Name = "Business Phone">7675-3425</Field>
            </Row>

         </Rows>
      </Data>
   </ListInstance>
</Elements>

请注意以下事项 –

在ListInstance元素中，我们有一个名为Data的元素，其中包含一些行。
ListInstance 将具有属性Contacts，无论我们是否在快速启动中显示。
我们想要一个基于联系人模板的列表。此处，TemplateType设置为105。这不是一个随机数，而是一个有意义的数字。
您可以在 SharePoint 中拥有的每种默认列表类型（例如公告列表、任务列表、联系人列表等）都有一个关联的编号。因此，如果将 105 更改为 107，您将获得不同类型的列表。
FeatureId是与联系人列表定义相关的指南。

第 9 步– 现在我们想要一个页面，显示此列表中的数据。右键单击您的项目并选择Add → New Item…在中间窗格中选择 Module，在 name 字段中输入 SitePage，然后单击Add。

您将看到一个名为SitePage的节点，它有两个文件，Elements.xml和Sample.txt文件。我们不想提供这个 sample.txt 文件，但我们想要提供一个 SitePage。

步骤 10 – 将文本文件重命名为Contacts.aspx并替换以下代码 –

<%@ Assembly Name = "Microsoft.SharePoint, Version = 14.0.0.0, Culture = neutral,
   PublicKeyToken = 71e9bce111e9429c" %>

<%@ Page MasterPageFile = "~masterurl/default.master"
   meta:progid = "SharePoint.WebPartPage.Document" %>

<%@ Register TagPrefix = "SharePoint"
   Namespace = "Microsoft.SharePoint.WebControls"
   Assembly = "Microsoft.SharePoint, Version = 14.0.0.0, Culture = neutral,
   PublicKeyToken = 71e9bce111e9429c" %>

<asp:Content ID = "Content2" runat = "server" ContentPlaceHolderID = "PlaceHolderMain">
   <SharePoint:SPDataSource runat = "server"
      ID = "ContactsDataSource" DataSourceMode = "List"
      UseInternalName = "false">
      <SelectParameters>
         <asp:Parameter Name = "ListName" DefaultValue = "Contacts" />
      </SelectParameters>
   </SharePoint:SPDataSource>
   
   <SharePoint:SPGridView runat = "server"
      ID = "ContactsGridView" DataSourceID = "ContactsDataSource"
      AutoGenerateColumns = "false" RowStyle-BackColor = "#DDDDDD"
      AlternatingRowStyle-BackColor = "#EEEEEE">
      <Columns>
         <asp:BoundField HeaderText = "Company"
            HeaderStyle-HorizontalAlign = "Left" DataField = "Company" />
         <asp:BoundField HeaderText = "First Name"
            HeaderStyle-HorizontalAlign = "Left" DataField = "First Name" />
         <asp:BoundField HeaderText = "Last Name"
            HeaderStyle-HorizontalAlign = "Left" DataField = "Last Name" />
         <asp:BoundField HeaderText = "Phone"
            HeaderStyle-HorizontalAlign = "Left" DataField = "Business Phone" />
      </Columns>
   </SharePoint:SPGridView>
</asp:Content>

<asp:Content ID = "PageTitle" ContentPlaceHolderID = "PlaceHolderPageTitle"
   runat = "server">
   Contacts
</asp:Content>

<asp:Content ID = "PageTitleInTitleArea"
   ContentPlaceHolderID = "PlaceHolderPageTitleInTitleArea" runat = "server" >
   Contacts
</asp:Content>

SitePage 有一个SP.DataSource文件，我们将使用它来制作联系人列表数据，我们可以在我们的页面中绑定到该数据。该SP.GridView将显示联系人信息。

那是我们的 SitePage，现在让我们看看 Feature。

网站页面

请注意，在Feature中的Items 中，我们的 SitePage 上的 Contacts list 实例和 Module 配置已添加为元素。

Visual Studio 了解元素本身不能做任何事情。元素需要成为功能的一部分。因此，当您添加元素时，您需要将其添加到功能中。

步骤 11 – 转到您的项目并右键单击，然后选择添加 → 新项目…

这里我们要添加一个CustomAction，所以在中间窗格中选择Empty Element，调用这个Action，然后单击Add。

自定义操作

如果您返回到您的 Feature，您可以看到该元素现已添加到 Feature，如下面的屏幕截图所示。

新增功能

第 12 步– 回到Action 下的Elements.xml并替换以下代码 –

<?xml version = "1.0" encoding = "utf-8"?>

<Elements xmlns = "http://schemas.microsoft.com/sharepoint/">
   <CustomAction
      Id = "SiteActionsToolbar"
      GroupId = "SiteActions"
      Location = "Microsoft.SharePoint.StandardMenu"
      Sequence = "100"
      Title = "Contacts"
      Description = "A page showing some sample data">
      <UrlAction Url = "~site/SitePages/Contacts.aspx"/>
   </CustomAction>
</Elements>

现在，如果要添加链接或菜单选项，则需要定义要添加它的位置，它是定义它们的 Location 和 GroupId 的组合。此值组合表示应将菜单选项添加到 SiteActions 菜单。

还有许多其他值组合，用于在我们的 SharePoint 网站内的其他位置添加链接或菜单。当您想在 SharePoint 中的某处添加菜单选项时，您必须研究此内容才能找出所需的正确值组合。

步骤 13 – 双击Feature，您将看到 Feature 设计器。Feature Designer 是 Feature Manifest 的一个花哨的编辑器，它是一个 XML 文档。

要点 –

该功能定义了元素的逻辑分组。在这里，我们的 Feature 指的是我们刚刚创建的三个 Element 清单。
当您激活该功能时，SharePoint 将查看单个元素清单并将列表、页面和链接添加到我们的 SharePoint 网站中。
使用 Visual Studio 进行部署时，它会自动激活项目中的任何功能。由于我们想要完成激活功能的过程，我们将告诉 Visual Studio 不要这样做。

步骤 14 – 通过转到 SharePoint 选项卡转到项目属性。将部署配置更改为No Activation。

没有激活