开发 SharePoint WebParts

在 Web 部件中访问 SharePoint 数据

为了从 Web 部件中访问 SharePoint 数据，您需要执行两个步骤。第一步是引用 Microsoft.SharePoint.dll。您可以通过浏览到“[Program Files]\Common Files\Microsoft Shared\web server extensions\12\ISAPI”目录从 SharePoint 服务器获取此 DLL 的副本。

第二步是处理 Web 部件的代码访问安全性。最简单的方法是将目标 SharePoint 网站的信任级别设置为“完全”。这种信任级别通常在内部网环境中是可以接受的。如果您要求 SharePoint 网站在最低或中等信任级别环境中运行，那么您将需要手动配置您的代码访问安全性。

要选择更简单的方法，请将网站信任级别设置为“完全”，在您网站的 web.config 文件中找到以下内容

<trust level="WSS_Minimal" originUrl="" />

现在将其更改为

<trust level="Full" originUrl="" />

现在您可以编写一些代码来访问 SharePoint 数据。这仅仅是学习和理解 SharePoint API 的问题，它本身就值得撰写多篇文章。这里我展示了一个简单的 Web 部件，它显示当前登录用户的名字

using System.Web.UI.WebControls.WebParts;
using Microsoft.SharePoint;

namespace ExampleWebPartLibrary
{
    public class HelloUser : WebPart
    {
        protected override void Render(System.Web.UI.HtmlTextWriter writer)
        {
            // Get a contextual reference to the current SPWeb
            SPWeb currentWeb = SPContext.Current.Web;

            // Write a message to the current user
            writer.Write("Hello " + currentWeb.CurrentUser.LoginName);
        }
    }
}

SPContext.Current.Web 是访问 SharePoint 数据的起点。例如，您可以使用它来访问列表和文档库中的数据。

使用 SharePoint 设置来管理您的 Web 部件

Web 部件为了实用性，不可避免地需要设置。有两种方法可以在运行时为 Web 部件提供设置。在定制环境中，可以将设置放在 web.config 中，并以与标准 ASP.NET 应用程序相同的方式访问它们。但是，如果您要求用户能够轻松地自行配置和管理 Web 部件，那么您就需要使用 SharePoint API 为 Web 部件提供设置。如果您是独立软件供应商，正在发布您 Web 部件的打包版本，那么几乎肯定会是这种情况。

幸运的是，为 Web 部件启用设置功能相当容易。以下步骤假设您是从现有 Web 部件开始的，但如果您是从零开始，则可以跳到文章末尾的列表。

完整的代码列表如下

// using statements required for settings
using System;

using System.ComponentModel;
using System.Runtime.InteropServices;
using System.Xml.Serialization;

using Microsoft.SharePoint;
using Microsoft.SharePoint.WebPartPages;

namespace ExampleWebPartLibrary
{
    //Guid and XmlRoot attributes for a settings enabled web part
    [Guid("692b5ada-2f4c-45b0-b9a5-e718db958ae6")]
    [XmlRoot(Namespace = "ExampleWebPartLibrarySettingsDemo")]
    
    // NB inherit from SharePoint WebPart rather than ASP.NET Web Part
    public class SettingsDemo : Microsoft.SharePoint.WebPartPages.WebPart
    {
        private string mySetting;
        
        // SharePoint setting with required attributes
        [Browsable(true),
         Category("Example Web Parts"),
         DefaultValue("Default"),
         WebPartStorage(Storage.Shared),
         FriendlyName("MySetting"),
         Description("An example setting")]
        public string MySetting
        {
            get { return mySetting; }
            set { mySetting = value; }
        }
        
        
        // use the setting in code
        protected override void Render(System.Web.UI.HtmlTextWriter writer)
        {
            writer.Write("Value of MySetting: ");
            writer.Write(mySetting);
        }

    }
}

深入阅读

• MSDN 文章 ASP.NET Web 部件控件
• Web 部件开发人员入门指南
• Code Project: Web 部件生命周期
• Code Project: 用于在 SharePoint 2007 中嵌入 Flash 的 Web 部件