Custom Field Types Deployment

Last modified: March 25, 2010

Applies to: SharePoint Foundation 2010

Custom field types are deployed at the server farm-level, using the Microsoft SharePoint Foundation Solution Deployment functionality.

The various pieces of a custom field type solution must be deployed as described below.

  • The field type class must be deployed as a strong-named assembly to the global assembly cache.

  • The field type definition XML file must be deployed to:

    %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\Template\XML

    Each field type definition must be included in a file named fldtypes*.xml. For example, if you have a field type definition for a field type that defines a Social Security Number, you might name the XML file fldtypes_ssn.xml.

  • If you will be providing custom rendering of your field on list views, the XSLT stylesheet file must be deployed to:

    %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\Template\Layouts\XSL

    Each custom template must be included in a file named fldtypes_*.xsl. For example, fldtypes_ssn.xsl.

  • If you are using one or more user control (ascx files) to render your field on forms, these must be deployed to:

    %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\Template\ControlTemplates

  • If your custom field has variable properties and you have specified a custom field editor user control for the field type, the ascx file must be deployed to:

    %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\Template\controltemplates

For more information about deploying your field type as a solution, see Using Solutions in SharePoint Foundation. For the specific steps to create a solution, see Manually Creating Solutions in SharePoint Foundation. Much of the configuration work is done for you if you use the SharePoint development tools in Microsoft Visual Studio 2010 built into Visual Studio.

Show: