Sharepoint自定义字段开发(Custom Field) Inside Microsoft Sharepoint 2010 读书笔记

本篇博客是inside microsoft sharepoint 2010的读书笔记，针对我感兴趣的章节，争取多发一些笔记，作为对知识的整理。

 

通过开发自定义字段可以实现自定义的验证逻辑和自定义的字段显示与编辑UI

但是自定义字段也有一些缺点：

1. 不能以sandbox方式部署

2. 可能存在与office软件集成的问题（本人未测试）

3. 在使用linq2sharepoint时可能也会有问题（本人未测试）

 

VS2010中没有提供自定义字段的Project模板，也没有Project Item模板。下图是Inside Sharepoint 2010附带的样例代码

关于这个project的结构，有几点值得说明：

1. 没有feature的定义，自定义字段是针对整个Farm级别的，我们无法指定它在某个范围内可见

2. xxxFieldControl和ascx用户控件并不是必须的，只有当你需要自定义的字段编辑/显示UI时才需要

3. 如果需要定制字段编辑UI，则需要创建xxxFieldControl和ascx控件，注意在ControlTemplates下没有子文件夹，这是因为sharepoint针对custom field不在子目录中检索用户控件，因此这个样例项目加上了特定的前缀。

4. 一个前缀为fldtypes*.xml的文件需要被部署到服务器的template\xml文件夹下，实际上sharepoint foundation内置的字段类型定义xml也存放在这个文件夹下：fldtypes.xml，另外Sharepoint的server版中还有一些其他的自定义字段，例如dtypes_hold.xml, fldtypes_publishing.xml...

这个文件的结构是这样的：

实际上还有几个属性用来控制这个自定义字段的可见范围： ShowInListCreate, ShowInDocumentLibraryCreate, ShowInSurveyCreate, ShowInColumnTemplateCreate

 

创建一个最简单的Custom Field

代码说明

1. 必须继承自某个系统内置的字段基类，有两个必须有的构造函数(SPFieldCollection fields, string fieldName)和(SPFieldCollection fields, string typeName, string displayName)

2. override必要的基类属性、方法，上面的代码想要创建一个员工入职日期自定义字段，内含的业务逻辑是入职日期必须是周一

OnAdded：当用户完成字段添加后执行的代码

DefaultValue：如果用户在编辑界面中没有输入任何日期时执行该代码（这个属性只有get）

GetValidatedString：验证用户输入时执行，如果用户输入的数据不符合逻辑，可以抛异常throw new SPFieldValidationException("Employee start date must be a Monday"); Sharepoint会自动结果该异常并给出友好提示

另外，注意GetValidatedString的返回值是string，即使该字段的实际类型是DateTime。因此需要做些必要的转换，在sharepoint中，日期的标准字符串表示是ISO8601格式，SPUtility.CreateISO8601DateTimeFromSystemDateTime(startDate); 

 

为自定义字段提供编辑/查看UI

简单来说，就是要额外定义用户控件、FieldControl，并在这三者之间建立起关联。

1. 用户控件

<SharePoint:RenderingTemplate ID="EmployeeStatusRenderingTemplate" runat="server"> <!--这个ID用来和FieldControl关联-->
  <Template>
    <asp:RadioButtonList ID="lstEmployeeStatus" runat="server" CssClass="ms-authoringcontrols" />
  </Template>
</SharePoint:RenderingTemplate>

2. FieldControl

DefaultTemplateName属性用于查找对应的用户控件

Value属性的getter在即将把控件值写入Content database时被调用，setter在显示控件的编辑/查看UI时被调用

3. 修改CustomField的定义，使之关联到xxxFieldControl

 

在inside sharepoint 2010中还介绍了一个SPFieldMultiColumn字段类型，已他作为基类来实现对多值字段的支持。可是我没看出来这东西究竟用什么用处，因为我想直接继承自SPFieldText也可以实现这个效果。

在这就不做介绍了。希望知道它用法的朋友不吝赐教。

 

CustomField的设计时属性

此外还可以为我们的CustomField提供一些自定义的属性，用于控制CustomField的行为，样例效果图如下：

注意，这两个checkbox是sharepoint自动生成的，我们没有针对他们做UI

这个自定义的值可以在FieldControl中进行访问

 

最终的效果图

 

源代码下载

纸上得来终觉浅，绝知此事要躬行。点此下载源代码

不能光看理论文章（本人就经常这样做，因此经常看完白看，理解不深过后就忘），至少我们应该真正读一下示例代码，然后把他部署到服务器上查看实际效果。

 

---------------------------

下篇读书笔记是关于WebPart开发的，敬请期待！

通过 Wiz 发布