SharePoint WebPart 用户控件包装器 Hands-On Labs

SharePoint WebPart 用户控件包装器Hands-On LabsLab0：安装部署用户控件包装器1、介绍什么是用户控件包装器？用户控件包装器是一个能够帮助SharePoint开发人员制作SharePoint WebPart开发的工具。

它能够直接使普通的用户控件（User Control）成为能够使用于SharePoint Portal Server 2003和Windows SharePoint Services 2.0之中的WebPart，而同时又不会丧失WebPart所带来的良好功能。

对于SharePoint开发人员而言，用户控件包装器能够带来下列好处：●不必要了解SharePoint WebPart的原理和开发方法，就能直接通过制作用户控件的方法来制作SharePoint WebPart；●使开发WebPart变得可视化，大大简化了复杂界面WebPart的开发难度；●可以直接利用大量现成已经做好的用户控件，直接将它们当做WebPart用于SharePoint页面中；●用户控件包装器使用户控件同样具备WebPart自定义属性和WebPart连接等功能，不会因为使用了用户控件包装器而丧失某些重要的WebPart功能。

2、下载请在/workspaces/workspace.aspx?id=85aefa87-fb76-4b32-ab12-31a4e64787 8a页面直接下载最新版本的用户控件包装器。

下载后，将文件解压缩，里面的“UserControlWrapperPart.cab”文件即是用户控件包装器的安装文件。

3、安装将“UserControlWrapperPart.cab”拷贝到SharePoint服务器的“C:\Program Files\Common Files\Microsoft Shared\web server extensions\60\BIN”文件夹中（假设C:是系统盘），这个文件夹中应该已经存在“STSADM.EXE”文件。

打开SharePoint服务器上的命令提示符界面，通过“CD”指令将当前目录设置为“C:\Program Files\Common Files\Microsoft Shared\web server extensions\60\BIN”文件夹，然后在命令提示符中执行下面的命令：stsadm –o addwppack –filename UserControlWrapperPart.cab如果指令执行成功，那么屏幕上会提示：usercontrolwrapperpart.cab：部署到“SharePoint门户路径”。

操作成功完成。

打开SharePoint门户对应磁盘目录的“bin”子目录（如果是在默认网站上创建的SharePoint 门户，那么对应的磁盘目录应该就是“C:\InetPub\wwwroot\bin”），如果用户控件包装器已经被成功安装，那么“bin”目录中应该会多一个名称为“erControlWrapperPart.dll”的文件。

4、配置打开SharePoint门户对应磁盘目录中的“web.config”文件（如果是在默认站点上创建的SharePoint门户，那么对应的磁盘目录应该就是“C:\InetPub\wwwroot”），将其中的：<trust level="WSS_Minimal" originUrl="" />修改为：<trust level="Full" originUrl="" />Lab1：将用户控件包装成WebPart部署到SharePoint页面上1、目的此Lab的目的是让读者了解如何将一个普通的用户控件包装成SharePoint WebPart。

首先，我们会创建一个 Web应用程序项目，然后在此项目中创建一个用户控件，然后，通过用户控件包装器，将这个用户控件作为WebPart放到SharePoint页面上。

2、创建 W eb应用程序打开Visual 2003，新建一个 Web应用程序类型的项目。

注意，如果您是在SharePoint服务器上进行开发，那么由于SharePoint会接管网站目录的处理，所以建议您在IIS中创建一个新的虚拟网站，并让这个新网站使用一个不同的端口（比如8080），然后用它来创建普通的 Web应用程序。

如上图，我们创建了一个名称为MyUserControls的Web应用程序项目。

3、创建一个用户控件在Visual 2003的开发界面中，我们在解决方案资源管理器中的项目名称上点击鼠标右键，通过选择相应的菜单来创建一个用户控件。

我们为用户控件取名为“MyTimeTable”。

打开用户控件的界面设计器，从工具箱中拖一个Calendar控件到用户控件的窗体上，将Calendar控件改名为“c ldTimeTable”，并将其“width”属性更改为“100%”。

在Calendar 控件上点击鼠标右键，选择“自动套用格式”，然后用格式中选择一种显示格式。

设计器效果如下图。

将“MyTimeTable.ascx”的设计器视图切换成HTML源文件视图，选择“文件”菜单中的“高级保存选项”，在高级保存选项设计窗口中的编码选择框中选择“Unicode（UTF-8无签名）”。

点击的菜单“生成”，选择“生成解决方案”，确保已经成功的将项目进行了编译。

4、将用户控件部署到SharePoint服务器上在上个步骤创建的Web项目根目录下的“bin”目录中找到编译生成的“MyUserControls.dll”程序集文件，将其拷贝到SharePoint门户对应的磁盘目录下的“bin”子目录中（如果是在默认网站上创建的SharePoint门户，那么对应的磁盘目录应该就是“C:\Inetpub\wwwroot\bin”）。

在 Web项目根目录下找到用户控件对应的“MyTimeTable.ascx”文件，将其拷贝到SharePoint门户对应的磁盘目录下的“wpresources”子目录中（如果是在默认网站上创建的SharePoint门户，那么对应的磁盘目录应该就是“C:\Inetpub\wwwroot\wpresources”）。

5、将用户控件放置到SharePoint页面上打开SharePoint站点中某个可以定制的页面，并使其进入设计视图（即在页面右上角出现“修改共享网页”菜单按钮）。

点击“修改共享网页”菜单按钮，选择“添加Web部件－浏览”。

在出现的WebPart选择窗格中点击“虚拟服务器库”，这时应该能够在下方的“Web部件列表”中看到两个用户控件包装器WebPart（一个是“用户控件包装器（可提供数据）”，一个是“用户控件包装器（可使用数据）”）。

由于我们的用户控件还没有使用到WebPart Connection 特性，所以我们这里可以使用两个用户控件包装器中的任意一个。

将其中任意一个用户控件包装器WebPart拖动到页面上。

然后点击这个新的WebPart所显示出的“设置”链接，在页面右侧的WebPart属性窗格中将出现一个用户控件下拉选择框，在其中选择“MyTimeTable”用户控件。

点击页面右侧WebPart属性窗格下方的“确定”按钮，关闭WebPart属性窗格。

这时，MyTimeTable用户控件会被载入到SharePoint页面上，并显示出来。

6、设置用户控件的友好名称在上个步骤中，我们在右侧的用户控件列表下拉框中选择了“MyTimeTable”，这个下拉框中的用户控件名称会自动使用用户控件的类名称。

为了方便SharePoint管理员，我们可以为用户控件设置一个友好名称，然后让友好名称显示在用户控件列表下拉框中。

在 2003中打开MyTimeTable.ascx.cs源码文件。

在源码文件上方的“using”区域添加一个命名空间引用：using ponentModel;在MyTimeTable类声明上添加DescriptionAttribute的修饰，在DescriptionAttribute的构造函数中使用一个字符串参数“我的日历”：[Description("我的日历")]public class MyTim eTable : erControl重新编译项目，然后将更新的“MyUserControls.dll”程序集文件拷贝到SharePoint门户根目录的“bin”子目录中，替换旧文件。

打开SharePoint页面上的用户控件包装器WebPart属性窗格（通过点击WebPart标题栏右侧的三角形菜单链接，选择“修改共享Web部件”），这时能够看到用户控件列表下拉框中的用户控件名称已经更新成了“我的日历”。

当以后在其他地方使用这个用户控件时，都能够直接通过选择“我的日历”，而不是“MyTimeTable”来进行用户控件选择了。

Lab2：在用户控件中添加自定义属性1、目的WebPart的一个很大的特点就是它拥有自定义属性。

管理员和用户可以直接在页面上，通过右侧的WebPart属性窗格来修改WebPart的某个自定义属性。

每个WebPart除了其默认的一组自定义属性之外（比如WebPart的标题、高度、宽度等），开发人员还可以为WebPart添加自定义属性，增加WebPart的灵活性。

2、在用户控件代码中增加属性用 2003打开Lab1中创建的MyUserControls 这个 Web应用程序项目，然后打开MyTimeTable.ascx.cs源码文件。

在MyTimeTable类中添加一个属性“DisplayTitleFormat”，类型为TitleFormat枚举。

“DisplayTitleFormat”属性直接读取和设置用户控件中的Calendar子控件的TitleFormat属性。

public TitleForm at DisplayTitleFormat{get { return this.cldTim eTable.TitleFormat; }set { this.cldTim eTable.TitleFormat = value; }}在这个属性上加上“[BrowsableAttribute]”和“[DescriptionAttribute]”修饰。

“[BrowsableAttribute]”的构造函数中需要传入布尔值“true”，“[DescriptionAttribute]”的构造函数中需要填写一个字符串类型的描述文本。

“[DescriptionAttribute]”特性是可选的，它只是为了让属性拥有一个友好名称。