1. Overview

1.1. About

• to develop his own SharePoint software factory based on this project (please download the source code)
• to support this project with new templates, recipes, code samples and snippets to increase the capabilties of this project
• to help us improve the software factory by reporting bugs, feature ideas etc.

• Windows SharePoint Services (WSS) 3.0
• Microsoft Office SharePoint Server (MOSS) 2007
• Windows SharePoint Services (WSS) 4.0
• Microsoft SharePoint Server (MSS) 2010

1.2. Authors

SPSF Core Parts

Templates, Snippets,

• Microsoft
• Torsten Mandelkow
• Matthias Einig

1.3. System Requirements

• Supported Operating Systems: Windows Server 2003 Service Pack 2; Windows Vista; Windows Vista Service Pack 1; Windows XP Service Pack 2
• Visual Studio 2008 (Team System, Professional Edition or Standard Edition)
• Guidance Automation Extensions - February 2008 Release (Download)

1.4. How to use SPSF

How to use SharePoint Software Factory

1. Create a new project in Visual Studio

2. Run SharePoint recipes to create SharePoint code

1.5. Project Types

Differences between the project types

Why 2 different formats?

Notes

1.6. License

GNU General Public License version 2 (GPLv2)

2. Recipes

2.1. SPSF Projects

2.1.4. SharePoint 2007 Application

Name	Description
Application Settings
Company Name	Required String. Specifies the company name of the SharePoint application, used in copyright statements.
Application Name	Required String. Specifies the name of the SharePoint application, given by the name of the VS solution name.
Application Version	Required String. Specifies the version of the SharePoint application.
Local Site for debugging	Optional Url. Name of a SharePoint site for local debugging.
Multilanguage Settings
Generate .resx files automatically	Optional Boolean. If true .resx files are generated automatically.
Add separate project for language resources	Optional Boolean. It is a best practice to use a separate project for language resources to make new languages easier to integrate. If unchecked resources are added in each WSP solution.
Code Quality
Check code with FxCop in 'Release' build	Optional Boolean. If true Microsoft FxCop will be executed during the 'Release' build to check the complied code against certain coding rules. Additionally a SharePoint specific FxCop settings file will be added to the solution.
Check code with StyleCop in 'Release' build	Optional Boolean. If true Microsoft StyleCop will be executed during the 'Release' build to check the C# source code against certain style rules. Additionally a SharePoint specific StyleCop settings file will be added to the solution.
Check code with ShareCop in 'Release' build	Optional Boolean. If true SharePoint Code Analysis will be executed during the 'Release' build to check the C# source code against certain style rules. Additionally a SharePoint specific ShareCop settings file will be added to the solution.
Check code with SPDisposeChecker in 'Release' build	Optional Boolean. If true SharePoint Dispose Checker will be executed during the 'Release' build to check the code for potential memory leaks.
Advanced Settings
Generate manifest.xml automatically	Optional Boolean. If true the files manifest.xml and makecab.ddf are generated automatically.
Initial WSP Solution
Final WSP Solution Filename	Optional String. Displays the final name of the wsp solution file
WSP Solution Name	Required String. Specifies the name of the wsp solution. The final wsp solution name will be a combination of the application name (name of the VS.NET solution) and the wsp name.
Deployment Server Type	Optional String. Specifies the type of deployment server.
Deployment Target	Optional String. Specifies the deployment target.
Reset Webserver	Optional Boolean. If checked the option "ResetWebServer" in the solution manifest is set to TRUE.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.2. MSBuild Task

Name	Description
Task Name

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.5. SharePoint 2010 Application

Name	Description
Application Settings
Company Name	Required String. Specifies the company name of the SharePoint application, used in copyright statements.
Application Name	Required String. Specifies the name of the SharePoint application, given by the name of the VS solution name.
Application Version	Required String. Specifies the version of the SharePoint application.
Local Site for debugging	Optional Url. Name of a SharePoint site for local debugging.
Multilanguage Settings
Generate .resx files automatically	Optional Boolean. If true .resx files are generated automatically.
Add separate project for language resources	Optional Boolean. It is a best practice to use a separate project for language resources to make new languages easier to integrate. If unchecked resources are added in each WSP solution.
Code Quality
Check code with FxCop in 'Release' build	Optional Boolean. If true Microsoft FxCop will be executed during the 'Release' build to check the complied code against certain coding rules. Additionally a SharePoint specific FxCop settings file will be added to the solution.
Check code with StyleCop in 'Release' build	Optional Boolean. If true Microsoft StyleCop will be executed during the 'Release' build to check the C# source code against certain style rules. Additionally a SharePoint specific StyleCop settings file will be added to the solution.
Check code with ShareCop in 'Release' build	Optional Boolean. If true SharePoint Code Analysis will be executed during the 'Release' build to check the C# source code against certain style rules. Additionally a SharePoint specific ShareCop settings file will be added to the solution.
Check code with SPDisposeChecker in 'Release' build	Optional Boolean. If true SharePoint Dispose Checker will be executed during the 'Release' build to check the code for potential memory leaks.
Advanced Settings
Generate manifest.xml automatically	Optional Boolean. If true the files manifest.xml and makecab.ddf are generated automatically.
Initial WSP Solution
Final WSP Solution Filename	Optional String. Displays the final name of the wsp solution file
WSP Solution Name	Required String. Specifies the name of the wsp solution. The final wsp solution name will be a combination of the application name (name of the VS.NET solution) and the wsp name.
Deployment Server Type	Optional String. Specifies the type of deployment server.
Deployment Target	Optional String. Specifies the deployment target.
Reset Webserver	Optional Boolean. If checked the option "ResetWebServer" in the solution manifest is set to TRUE.
Sandboxed solution	Optional Boolean. If checked a sandboxed solutions will be created.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.7. Sharepoint 2007 Solution Package (.wsp)

A customation project is the core wsp solution project type to deploy a .wsp solution to SharePoint.

Name	Description
Final WSP Solution Filename	Optional String. Displays the final name of the wsp solution file
Solution Name	Required String. Name of the project without full namespace.
Deployment Server Type	Optional String. Specifies the type of deployment server.
Deployment Target	Optional String. Specifies the deployment target.
Site Url for debugging	Optional String. Specifies the local web application which is used for debugging and deployment.
Reset Webserver	Optional Boolean. If checked the option "ResetWebServer" in the solution manifest is set to TRUE.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.8. Sharepoint 2010 Solution Package (.wsp)

A customation project is the core wsp solution project type to deploy a .wsp solution to SharePoint.

Name	Description
Final WSP Solution Filename	Optional String. Displays the final name of the wsp solution file
Solution Name	Required String. Name of the project without full namespace.
Deployment Server Type	Optional String. Specifies the type of deployment server.
Deployment Target	Optional String. Specifies the deployment target.
Reset Webserver	Optional Boolean. If checked the option "ResetWebServer" in the solution manifest is set to TRUE.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.6. Sharepoint 2007 Solution Package (.wsp)

A customation project is the core wsp solution project type to deploy a .wsp solution to SharePoint.

Name	Description
Final WSP Solution Filename	Optional String. Displays the final name of the wsp solution file
Solution Name	Required String. Name of the project without full namespace.
Deployment Server Type	Optional String. Specifies the type of deployment server.
Deployment Target	Optional String. Specifies the deployment target.
Reset Webserver	Optional Boolean. If checked the option "ResetWebServer" in the solution manifest is set to TRUE.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.9. Sharepoint 2010 Solution Package (.wsp)

A customation project is the core wsp solution project type to deploy a .wsp solution to SharePoint.

Name	Description
Final WSP Solution Filename	Optional String. Displays the final name of the wsp solution file
Solution Name	Required String. Name of the project without full namespace.
Deployment Server Type	Optional String. Specifies the type of deployment server.
Deployment Target	Optional String. Specifies the deployment target.
Site Url for debugging	Optional String. Specifies the local web application which is used for debugging and deployment.
Reset Webserver	Optional Boolean. If checked the option "ResetWebServer" in the solution manifest is set to TRUE.
Sandboxed solution	Optional Boolean. If checked a sandboxed solutions will be created.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1. SharePoint Class Library (.dll)

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.3. PowerShell Snapin Project

Name	Description
Title	Required String. Specifies the title of the snapin.
Description	Required String. Specifies the title of the snapin.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.2. SPSF Artefacts

2.1.1. Features

2.1.1.1. Empty Feature

The recipe creates a new empty feature. It should be used as a start for every custom feature.
It can be specified if the feature should be deployed in a farm, web application, site, or web scope.
Most of sharepoint custom components like content types, event handler etc. require a feature.
One feature can be used to deploy multiple of these components but it is also possible to make feature activation dependent of other features.

Name	Description
Feature settings
Name	Required Text. Internal name of the Feature. Limited to 255 characters. The name has to be unique within the project of this solution. It should not contain whitespaces or special characters.
Title	Required Text. Title (friendly name) of the Feature. Limited to 255 characters.
Description	Required Text. Longer description of the Features purpose.
Scope	Required Choice. Scope in which the Feature can be activated and contains one of the following values: Farm (farm), WebApplication (Web application), Site (site collection), Web (Web site).
Hidden	Optional Boolean. Specifies if the feature should be hidden on the Feature activation webpages. This attribute equals FALSE by default.
Create Feature Receiver	Optional Boolean. When activated, a feature receiver class file will be created and linked to the Feature. This attribute equals FALSE by default.
Create default elements.xml	Optional Boolean. When activated the recipe creates a default elements.xml file. This attribute equals TRUE by default.
Advanced settings
Feature ID	Required GUID. The GUID will be autogenerated by the recipe, but can be customized if neccesary.
Feature Version	Optional Text. Specifies a System.Version-compliant representation of the version of a Feature. This can be up to four numbers delimited by decimals that represent a version.
Creator	Optional Text. Name of the creator of the Feature stored in the feature.xml.
Activation Dependencies	Optional GUID. One or multiple Features of which the activation of this Feature should depend on. The dependencies can be either out of the box SharePoint Features or custom Features of this project.
Options
Activate On Default	Optional Boolean. TRUE if the Feature is activated by default during installation or when a Web application is created; FALSE if the Feature is not activated. This attribute equals TRUE by default. The ActivateOnDefault attribute does not apply to site collection (Site) or Web site (Web) scoped Features. In general, Farm-scoped Features become activated during installation, and when a new Web application is created, all installed Web application-scoped Features in it become activated.
Always Force Install	Optional Boolean. TRUE if the Feature is installed by force during installation even if the Feature is already installed. For example, if set to TRUE, Feature installation callouts will always fire anytime a user tries to install the Feature (even if it is already installed) by using either the scanforFeatures or installfeature command-line operation. This attribute equals FALSE by default. The AlwaysForceInstall attribute affects Features of all scopes.
Auto Activate In Central Admin	Optional Boolean. TRUE if the Feature is activated by default in the Administrative Web site, site collection, or Web application. This attribute equals FALSE by default. The AutoActivateInCentralAdmin attribute does not apply to Farm-scoped Features.
Require Resources	Optional Boolean. TRUE to specify that Windows SharePoint Services check whether resources exist for the Feature by verifying that the standard "sentinel" resource for the Feature is present for a particular culture. The RequireResources attribute allows you to constrict the visibility of certain Features depending on whether resources exist in a particular language for the Feature.

• MSDN: Creating a Custom Feature in SharePoint Server 2007
• MSDN: Working with Features
• Codeplex: Features

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.4. Feature: Add Property

Name	Description
Key	Optional Text. Returns the identifier of the property being modified.
Value	Optional Text. Returns the value of the property.

• MSDN: Working with Features

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.5. Feature: Add Upgrade Action for Content Type

Name	Description
Content Type	Optional string. Specifies the content type.
Field	Optional string. Specifies the field in the content type.
Push Down Changes	Optional Boolean. Specifies whether the content type field should be applied to inheriting content types and lists.
Begin Version	Optional string. Specifies the earliest version number to upgrade.
End Version	Optional string. Specifies the latest version number to upgrade.

• MSDN: Working with Features

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.2. Feature: Add Activation Dependency

Name	Description
Activation Dependencies	Optional GUID. One or multiple Features of which the activation of this Feature should depend on. The dependencies can be either out of the box SharePoint Features or custom Features of this project.

• MSDN: Working with Features

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.3. Feature: Add Activation Dependency

Feature Activation Dependencies in SharePoint 2010 can contain additional properties like MinimumVersion, FeatureName and FeatureDescription.

Name	Description
Activation Dependencies	Optional GUID. One or multiple Features of which the activation of this Feature should depend on. The dependencies can be either out of the box SharePoint Features or custom Features of this project.
Minimum Version	Optional string. The minimum version of the Feature dependency. This attribute must use the pattern n.n.n.n, where each occurrence of n is a numeric value.

• MSDN: Working with Features

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.2. Lists and Libaries

2.1.1.8. List Instance

Name	Description
List Instance Settings
Title	Required Text. Title of the list in the schema.
Description	Optional Text. Contains a description of the list.
Template Type
Url	Required Text. Returns the site-relative URL at which to place the list.
Advanced Settings
RootWebOnly	Optional Boolean. TRUE to specify that the list created from the definition exists only in the root Web site of a site collection.
OnQuickLaunch	Optional Boolean. TRUE to display lists created from the list definition on the Quick Launch bar.
QuickLaunchUrl	Optional Text. Specifies the URL of the view page to open for the list through Quick Launch navigation.
Id	Required Text. Specifies a unique identifier for the list instance. The integer must be unique across the Feature definition.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.7. List Definition

Name	Description
List Template Settings
Base Template	Required Integer. Specifies the base type, or default schema, for lists created from the definition.
Name	Required Text. Specifies the internal name of the list definition. No spaces or special characters can be used. This name is also used to find the folder that contains the Schema.xml file that defines the schema in use.
DisplayName	Required Text. Specifies the display name of the list definition.
Description	Optional Text. Provides a description of the list definition.
Category	Optional Text. Specifies the category with which to associate lists created through the list definition.
Sequence	Optional Integer. Specifies the ordering priority to use for the list template on the Create page. If Sequence is not set, the template appears last in arbitrary order with any other templates that also lack a Sequence value. Two templates that specify the same sequence are sorted together in an arbitrary order.
Advanced Settings
Type	Optional Integer. Provides a unique identifier for the template. This identifier must be unique within the feature, but need not be unique across all feature definitions or site definitions.
Base Type	Required Integer. Specifies the base type, or default schema, for lists created from the definition.
Additional Content Types	Optional Content Types.
Options
Default in new sites	Optional Boolean. TRUE to specify that new SharePoint sites will include this list.
OnQuickLaunch	Optional Boolean. TRUE to display lists created from the list definition on the QuickLaunch bar.
DisableAttachments	Optional Boolean. TRUE to specify that users can attach files to items in lists created through the template; otherwise, FALSE.
DisallowContentTypes	Optional Boolean. TRUE to specify that content types can be managed on lists created through the template; otherwise, FALSE.
VersioningEnabled	Optional Boolean. TRUE to specify that versioning is enabled by default in lists created through the template; otherwise, FALSE.
FolderCreation	Optional Boolean. TRUE to enable folder creation within the list and to specify that the New Folder command appears on the New menu in list views; otherwise, FALSE.
EnableModeration	Optional Boolean. TRUE to specify that content approval is enabled by default in lists created through the template; otherwise, FALSE.
Hidden	Optional Boolean. TRUE to specify that the list definition is not available on the Create page for creating lists.
HiddenList	Optional Boolean. TRUE to specify that a list created from the list definition is hidden.
Advanced
Security Read	Optional Text. Defines the item-level permissions in the list for users with sufficient permission to read or edit list items. The SecurityBits attribute contains a 2-digit string. The first digit in the string controls the read access; the second digit in the string controls the edit access.
Security Edit	Optional Text. Defines the item-level permissions in the list for users with sufficient permission to read or edit list items. The SecurityBits attribute contains a 2-digit string. The first digit in the string controls the read access; the second digit in the string controls the edit access.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.9. Module

Name	Description
Select Files
Name	Required Text. Contains the name of the file set.
Target Url	Optional Text. Specifies the virtual path of the folder in which to place the files when a site is instantiated. If Path is not specified, the value of Url is used for the physical path. Use the Url attribute to provision a folder through the Feature.
Files	Select the files which should be added to the module. The selected files will be copied into the project.
RootWebOnly	Optional Boolean. TRUE if the files specified in the module are installed only in the top-level Web site of the site collection.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.10. Site Column

Name	Description
Site Column Type
ID	Required Text. Specifies the GUID of the field.
Name	Required Text. The name of a field. This is the internal name of a field and is guaranteed never to change for the lifetime of the field definition. It must be unique with respect to the set of fields in a list. The name is autogenerated based on the user-defined name for a field.
Display Name	Optional Text. The displayed name for a field. There is no restriction on text size or use of spaces. The display name can be edited by the user and can change after initial field creation. This name is used as a column heading when the field is displayed in a table view and as a form label when the field is displayed in a form. The FieldName tag returns the display name if given; otherwise, it defaults to the Name attribute.
Description	Optional Text. Provides the description that is shown in the edit form for a list if a field description is specified. By default, fields in Microsoft Windows SharePoint Services do not have descriptions.
Group	Optional Text. Specifies the column group to which the field belongs.

• MSDN: Field Element Schema

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.2. Content Type Binding

Name	Description
Content Type Binding
Content Type	Required Text. A string that represents the content type ID of the site content type to add to the specified list.
List Url	Required Text. A string that represents the Web-relative path to the list to which to add the content type (e.g. "Pages", "Lists/Contacts").
RootWebOnly	Optional Boolean. TRUE to associate this binding only on the root Web site in a site collection (new in SP 2010).

• Content Type Binding Schema

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.6. ContentType: Add Field

Name	Description
Parent Element
Parent Content Type	Required. Select the content type.
Fields
Fields	Optional. Specifies a column to reference in this content type.
Remove Fields	Optional. Specifies a column reference, included in the parent content type, to be removed from this content type.

• Content Type Definition Schema

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.1. Content Type

Name	Description
Content Type Settings
Parent Content Type	Required. New content type will be derived from the selected parent content type.
Name	Required Text. Specifies the content type name.
Description	Optional Text. Provides a description for the content type, to display in the Windows SharePoint Services user interface.
Group	Optional Text. Specifies the content type group to which the content type is assigned. Content type groups are user-defined groups that help you organize your columns into logical categories.
Fields
Fields	Optional. Specifies a column to reference in this content type.
Remove Fields	Optional. Specifies a column reference, included in the parent content type, to be removed from this content type.
Document Template
Document Template	Optional Text. Document template which is used for creation of new items based on this content type.
Place template in _layouts folder for easier upgrade	Optional Boolean. If checked, the selected document template will be placed inside the /_layouts/ in SharePoint and can be updated easier in the future. Otherwise the document template will be stored in the database.
Event Receivers
Item Adding	Optional Boolean. If checked an event handler for ItemAdding event is added to the content type.
Item Added	Optional Boolean. If checked an event handler for ItemAdded event is added to the content type.
Item Updating	Optional Boolean. If checked an event handler for ItemUpdating event is added to the content type.
Item Updated	Optional Boolean. If checked an event handler for ItemUpdated event is added to the content type.
Item Deleting	Optional Boolean. If checked an event handler for ItemDeleting event is added to the content type.
Item Deleted	Optional Boolean. If checked an event handler for ItemDeleted event is added to the content type.
Custom Forms
Custom Display Form	Optional Boolean. If checked a custom form for the display mode of the content type is added.
Custom Edit Form	Optional Boolean. If checked a custom form for the edit mode of the content type is added.
Custom New Form	Optional Boolean. If checked a custom form for the creation of the content type is added.
Advanced Settings
Content Type ID	Required Text. Specifies the content type ID of the content type.
Content Type Version	Reserved for future use.
Hidden	Optional Boolean. TRUE to define the content type as hidden. If you define a content type as hidden, Windows SharePoint Services does not display that content type on the New button in list views. If you do not include this attribute, Windows SharePoint Services treats the content type as if this attributes was set to FALSE.
Read Only	Optional Boolean. TRUE to define the content type as read-only. If you do not include this attribute, Windows SharePoint Services treats the content type as if this attributes was set to FALSE.
Sealed	Optional Boolean. TRUE to define the content type as sealed. You must have site collection administrator rights to unseal and edit a content type defined as sealed. If you do not include this attribute, Windows SharePoint Services treats the content type as if this attributes was set to FALSE.

• Content Type Definition Schema

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.4. ContentType: Add Document Template

Name	Description
Parent Element
Parent Content Type	Required. Select the content type.
Document Template
Document Template	Optional Text. Document template which is used for creation of new items based on this content type.
Place template in _layouts folder for easier upgrade	Optional Boolean. If checked, the selected document template will be placed inside the /_layouts/ in SharePoint and can be updated easier in the future. Otherwise the document template will be stored in the database.

• Content Type Definition Schema

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.5. ContentType: Add Event Receiver

Name	Description
Parent Element
Parent Content Type	Required. Select the content type.
Event Receivers
Item Adding	Optional Boolean. If checked an event handler for ItemAdding event is added to the content type.
Item Added	Optional Boolean. If checked an event handler for ItemAdded event is added to the content type.
Item Updating	Optional Boolean. If checked an event handler for ItemUpdating event is added to the content type.
Item Updated	Optional Boolean. If checked an event handler for ItemUpdated event is added to the content type.
Item Deleting	Optional Boolean. If checked an event handler for ItemDeleting event is added to the content type.
Item Deleted	Optional Boolean. If checked an event handler for ItemDeleted event is added to the content type.

• Content Type Definition Schema

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.3. ContentType: Add Custom Form

Name	Description
Parent Element
Parent Content Type	Required. Select the content type.
Custom Forms
Custom Display Form	Optional Boolean. If checked a custom form for the display mode of the content type is added.
Custom Edit Form	Optional Boolean. If checked a custom form for the edit mode of the content type is added.
Custom New Form	Optional Boolean. If checked a custom form for the creation of the content type is added.

• Content Type Definition Schema

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.3. Webs and Sites

2.1.1.3. Team Site Definition

The Team Site Definition is a standard preconfigured site definition which already contains a documents library, an announcements list, discussion list etc. This site definition can be used as a starting point to create a custom team site definition based on the default out of the box configuration which comes with WSS.

Name	Description
General settings
Name	Required Text. Specify the name of the folder which will be created in folder SiteTemplates. Limited to 255 characters. The name has to be unique within the project of this solution. It should not contain whitespaces or special characters.
Title	Required Text. Title of the site template as it appears in the selection of Create Site dialog. Limited to 255 characters.
ID	Required Number. Id of the site template. Should be unique on the farm and greater than 10000.
Description	Required Text. Longer description of the purpose of this site definition.
Category	Required Text. Title of the cateogry in which the site definition should appear in the Create Site dialog. Limited to 255 characters.
Advanced settings
Hidden	Optional Boolean. If TRUE hides the site definition from the Create Site dialog. Creation of sites with this definition through code will be still possible.
RootWebOnly	Optional Boolean. If TRUE the site created from the configuration can only exist as the root Web site in a site collection. This attribute is not enforced in site templates (.stp files).
Visibility Feature Dependency	Optional Text. Optional Text. Used in a WebTemp*.xml file to hide the site definition configuration based on the activation state of the specified Feature. This attribute is not supported for Features with Web application scope.

• .Net Journal: Creating Custom Site Definitions in Microsoft Windows SharePoint Services
• MSDN: Configuration Node
• MSDN: Schema Onet.xml

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.1. Blank Site Definition

The BalnkSite Definition is a standard site definition which does not contain any lists or libraries.
This site definition can be used as a starting point to create a custom site definition
based on the default out of the box configuration which comes with WSS.

Name	Description
General settings
Name	Required Text. Specify the name of the folder which will be created in folder SiteTemplates. Limited to 255 characters. The name has to be unique within the project of this solution. It should not contain whitespaces or special characters.
Title	Required Text. Title of the site template as it appears in the selection of Create Site dialog. Limited to 255 characters.
ID	Required Number. Id of the site template. Should be unique on the farm and greater than 10000.
Description	Required Text. Longer description of the purpose of this site definition.
Category	Required Text. Title of the cateogry in which the site definition should appear in the Create Site dialog. Limited to 255 characters.
Advanced settings
Hidden	Optional Boolean. If TRUE hides the site definition from the Create Site dialog. Creation of sites with this definition through code will be still possible.
RootWebOnly	Optional Boolean. If TRUE the site created from the configuration can only exist as the root Web site in a site collection. This attribute is not enforced in site templates (.stp files).
Visibility Feature Dependency	Optional Text. Optional Text. Used in a WebTemp*.xml file to hide the site definition configuration based on the activation state of the specified Feature. This attribute is not supported for Features with Web application scope.

• .Net Journal: Creating Custom Site Definitions in Microsoft Windows SharePoint Services
• MSDN: Configuration Node
• MSDN: Schema Onet.xml

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.2. Feature Stapling

Stapling SharePoint features with site definitions, which relies on the FeatureSiteTemplateAssociation element, allows developers to attach features to both standard and custom site definitions without directly modifying them.
Every new site that is based on a site definition with a stapled feature is created with that feature activated.
Feature stapling is particularly useful when you want to add functionality to standard site definitions because editing standard site definition files is not a recommended practice. (Source: MSDN)

Name	Description
Feature Associations
Feature	Required Feature. Feature to which the previously selected feature should be stapled to.
Site Template	Optional Site Definition. Site Definition to which the previously selected feature should be stapled to.

• MSDN: Stapling Features to Site Definitions
• Chris O'Brien: Feature Stapling
• Chris Johnson: Feature Stapling in WSS V3
• MS SharePoint Team Blog: Customizing MOSS 2007 My Sites within the enterprise
• Definition Schema

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.4. Theme

With a theme SharePoint Look and Feel can be altered only by modifying cascading stylesheets (CSS) and images.
Opposing to master pages, also affect the MOSS backend without the need to modify application.master (which is not recommended anyway).
This recipe creates a new basic theme which can be deployed to a farm with a feature.

Name	Description
Theme settings
Name	Required Text. Internal name of the Feature. Limited to 255 characters. The name has to be unique within the project of this solution. It should not contain whitespaces or special characters.
Display Name	Required Text. Display name of the Theme. Limited to 255 characters.
Description	Optional String. Longer description ofthe theme.

• Sharing the point: Create a Custom Theme for WSS 3.0 or MOSS 2007
• MSDN: Customizing and Branding Web Content Management-Enabled SharePoint Sites
• Heather Solomon: CSS Reference Chart for SharePoint 2007
• MSDN: Real World Branding with SharePoint Server 2007 Publishing Sites
• CodePlex: SharePoint Branding Tool
• Servé Hermans: SharePoint Theme Generator
• MS SharePoint Team Blog: Customizing MOSS 2007 My Sites within the enterprise

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.5. Theme Activation

Use this recipe if a custom theme should be activated on a site, together with the activation of a feature.
It is also possible to specificy which theme default theme should be used, when the feature is deactivated again.

Name	Description
Theme settings
Theme to activate	Required Theme. The name of the theme which should be activated
Default theme for deactivation of the feature	Required Theme. The name of the default theme which is activated if the feature is deactivated.

• Sharing the point: Create a Custom Theme for WSS 3.0 or MOSS 2007
• MSDN: Customizing and Branding Web Content Management-Enabled SharePoint Sites
• Heather Solomon: CSS Reference Chart for SharePoint 2007
• MSDN: Real World Branding with SharePoint Server 2007 Publishing Sites

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.4. Custom Actions and Ribbons

2.1.1.1. Custom Action for Content Type

Name	Description
Content Type
Content Type	Select the content type to which the custom action should be added.
Custom Actions Settings
Title	Required Text. Specifies the end user description for this action.
Description	Optional Text. Specifies a longer description for the action that is exposed as a tooltip or sub-description for the action.
Sequence	Optional Integer. Specifies the ordering priority for actions.
Advanced Settings
Custom Action ID	Optional Text. Specifies a unique identifier for the custom action. The ID may be a GUID, or it may be a unique term, for example, "HtmlViewer".
Options
Show In Lists
Show In ReadyOnly ContentTypes	Optional Boolean. TRUE if the custom action is only displayed for read-only content types on the page for managing content types. The default value is FALSE.
Show In Sealed ContentTypes	Optional Boolean. TRUE if the custom action is only displayed for sealed content types on the page for managing content types. The default value is FALSE.
Require Site Administrator	Optional Boolean. TRUE to specify that the item be displayed only if the user is a site administrator; otherwise, FALSE. Using the RequireSiteAdministrator attribute for the drop-down menu of Windows SharePoint Services commands associated with list items is not supported.
Rights	Optional Text. Specifies a set of rights that the user must have in order for the link to be visible. If not specified, then the action always appears in the list of actions. The set of rights are grouped logically according to AND logic.
Url Settings
Type of action	Required. Select the type of action that should be performed after click.
Url Page	Optional Text. Select a page where the custom action should link to. Only required if field 'Type of action' is 'UrlAction'.
Use URL Prefix	Optional Text. Select the prefix which should be placed at the beginning of the url action.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.2. Custom Action for File Extension

Name	Description
File Extension
Extension	Enter the file extension.
Custom Actions Settings
Title	Required Text. Specifies the end user description for this action.
Description	Optional Text. Specifies a longer description for the action that is exposed as a tooltip or sub-description for the action.
Sequence	Optional Integer. Specifies the ordering priority for actions.
Advanced Settings
Custom Action ID	Optional Text. Specifies a unique identifier for the custom action. The ID may be a GUID, or it may be a unique term, for example, "HtmlViewer".
Options
Show In Lists
Show In ReadyOnly ContentTypes	Optional Boolean. TRUE if the custom action is only displayed for read-only content types on the page for managing content types. The default value is FALSE.
Show In Sealed ContentTypes	Optional Boolean. TRUE if the custom action is only displayed for sealed content types on the page for managing content types. The default value is FALSE.
Require Site Administrator	Optional Boolean. TRUE to specify that the item be displayed only if the user is a site administrator; otherwise, FALSE. Using the RequireSiteAdministrator attribute for the drop-down menu of Windows SharePoint Services commands associated with list items is not supported.
Rights	Optional Text. Specifies a set of rights that the user must have in order for the link to be visible. If not specified, then the action always appears in the list of actions. The set of rights are grouped logically according to AND logic.
Url Settings
Type of action	Required. Select the type of action that should be performed after click.
Url Page	Optional Text. Select a page where the custom action should link to. Only required if field 'Type of action' is 'UrlAction'.
Use URL Prefix	Optional Text. Select the prefix which should be placed at the beginning of the url action.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.6. Custom Action for ProgID (Document Type)

Name	Description
ProgId
Content Type	Select the document type to which the custom action should be added.
Custom Actions Settings
Title	Required Text. Specifies the end user description for this action.
Description	Optional Text. Specifies a longer description for the action that is exposed as a tooltip or sub-description for the action.
Sequence	Optional Integer. Specifies the ordering priority for actions.
Advanced Settings
Custom Action ID	Optional Text. Specifies a unique identifier for the custom action. The ID may be a GUID, or it may be a unique term, for example, "HtmlViewer".
Options
Show In Lists
Show In ReadyOnly ContentTypes	Optional Boolean. TRUE if the custom action is only displayed for read-only content types on the page for managing content types. The default value is FALSE.
Show In Sealed ContentTypes	Optional Boolean. TRUE if the custom action is only displayed for sealed content types on the page for managing content types. The default value is FALSE.
Require Site Administrator	Optional Boolean. TRUE to specify that the item be displayed only if the user is a site administrator; otherwise, FALSE. Using the RequireSiteAdministrator attribute for the drop-down menu of Windows SharePoint Services commands associated with list items is not supported.
Rights	Optional Text. Specifies a set of rights that the user must have in order for the link to be visible. If not specified, then the action always appears in the list of actions. The set of rights are grouped logically according to AND logic.
Url Settings
Type of action	Required. Select the type of action that should be performed after click.
Url Page	Optional Text. Select a page where the custom action should link to. Only required if field 'Type of action' is 'UrlAction'.
Use URL Prefix	Optional Text. Select the prefix which should be placed at the beginning of the url action.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.4. Custom Action for List

Name	Description
List Type
List Type	Select the list type where the action should be added.
Toolbar	Select the location where the action should be added.
Custom Actions Settings
Title	Required Text. Specifies the end user description for this action.
Description	Optional Text. Specifies a longer description for the action that is exposed as a tooltip or sub-description for the action.
Sequence	Optional Integer. Specifies the ordering priority for actions.
Advanced Settings
Custom Action ID	Optional Text. Specifies a unique identifier for the custom action. The ID may be a GUID, or it may be a unique term, for example, "HtmlViewer".
Options
Show In Lists
Show In ReadyOnly ContentTypes	Optional Boolean. TRUE if the custom action is only displayed for read-only content types on the page for managing content types. The default value is FALSE.
Show In Sealed ContentTypes	Optional Boolean. TRUE if the custom action is only displayed for sealed content types on the page for managing content types. The default value is FALSE.
Require Site Administrator	Optional Boolean. TRUE to specify that the item be displayed only if the user is a site administrator; otherwise, FALSE. Using the RequireSiteAdministrator attribute for the drop-down menu of Windows SharePoint Services commands associated with list items is not supported.
Rights	Optional Text. Specifies a set of rights that the user must have in order for the link to be visible. If not specified, then the action always appears in the list of actions. The set of rights are grouped logically according to AND logic.
Url Settings
Type of action	Required. Select the type of action that should be performed after click.
Url Page	Optional Text. Select a page where the custom action should link to. Only required if field 'Type of action' is 'UrlAction'.
Use URL Prefix	Optional Text. Select the prefix which should be placed at the beginning of the url action.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.5. Custom Action for List Toolbar

Name	Description
List Type
List Type	Select the list type where the action should be added.
Toolbar	Select the toolbar where the action should be added.
Custom Actions Settings
Title	Required Text. Specifies the end user description for this action.
Description	Optional Text. Specifies a longer description for the action that is exposed as a tooltip or sub-description for the action.
Sequence	Optional Integer. Specifies the ordering priority for actions.
Advanced Settings
Custom Action ID	Optional Text. Specifies a unique identifier for the custom action. The ID may be a GUID, or it may be a unique term, for example, "HtmlViewer".
Options
Show In Lists
Show In ReadyOnly ContentTypes	Optional Boolean. TRUE if the custom action is only displayed for read-only content types on the page for managing content types. The default value is FALSE.
Show In Sealed ContentTypes	Optional Boolean. TRUE if the custom action is only displayed for sealed content types on the page for managing content types. The default value is FALSE.
Require Site Administrator	Optional Boolean. TRUE to specify that the item be displayed only if the user is a site administrator; otherwise, FALSE. Using the RequireSiteAdministrator attribute for the drop-down menu of Windows SharePoint Services commands associated with list items is not supported.
Rights	Optional Text. Specifies a set of rights that the user must have in order for the link to be visible. If not specified, then the action always appears in the list of actions. The set of rights are grouped logically according to AND logic.
Url Settings
Type of action	Required. Select the type of action that should be performed after click.
Url Page	Optional Text. Select a page where the custom action should link to. Only required if field 'Type of action' is 'UrlAction'.
Use URL Prefix	Optional Text. Select the prefix which should be placed at the beginning of the url action.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.7. Custom Action for Site

Name	Description
Location settings
Menu Location
Rights	Optional Text. Specifies a set of rights that the user must have in order for the link to be visible. If not specified, then the action always appears in the list of actions. The set of rights are grouped logically according to AND logic.
Custom Actions Settings
Title	Required Text. Specifies the end user description for this action.
Description	Optional Text. Specifies a longer description for the action that is exposed as a tooltip or sub-description for the action.
Sequence	Optional Integer. Specifies the ordering priority for actions.
Advanced Settings
Custom Action ID	Optional Text. Specifies a unique identifier for the custom action. The ID may be a GUID, or it may be a unique term, for example, "HtmlViewer".
Url Settings
Type of action	Required. Select the type of action that should be performed after click.
Url Page	Optional Text. Select a page where the custom action should link to. Only required if field 'Type of action' is 'UrlAction'.
Use URL Prefix	Optional Text. Select the prefix which should be placed at the beginning of the url action.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.8. Custom Action for SiteActions menu

Name	Description
Location settings
Rights	Optional Text. Specifies a set of rights that the user must have in order for the link to be visible. If not specified, then the action always appears in the list of actions. The set of rights are grouped logically according to AND logic.
Custom Actions Settings
Title	Required Text. Specifies the end user description for this action.
Description	Optional Text. Specifies a longer description for the action that is exposed as a tooltip or sub-description for the action.
Sequence	Optional Integer. Specifies the ordering priority for actions.
Advanced Settings
Custom Action ID	Optional Text. Specifies a unique identifier for the custom action. The ID may be a GUID, or it may be a unique term, for example, "HtmlViewer".
Url Settings
Type of action	Required. Select the type of action that should be performed after click.
Url Page	Optional Text. Select a page where the custom action should link to. Only required if field 'Type of action' is 'UrlAction'.
Use URL Prefix	Optional Text. Select the prefix which should be placed at the beginning of the url action.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.3. Custom Action Group

Name	Description
Location settings
Title	Required Text. Specifies the end user description for this action.
Description	Optional Text. Specifies a longer description for the action that is exposed as a tooltip or sub-description for the action.
Sequence	Optional Integer. Specifies the ordering priority for actions.
Hide Location	Select the location where the action group should be added.

• MSDN: CustomActionGroup Element (Custom Action)
• MSDN: Custom Action Definitions
• MSDN: Default Custom Action Locations and IDs

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.9. Hide Custom Action

Name	Description
Hide Action
Location Element	Select the action which should be hidden.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.17. Ribbon Tab

Name	Description
General Settings
Name	Required Text. Specifies the name of the button control.
Title	Required Text. The text to label the control.
Description	Required Text. The text that appears as the description of the tooltip.
Sequence	Required Integer. An integer that specifies the order of placement among sibling XML nodes.
Target Location Settings
Custom Action Location	Required Text. Location element of the custom action.
Optional Permission Settings
Rights	Optional Text. Specifies a set of rights that the user must have in order for the link to be visible. If not specified, then the action always appears in the list of actions. The set of rights are grouped logically according to AND logic.
Require Site Administrator	Optional Boolean. TRUE to specify that the item be displayed only if the user is a site administrator; otherwise, FALSE. Using the RequireSiteAdministrator attribute for the drop-down menu of Windows SharePoint Services commands associated with list items is not supported.
Optional List Settings
Registration Type	Optional Text. Specifies the registration attachment for a per-item action. Possible values include: None, List, ContentType, ProgId, FileType
Registration Id	Optional Text. Specifies the identifier of the list or item content type that this action is associated with, or the file type or programmatic identifier (ProgID). Enter the list type (e.g. 101) or the content type (e.g.0x10).

• MSDN: Walkthrough: Add a Tab to the Server Ribbon
• MSDN: Server Ribbon XML
• MSDN: Default Server Ribbon Customization Locations

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.12. Ribbon Group

Name	Description
General Settings
Name	Required Text. Specifies the name of the button control.
Title	Required Text. The text to label the control.
Description	Required Text. The text that appears as the description of the tooltip.
Sequence	Required Integer. An integer that specifies the order of placement among sibling XML nodes.
Target Location Settings
Custom Action Location	Required Text. Location element of the custom action.
Optional Permission Settings
Rights	Optional Text. Specifies a set of rights that the user must have in order for the link to be visible. If not specified, then the action always appears in the list of actions. The set of rights are grouped logically according to AND logic.
Require Site Administrator	Optional Boolean. TRUE to specify that the item be displayed only if the user is a site administrator; otherwise, FALSE. Using the RequireSiteAdministrator attribute for the drop-down menu of Windows SharePoint Services commands associated with list items is not supported.
Optional List Settings
Registration Type	Optional Text. Specifies the registration attachment for a per-item action. Possible values include: None, List, ContentType, ProgId, FileType
Registration Id	Optional Text. Specifies the identifier of the list or item content type that this action is associated with, or the file type or programmatic identifier (ProgID). Enter the list type (e.g. 101) or the content type (e.g.0x10).
Location Settings
Parent Ribbon Tab	Required Text. Specifies the existing ribbon tab into which the new group should be added.

• MSDN: Walkthrough: Add a Group to the Server Ribbon
• MSDN: Server Ribbon XML
• MSDN: Default Server Ribbon Customization Locations

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.11. Ribbon Control

Name	Description
General Settings
Name	Required Text. Specifies the name of the button control.
Title	Required Text. The text to label the control.
Description	Required Text. The text that appears as the description of the tooltip.
Sequence	Required Integer. An integer that specifies the order of placement among sibling XML nodes.
Target Location Settings
Custom Action Location	Required Text. Location element of the custom action.
Optional Permission Settings
Rights	Optional Text. Specifies a set of rights that the user must have in order for the link to be visible. If not specified, then the action always appears in the list of actions. The set of rights are grouped logically according to AND logic.
Require Site Administrator	Optional Boolean. TRUE to specify that the item be displayed only if the user is a site administrator; otherwise, FALSE. Using the RequireSiteAdministrator attribute for the drop-down menu of Windows SharePoint Services commands associated with list items is not supported.
Optional List Settings
Registration Type	Optional Text. Specifies the registration attachment for a per-item action. Possible values include: None, List, ContentType, ProgId, FileType
Registration Id	Optional Text. Specifies the identifier of the list or item content type that this action is associated with, or the file type or programmatic identifier (ProgID). Enter the list type (e.g. 101) or the content type (e.g.0x10).
Location Settings
Parent Ribbon Group	Required Text. Specifies the existing ribbon group into which the new button should be added.
Control Settings
Type of Control	Required String. Specifies the type of control that should be added.

• MSDN: Walkthrough: Add a Button to the Server Ribbon
• MSDN: Server Ribbon XML
• MSDN: Default Server Ribbon Customization Locations

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.15. Sample: Add Ribbon Button to List Form

Name	Description
General Settings
Name	Required Text. Specifies the name of the button control.
Title	Required Text. The text to label the control.
Description	Required Text. The text that appears as the description of the tooltip.
Sequence	Required Integer. An integer that specifies the order of placement among sibling XML nodes.
Optional Permission Settings
Rights	Optional Text. Specifies a set of rights that the user must have in order for the link to be visible. If not specified, then the action always appears in the list of actions. The set of rights are grouped logically according to AND logic.
Require Site Administrator	Optional Boolean. TRUE to specify that the item be displayed only if the user is a site administrator; otherwise, FALSE. Using the RequireSiteAdministrator attribute for the drop-down menu of Windows SharePoint Services commands associated with list items is not supported.
Optional List Settings
List Type	Select the list type where the action should be added.
Location Settings
Parent Ribbon Group	Required Text. Specifies the existing ribbon group into which the new button should be added.

• MSDN: How to: Modify the User Interface Using Custom Actions
• MSDN: Server Ribbon XML
• MSDN: Default Server Ribbon Customization Locations

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.14. Sample: Add Ribbon Button to Item Form

Name	Description
General Settings
Name	Required Text. Specifies the name of the button control.
Title	Required Text. The text to label the control.
Description	Required Text. The text that appears as the description of the tooltip.
Sequence	Required Integer. An integer that specifies the order of placement among sibling XML nodes.
Optional Permission Settings
Rights	Optional Text. Specifies a set of rights that the user must have in order for the link to be visible. If not specified, then the action always appears in the list of actions. The set of rights are grouped logically according to AND logic.
Require Site Administrator	Optional Boolean. TRUE to specify that the item be displayed only if the user is a site administrator; otherwise, FALSE. Using the RequireSiteAdministrator attribute for the drop-down menu of Windows SharePoint Services commands associated with list items is not supported.
Form Settings
Custom Action Location	Required Text. Location element of the custom action.
Optional List Settings
List Type	Select the list type where the action should be added.
Location Settings
Parent Ribbon Group	Required Text. Specifies the existing ribbon group into which the new button should be added.

• MSDN: How to: Modify the User Interface Using Custom Actions
• MSDN: Server Ribbon XML
• MSDN: Default Server Ribbon Customization Locations

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.13. Sample: Add Ribbon Button to Content Type

In this sample a custom ribbon button is added to the edit form of the content type Document (0x0101). The following code adds the button to the actions group.
  
  <CustomAction
    Id="Ribbon.SP2010.VseWss.RibbonContentType"
    Location="CommandUI.Ribbon"
    Title="RibbonContentType"
    RegistrationType="ContentType"
    RegistrationId="0x0101">
    <CommandUIExtension>
      <CommandUIDefinitions>
        <CommandUIDefinition
          Location="Ribbon.DocLibListForm.Edit.Actions.Controls._children">
          <Button
            Id="Ribbon.SP2010.VseWss.RibbonContentType.Button"
            Command="SP2010.VseWss.RibbonContentType.ButtonCommand"
            Sequence="500"
            Image16by16="/_layouts/images/SP2010_VseWss/RibbonIcon_RibbonContentType_16.gif"
            Image32by32="/_layouts/images/SP2010_VseWss/RibbonIcon_RibbonContentType_32.gif"
            LabelText="ContentType Button"
            ToolTipTitle="ContentType Button"
            ToolTipDescription="Description of ContentType Button"
            TemplateAlias="o2" />
        </CommandUIDefinition>
      </CommandUIDefinitions>
      <CommandUIHandlers>
        <CommandUIHandler
          Command="SP2010.VseWss.RibbonContentType.ButtonCommand"
          CommandAction="javascript:alert('Hello, world');" />
      </CommandUIHandlers>
    </CommandUIExtension>
  </CustomAction>
        

Name	Description
General Settings
Name	Required Text. Specifies the name of the button control.
Title	Required Text. The text to label the control.
Description	Required Text. The text that appears as the description of the tooltip.
Sequence	Required Integer. An integer that specifies the order of placement among sibling XML nodes.
Optional Permission Settings
Rights	Optional Text. Specifies a set of rights that the user must have in order for the link to be visible. If not specified, then the action always appears in the list of actions. The set of rights are grouped logically according to AND logic.
Require Site Administrator	Optional Boolean. TRUE to specify that the item be displayed only if the user is a site administrator; otherwise, FALSE. Using the RequireSiteAdministrator attribute for the drop-down menu of Windows SharePoint Services commands associated with list items is not supported.
Form Settings
Custom Action Location	Required Text. Location element of the custom action.
Optional List Settings
Content Type	Select the content type where the action should be added.
Location Settings
Parent Ribbon Group	Required Text. Specifies the existing ribbon group into which the new button should be added.

• MSDN: How to: Modify the User Interface Using Custom Actions
• MSDN: Server Ribbon XML
• MSDN: Default Server Ribbon Customization Locations

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.16. Sample: Ribbon Tab with 3 buttons

Name	Description
General Settings
Name	Required Text. Specifies the name of the button control.
Title	Required Text. The text to label the control.
Description	Required Text. The text that appears as the description of the tooltip.
Sequence	Required Integer. An integer that specifies the order of placement among sibling XML nodes.
Target Location Settings
Custom Action Location	Required Text. Location element of the custom action.
Optional Permission Settings
Rights	Optional Text. Specifies a set of rights that the user must have in order for the link to be visible. If not specified, then the action always appears in the list of actions. The set of rights are grouped logically according to AND logic.
Require Site Administrator	Optional Boolean. TRUE to specify that the item be displayed only if the user is a site administrator; otherwise, FALSE. Using the RequireSiteAdministrator attribute for the drop-down menu of Windows SharePoint Services commands associated with list items is not supported.
Optional List Settings
Registration Type	Optional Text. Specifies the registration attachment for a per-item action. Possible values include: None, List, ContentType, ProgId, FileType
Registration Id	Optional Text. Specifies the identifier of the list or item content type that this action is associated with, or the file type or programmatic identifier (ProgID). Enter the list type (e.g. 101) or the content type (e.g.0x10).

• MSDN: Walkthrough: Add a Tab to the Server Ribbon
• MSDN: Server Ribbon XML
• MSDN: Default Server Ribbon Customization Locations

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.10. Hide Ribbon Control

Name	Description
Location settings
Parent Group	Required Text. Specifies the existing ribbon control which should be hidden.

• MSDN: Walkthrough: Remove a Button from the Server Ribbon
• MSDN: Server Ribbon XML
• MSDN: Default Server Ribbon Customization Locations

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.5. Event Receivers

2.1.1.2. Item Event Handler

Creates a ItemEventHandler.

Name	Description
Event Handler settings
Name	Required Text. Used as the class name of the event handler.
List Template	Optional Text. Specifies the index of the list template to which the event receiver applies. The following values are the default list template types.
List Template Owner	Optional GUID. Specifies the GUID of the list template owner if the list template is registered via Features, or the name of the site definition if the list template is registered by a site definition.
Sequence	Required Number. Specifies the order to use for the event registration when more than one handler is associated with the feature.
Registrations
Event Types	Select the event elements.
Optional Settings
RootWebOnly	Optional Boolean. True if the event receiver applies only to the root Web; otherwise, False.
Scope	Optional enumeration. The scope of the event receiver. This can be Site or Web. When the Scope attribute is set to Site, event receivers that are defined inside of a Feature that is scoped to the site collection are registered at the site collection level. When the Scope attribute is set to Web, event receivers that are defined inside of a Feature that is scoped to a Web are registered on the Web.
Synchronization	Specifies the synchronization of the event receiver.

• MSDN: Event Registrations
• MSDN: Event Troubleshooting
• MSDN: Walkthrough: Handling Document Library Events
• Dave Hunter's SharePoint Blog: Delving into SharePoint 2007 Event Receivers
• SharePoint Dev Wiki: Event Receivers

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.3. List Event Handler

Creates a ListEventHandler.

Name	Description
Event Handler settings
Name	Required Text. Used as the class name of the event handler.
List Template	Optional Text. Specifies the index of the list template to which the event receiver applies. The following values are the default list template types.
List Template Owner	Optional GUID. Specifies the GUID of the list template owner if the list template is registered via Features, or the name of the site definition if the list template is registered by a site definition.
Sequence	Required Number. Specifies the order to use for the event registration when more than one handler is associated with the feature.
Registrations
Event Types	Select the event elements.
Optional Settings
RootWebOnly	Optional Boolean. True if the event receiver applies only to the root Web; otherwise, False.
Scope	Optional enumeration. The scope of the event receiver. This can be Site or Web. When the Scope attribute is set to Site, event receivers that are defined inside of a Feature that is scoped to the site collection are registered at the site collection level. When the Scope attribute is set to Web, event receivers that are defined inside of a Feature that is scoped to a Web are registered on the Web.
Synchronization	Specifies the synchronization of the event receiver.

• MSDN: Event Registrations
• MSDN: Event Troubleshooting
• MSDN: Walkthrough: Handling Document Library Events
• Dave Hunter's SharePoint Blog: Delving into SharePoint 2007 Event Receivers
• SharePoint Dev Wiki: Event Receivers

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.4. Web Event Handler

Event handlers for sites and webs must be registered with a feature receiver

Name	Description
Event Handler settings
Name	Required Text. Used as the class name of the event handler.
List Template	Optional Text. Specifies the index of the list template to which the event receiver applies. The following values are the default list template types.
List Template Owner	Optional GUID. Specifies the GUID of the list template owner if the list template is registered via Features, or the name of the site definition if the list template is registered by a site definition.
Sequence	Required Number. Specifies the order to use for the event registration when more than one handler is associated with the feature.
Registrations
Event Types	Select the event elements.
Optional Settings
RootWebOnly	Optional Boolean. True if the event receiver applies only to the root Web; otherwise, False.
Scope	Optional enumeration. The scope of the event receiver. This can be Site or Web. When the Scope attribute is set to Site, event receivers that are defined inside of a Feature that is scoped to the site collection are registered at the site collection level. When the Scope attribute is set to Web, event receivers that are defined inside of a Feature that is scoped to a Web are registered on the Web.
Synchronization	Specifies the synchronization of the event receiver.

• MSDN: Event Registrations
• MSDN: Event Troubleshooting
• MSDN: Walkthrough: Handling Document Library Events
• Dave Hunter's SharePoint Blog: Delving into SharePoint 2007 Event Receivers
• SharePoint Dev Wiki: Event Receivers

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.1. Email Event Handler

Debugging of email events requires attaching to ows timer service.
After changing code the ows timer needs to be restarted. IISReset will not load new assembly to ows timer.

Name	Description
Event Handler settings
Name	Required Text. Used as the class name of the event handler.
List Template	Optional Text. Specifies the index of the list template to which the event receiver applies. The following values are the default list template types.
List Template Owner	Optional GUID. Specifies the GUID of the list template owner if the list template is registered via Features, or the name of the site definition if the list template is registered by a site definition.
Sequence	Required Number. Specifies the order to use for the event registration when more than one handler is associated with the feature.
Registrations
Event Types	Select the event elements.
Optional Settings
RootWebOnly	Optional Boolean. True if the event receiver applies only to the root Web; otherwise, False.
Scope	Optional enumeration. The scope of the event receiver. This can be Site or Web. When the Scope attribute is set to Site, event receivers that are defined inside of a Feature that is scoped to the site collection are registered at the site collection level. When the Scope attribute is set to Web, event receivers that are defined inside of a Feature that is scoped to a Web are registered on the Web.
Synchronization	Specifies the synchronization of the event receiver.

• MSDN: Event Registrations
• MSDN: Event Troubleshooting
• MSDN: Walkthrough: Handling Document Library Events
• Dave Hunter's SharePoint Blog: Delving into SharePoint 2007 Event Receivers
• SharePoint Dev Wiki: Event Receivers

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.6. WebParts

2.1.1.5. SharePoint Web Part

Web Parts are server-side controls that run inside the context of special pages (that is, Web Part Pages) within an ASP.NET application or a Windows SharePoint Services site.
They are the "building blocks" of pages in Windows SharePoint Services.
Windows SharePoint Services includes built-in Web Parts that you can use as soon as you have installed the product.
In addition, you can build your own Web Parts and deploy them to the server. (MSDN)

Name	Description
Web Part Information
Web Part Name	Enter the name of the web part. The name will be used for the class name (.cs).
Web Part Title	Enter the title of the web part (displayed in the web part gallery as web part title).
Web Part Description	Enter the description of the web part (displayed in the web part gallery as web part description).
Group	Enter the group in which the web part should appear in web part gallery.
QuickAdd Group	Enter the quick add group in which the web part should appear when the user wants to add a web part to a page.

• MSDN: Web Parts Overview
• MSDN: Walkthrough: Creating a Basic SharePoint Web Part
• MSDN: Walkthrough: Creating Connectable Web Parts in Windows SharePoint Services

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.2. ASP Web Part

Adds a web part to the project derived from System.Web.UI.WebControls.WebParts.WebPart.
Creating this kind of webpart allows reuse in non-SharePoint ASP WebPages, but also lacks the SharePoint specific additions, like caching.

Name	Description
Web Part Information
Web Part Name	Enter the name of the web part. The name will be used for the class name (.cs).
Web Part Title	Enter the title of the web part (displayed in the web part gallery as web part title).
Web Part Description	Enter the description of the web part (displayed in the web part gallery as web part description).
Group	Enter the group in which the web part should appear in web part gallery.
QuickAdd Group	Enter the quick add group in which the web part should appear when the user wants to add a web part to a page.

• MSDN: Web Parts Overview
• MSDN: Walkthrough: Creating a Basic Web Part
• MSDN Walkthrough: Creating Connectable Web Parts in Windows SharePoint Services

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.7. Visual Web Part

Creates a new webpart based on the SmartPart project.
The SharePoint web part which can host any ASP.NET web user control.

Name	Description
Web Part Information
Web Part Name	Enter the name of the web part. The name will be used for the class name (.cs).
Web Part Title	Enter the title of the web part (displayed in the web part gallery as web part title).
Web Part Description	Enter the description of the web part (displayed in the web part gallery as web part description).
Group	Enter the group in which the web part should appear in web part gallery.
QuickAdd Group	Enter the quick add group in which the web part should appear when the user wants to add a web part to a page.

• Issues with LoadControl

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.1. Sample: Ajax Web Part

This recipe adsda an Ajax enabled webpart to your project.
Postback will be handled without loading the entire page.
Note: AJAX.net has to be installed on the server.

Name	Description
Web Part Information
Web Part Name	Enter the name of the web part. The name will be used for the class name (.cs).
Web Part Title	Enter the title of the web part (displayed in the web part gallery as web part title).
Web Part Description	Enter the description of the web part (displayed in the web part gallery as web part description).
Group	Enter the group in which the web part should appear in web part gallery.
QuickAdd Group	Enter the quick add group in which the web part should appear when the user wants to add a web part to a page.

• MSDN: Web Parts Overview
• MSDN: ASP.NET AJAX in Windows SharePoint Services
• MSDN: Walkthrough: Creating a Basic ASP.NET AJAX-enabled Web Part

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.6. Sample: Simple Filter Consumer Web Part

Windows SharePoint Services 3.0 uses the ASP.NET Web Part connection framework to connect Web Parts to each other programmatically.
Filter Web Parts use this connectivity support to provide filter criteria to other Web Parts.
Developers can now allow users to provide search or filter criteria.
Web Part connections are based on the concepts of "providers" and "consumers."
A provider Web Part supplies information to one or more consumer Web Parts through a programmatic interface. (MSDN)

Name	Description
Web Part Information
Web Part Name	Enter the name of the web part. The name will be used for the class name (.cs).
Web Part Title	Enter the title of the web part (displayed in the web part gallery as web part title).
Web Part Description	Enter the description of the web part (displayed in the web part gallery as web part description).
Group	Enter the group in which the web part should appear in web part gallery.
QuickAdd Group	Enter the quick add group in which the web part should appear when the user wants to add a web part to a page.

• MSDN: Filter Web Parts Overview
• MSDN: Walkthrough: Writing a Simple Filter Consumer Web Part Sample

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.3. Sample: Filter Consumer Web Part

Windows SharePoint Services 3.0 uses the ASP.NET Web Part connection framework to connect Web Parts to each other programmatically.
Filter Web Parts use this connectivity support to provide filter criteria to other Web Parts.
Developers can now allow users to provide search or filter criteria.
Web Part connections are based on the concepts of "providers" and "consumers."
A provider Web Part supplies information to one or more consumer Web Parts through a programmatic interface. (MSDN)

Name	Description
Web Part Information
Web Part Name	Enter the name of the web part. The name will be used for the class name (.cs).
Web Part Title	Enter the title of the web part (displayed in the web part gallery as web part title).
Web Part Description	Enter the description of the web part (displayed in the web part gallery as web part description).
Group	Enter the group in which the web part should appear in web part gallery.
QuickAdd Group	Enter the quick add group in which the web part should appear when the user wants to add a web part to a page.

• MSDN: How to: Consume the Multi-Select CheckBox Filter Web Part

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.4. Sample: Filter Provider Web Part

Windows SharePoint Services 3.0 uses the ASP.NET Web Part connection framework to connect Web Parts to each other programmatically.
Filter Web Parts use this connectivity support to provide filter criteria to other Web Parts.
Developers can now allow users to provide search or filter criteria.
Web Part connections are based on the concepts of "providers" and "consumers."
A provider Web Part supplies information to one or more consumer Web Parts through a programmatic interface. (MSDN)

Name	Description
Web Part Information
Web Part Name	Enter the name of the web part. The name will be used for the class name (.cs).
Web Part Title	Enter the title of the web part (displayed in the web part gallery as web part title).
Web Part Description	Enter the description of the web part (displayed in the web part gallery as web part description).
Group	Enter the group in which the web part should appear in web part gallery.
QuickAdd Group	Enter the quick add group in which the web part should appear when the user wants to add a web part to a page.

• MSDN: How to: Write a Multi-Select CheckBox Filter Web Part

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.7. Field Types

2.1.1.1. Field Type

As you store your business information in Windows SharePoint Services 3.0, you may encounter instances where your important business data does not conform to the field types included in Windows SharePoint Services, or situations where you want to further customize those general field types.
Windows SharePoint Services enables you to create custom field types.
These custom fields can include custom data validation and custom field rendering.
You can also customize the way that variable properties of your custom field types are processed and rendered when users set property variables and create new columns that are based on your custom field type.

This recipe adds a simple Field Type to your project.

Name	Description
Field Type Name	Required Text. Name of the Field Type. Limited to 255 characters. The name has to be unique within the project of this solution. It should not contain whitespaces or special characters.
Parent Type	Required Type. The parent field type from which this type will inherit.
Display Name	Required Text. The display name for this field type.
Description	Required Text. Longer description about the purpose of the field type (will be displayed in "Create Column" next to the field selector).

• MSDN: Custom Field Types
• MSDN: Custom Field Type Property Rendering
• MSDN: Editor Controls for Field Type Properties
• MSDN: Custom Field Type Definition
• MSDN: Custom Field Classes
• Travis Lingenfelder: Overview of Custom Field Types in WSS 3.0

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.3. Sample: Field Type with Complex Value

As you store your business information in Windows SharePoint Services 3.0, you may encounter instances where your important business data does not conform to the field types included in Windows SharePoint Services, or situations where you want to further customize those general field types.
Windows SharePoint Services enables you to create custom field types.
These custom fields can include custom data validation and custom field rendering.
You can also customize the way that variable properties of your custom field types are processed and rendered when users set property variables and create new columns that are based on your custom field type.

This recipe adds a MultiColumn Field Type to your project.

Name	Description
Field Type Name	Required Text. Name of the Field Type. Limited to 255 characters. The name has to be unique within the project of this solution. It should not contain whitespaces or special characters.
Description	Required Text. Longer description about the purpose of the field type (will be displayed in "Create Column" next to the field selector).
Display Name in column 'Type'	Required Text. The display name for this field type.

• MSDN: Custom Field Types
• MSDN: Custom Field Type Property Rendering
• MSDN: Editor Controls for Field Type Properties
• MSDN: Custom Field Type Definition
• MSDN: Custom Field Classes
• Travis Lingenfelder: Overview of Custom Field Types in WSS 3.0

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.6. Sample: Field Type with Multiple Columns

As you store your business information in Windows SharePoint Services 3.0, you may encounter instances where your important business data does not conform to the field types included in Windows SharePoint Services, or situations where you want to further customize those general field types.
Windows SharePoint Services enables you to create custom field types.
These custom fields can include custom data validation and custom field rendering.
You can also customize the way that variable properties of your custom field types are processed and rendered when users set property variables and create new columns that are based on your custom field type.

This recipe adds a simple Field Type to your project.

Name	Description
Field Type Name	Required Text. Name of the Field Type. Limited to 255 characters. The name has to be unique within the project of this solution. It should not contain whitespaces or special characters.
Description	Required Text. Longer description about the purpose of the field type (will be displayed in "Create Column" next to the field selector).
Display Name in column 'Type'	Required Text. The display name for this field type.

• MSDN: Custom Field Types
• MSDN: Custom Field Type Property Rendering
• MSDN: Editor Controls for Field Type Properties
• MSDN: Custom Field Type Definition
• MSDN: Custom Field Classes
• Travis Lingenfelder: Overview of Custom Field Types in WSS 3.0

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.2. Sample: Field Type with Status Choice

As you store your business information in Windows SharePoint Services 3.0, you may encounter instances where your important business data does not conform to the field types included in Windows SharePoint Services, or situations where you want to further customize those general field types
Windows SharePoint Services enables you to create custom field types.
These custom fields can include custom data validation and custom field rendering.
You can also customize the way that variable properties of your custom field types are processed and rendered when users set property variables and create new columns that are based on your custom field type.

This recipe adds a simple Field Type to your project.

Name	Description
Field Type Name	Required Text. Name of the Field Type. Limited to 255 characters. The name has to be unique within the project of this solution. It should not contain whitespaces or special characters.
Description	Required Text. Longer description about the purpose of the field type (will be displayed in "Create Column" next to the field selector).
Display Name in column 'Type'	Required Text. The display name for this field type.

• MSDN: Custom Field Types for SharePoint 2007 by Ted Pattison

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.5. Sample: Field Type for ISBN10

As you store your business information in Windows SharePoint Services 3.0, you may encounter instances where your important business data does not conform to the field types included in Windows SharePoint Services, or situations where you want to further customize those general field types.
Windows SharePoint Services enables you to create custom field types.
These custom fields can include custom data validation and custom field rendering.
You can also customize the way that variable properties of your custom field types are processed and rendered when users set property variables and create new columns that are based on your custom field type.

This recipe adds a simple Field Type to your project.

Name	Description
Field Type Name	Required Text. Name of the Field Type. Limited to 255 characters. The name has to be unique within the project of this solution. It should not contain whitespaces or special characters.
Description	Required Text. Longer description about the purpose of the field type (will be displayed in "Create Column" next to the field selector).
Display Name in column 'Type'	Required Text. The display name for this field type.

• MSDN: Custom Field Types for SharePoint 2007 by Ted Pattison

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.8. Sample: Field Type for Social Security Number

As you store your business information in Windows SharePoint Services 3.0, you may encounter instances where your important business data does not conform to the field types included in Windows SharePoint Services, or situations where you want to further customize those general field types.
Windows SharePoint Services enables you to create custom field types.
These custom fields can include custom data validation and custom field rendering.
You can also customize the way that variable properties of your custom field types are processed and rendered when users set property variables and create new columns that are based on your custom field type.

This recipe adds a simple Field Type to your project.

Name	Description
Field Type Name	Required Text. Name of the Field Type. Limited to 255 characters. The name has to be unique within the project of this solution. It should not contain whitespaces or special characters.
Description	Required Text. Longer description about the purpose of the field type (will be displayed in "Create Column" next to the field selector).
Display Name in column 'Type'	Required Text. The display name for this field type.

• MSDN: Custom Field Types
• MSDN: Custom Field Type Property Rendering
• MSDN: Editor Controls for Field Type Properties
• MSDN: Custom Field Type Definition
• MSDN: Custom Field Classes
• Travis Lingenfelder: Overview of Custom Field Types in WSS 3.0

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.4. Sample: Field Type for Flash Movie

As you store your business information in Windows SharePoint Services 3.0, you may encounter instances where your important business data does not conform to the field types included in Windows SharePoint Services, or situations where you want to further customize those general field types.
Windows SharePoint Services enables you to create custom field types.
These custom fields can include custom data validation and custom field rendering.
You can also customize the way that variable properties of your custom field types are processed and rendered when users set property variables and create new columns that are based on your custom field type.

This recipe adds a simple Field Type to your project.

Name	Description
Field Type Name	Required Text. Name of the Field Type. Limited to 255 characters. The name has to be unique within the project of this solution. It should not contain whitespaces or special characters.
Description	Required Text. Longer description about the purpose of the field type (will be displayed in "Create Column" next to the field selector).
Display Name in column 'Type'	Required Text. The display name for this field type.

• MSDN: Custom Field Types for SharePoint 2007 by Ted Pattison

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.7. Sample: Field Type for Ratings

As you store your business information in Windows SharePoint Services 3.0, you may encounter instances where your important business data does not conform to the field types included in Windows SharePoint Services, or situations where you want to further customize those general field types.
Windows SharePoint Services enables you to create custom field types.
These custom fields can include custom data validation and custom field rendering.
You can also customize the way that variable properties of your custom field types are processed and rendered when users set property variables and create new columns that are based on your custom field type.

This recipe adds a simple Field Type to your project.

Name	Description
Field Type Name	Required Text. Name of the Field Type. Limited to 255 characters. The name has to be unique within the project of this solution. It should not contain whitespaces or special characters.
Description	Required Text. Longer description about the purpose of the field type (will be displayed in "Create Column" next to the field selector).
Display Name in column 'Type'	Required Text. The display name for this field type.

• MSDN: Custom Field Types for SharePoint 2007 by Ted Pattison

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.8. Publishing

2.1.1.3. Publishing Site Definition

The publishing site definition creates a site with the publishing infrastructure and publishing site feature enabled and provides functionalities for web content management.
It creates three features which are required to activate the several components of the publishing site.

Name	Description
Site Template settings
Name	Required Text. Specify the name of the folder which will be created in folder SiteTemplates. Limited to 255 characters. The name has to be unique within the project of this solution. It should not contain whitespaces or special characters.
Title	Required Text. Title of the site template as it appears in the selection of Create Site dialog. Limited to 255 characters.
ID	Required Number. Id of the site template. Should be unique on the farm and greater than 10000.
Description	Required Text. Longer description of the purpose of this site definition.
Display Category	Required Text. Title of the cateogry in which the site definition should appear in the Create Site dialog. Limited to 255 characters.
Master Page Settings
Name	Required Text. Name of the Master Page. Limited to 255 characters. The name has to be unique within the project of this solution. It should not contain whitespaces or special characters.
Title	Required Text. Title (friendly name) of the Page Layout. Limited to 255 characters.
Description	Optional Text. Description of the Master Page.
Page Layout Settings
Page Layout Content Type	Required Content Type. Content Type of this Page Layout.
Name	Required Text. Name of the Page Layout class file. Limited to 255 characters. The name has to be unique within the project of this solution. It should not contain whitespaces or special characters.
Title	Required Text. Title (friendly name) of the Page Layout. Limited to 255 characters.
Description	Optional Text. Description of the Page Layout.
Options
Create Provisioning XML	Optional Boolean. If TRUE creates a file named Portal.XML with XML data for the creation of subsites after provisioning this site template.
Create Provisioning Handler (.cs)	Optional Boolean. If TRUE creates a cs.file for handling the event of provisioning.
Hidden	Optional Boolean. If TRUE hides the site definition from the Create Site dialog. Creation of sites with this definition through code will be still possible.
Allow global Feature associations	Optional Boolean. If TRUE the site definition is allowed to be associated to global features.
Root Web Only	Optional Boolean. If TRUE the site created from the configuration can only exist as the root Web site in a site collection. This attribute is not enforced in site templates (.stp files).
Sub Web Only	Optional Boolean. If TRUE tthe site created from the configuration can only exist as a subsite within a site collection.

• .Net Journal: Creating Custom Site Definitions in Microsoft Windows SharePoint Services
• MSDN: Real World Branding with SharePoint Server 2007 Publishing Sites
• MSDN: Configuration Node
• MSDN: Schema Onet.xml

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.1. Master Page

Name	Description
Master Page Settings
Name	Required Text. Name of the Master Page. Limited to 255 characters. The name has to be unique within the project of this solution. It should not contain whitespaces or special characters.
Title	Required Text. Title (friendly name) of the Master Page. Limited to 255 characters.
Description	Optional Text. Description of the Master Page.

• MSDN: Page Layouts and Master Pages
• MSDN: Page Layout Class
• Heather Solomon: MOSS 2007 Design Component Relationships and Diagrams

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.2. Page Layout

The recipe creates a page layout, which can be made available in a publising site for a specific content type (i.e. news).
Page layouts dictate, along with master pages, the overall look and feel of your SharePoint Publishing site.
Master pages contain controls that are shared across multiple page layouts, such as navigation, search, or language-preference for multilingual sites.
Page layouts contain field controls and Web Parts.

Name	Description
Page Layout Settings
Page Layout Content Type	Required Content Type. Content Type of this Page Layout.
Name	Required Text. Name of the Page Layout class file. Limited to 255 characters. The name has to be unique within the project of this solution. It should not contain whitespaces or special characters.
Title	Required Text. Title (friendly name) of the Page Layout. Limited to 255 characters.
Description	Optional Text. Description of the Page Layout.

• MSDN: Page Layouts and Master Pages
• MSDN: Page Layout Class
• Heather Solomon: MOSS 2007 Design Component Relationships and Diagrams

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.9. Import

2.1.1.2. Import .wsp solution

This recipes imports a single .wsp file from the local system into an existing project. To run the recipe an existing customization project is needed.

Name	Description
WSP File	Select the wsp file to be imported into the current project

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.3. Import .wsp solution from local farm

This recipes imports a single .wsp file from the local SharePoint farm into an existing project. To run the recipe an existing customization project is needed.

Name	Description
WSP Solution	Select the wsp from the local farm for the import

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.1. Import Content Type

Name	Description
Content Type Settings
ID	Required Text. Specifies the content type ID of the content type.
Name	Required Text. Specifies the content type name.
Description	Optional Text. Provides a description for the content type, to display in the Windows SharePoint Services user interface.
Group	Optional Text. Specifies the content type group to which the content type is assigned. Content type groups are user-defined groups that help you organize your columns into logical categories.
Version	Reserved for future use.
Hidden	Optional Boolean. TRUE to define the content type as hidden. If you define a content type as hidden, Windows SharePoint Services does not display that content type on the New button in list views. If you do not include this attribute, Windows SharePoint Services treats the content type as if this attributes was set to FALSE.
Read Only	Optional Boolean. TRUE to define the content type as read-only. If you do not include this attribute, Windows SharePoint Services treats the content type as if this attributes was set to FALSE.
Sealed	Optional Boolean. TRUE to define the content type as sealed. You must have site collection administrator rights to unseal and edit a content type defined as sealed. If you do not include this attribute, Windows SharePoint Services treats the content type as if this attributes was set to FALSE.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.6. Import Site Column

Name	Description
Site Column Settings
ID
Name
Display Name
Description
Group

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.5. Import List Definition

Name	Description
List Template Settings
Name	Required Text. Specifies the internal name of the list definition. No spaces or special characters can be used. This name is also used to find the folder that contains the Schema.xml file that defines the schema in use.
DisplayName	Required Text. Specifies the display name of the list definition.
Description	Optional Text. Provides a description of the list definition.
Type	Optional Integer. Provides a unique identifier for the template. This identifier must be unique within the feature, but need not be unique across all feature definitions or site definitions.
Category	Optional Text. Specifies the category with which to associate lists created through the list definition.
Sequence	Optional Integer. Specifies the ordering priority to use for the list template on the Create page. If Sequence is not set, the template appears last in arbitrary order with any other templates that also lack a Sequence value. Two templates that specify the same sequence are sorted together in an arbitrary order.
Options
Default in new sites	Optional Boolean. TRUE to specify that new SharePoint sites will include this list.
OnQuickLaunch	Optional Boolean. TRUE to display lists created from the list definition on the QuickLaunch bar.
DisableAttachments	Optional Boolean. TRUE to specify that users can attach files to items in lists created through the template; otherwise, FALSE.
DisallowContentTypes	Optional Boolean. TRUE to specify that content types can be managed on lists created through the template; otherwise, FALSE.
VersioningEnabled	Optional Boolean. TRUE to specify that versioning is enabled by default in lists created through the template; otherwise, FALSE.
FolderCreation	Optional Boolean. TRUE to enable folder creation within the list and to specify that the New Folder command appears on the New menu in list views; otherwise, FALSE.
EnableModeration	Optional Boolean. TRUE to specify that content approval is enabled by default in lists created through the template; otherwise, FALSE.
Hidden	Optional Boolean. TRUE to specify that the list definition is not available on the Create page for creating lists.
HiddenList	Optional Boolean. TRUE to specify that a list created from the list definition is hidden.
Advanced
Security Read	Optional Text. Defines the item-level permissions in the list for users with sufficient permission to read or edit list items. The SecurityBits attribute contains a 2-digit string. The first digit in the string controls the read access; the second digit in the string controls the edit access.
Security Edit	Optional Text. Defines the item-level permissions in the list for users with sufficient permission to read or edit list items. The SecurityBits attribute contains a 2-digit string. The first digit in the string controls the read access; the second digit in the string controls the edit access.
Name	Optional URL. Specifies a URL to an icon used to represent a list.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.4. Import List Instance

Name	Description
List Instance Settings
Title	Required Text. Title of the list in the schema.
Description	Optional Text. Contains a description of the list.
Url	Required Text. Returns the site-relative URL at which to place the list.
Options
RootWebOnly	Optional Boolean. TRUE to specify that the list created from the definition exists only in the root Web site of a site collection.
OnQuickLaunch	Optional Boolean. TRUE to display lists created from the list definition on the Quick Launch bar.
QuickLaunchUrl	Optional Text. Specifies the URL of the view page to open for the list through Quick Launch navigation.
Id	Required Text. Specifies a unique identifier for the list instance. The integer must be unique across the Feature definition.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.10. Application Pages

2.1.1.3. Unrestricted Layouts Page

Name	Description
Page Name	Enter name of the application page without extension (.aspx)
Title	Enter the title of page (displayed on top of the page and in the title of the html).
Description	Enter the description of page (displayed on top of the page).
Allow Anonymous Access

• UnsecuredApplicationPage

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.2. Application Page

Name	Description
Name	Enter the name of the application page (without .aspx).
Title	Enter the title of page (displayed on top of the page and in the title of the html).
Description	Enter the description of page (displayed on top of the page).

• ApplicationPage

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.1. Administration Page

Name	Description
Name	Enter the name of the application page (without .aspx).
Title	Enter the title of page (displayed on top of the page and in the title of the html).
Description	Enter the description of page (displayed on top of the page).

• AdministrationPage

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.11. ASP.NET

2.1.1.2. Custom Control

Name	Description
Name	Enter the name of the control (used as class name of the control).

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.8. Create WSDL and DISCO

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.7. Webservice

Name	Description
Name	Required String. Enter the name of the web service.
Description	Required String. Enter the description of the web service.

• MSDN: Walkthrough: Creating a Custom Web Service

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.1. Administration Web Service

Name	Description
Name	Required String. Enter the name of the web service.
Description	Required String. Enter the description of the web service.

• MSDN: Walkthrough: Creating a Custom Web Service

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.3. Delegate Control (.ASCX)

* AdditionalPageHead
* GlobalSiteLink0
* GlobalSiteLink1
* GlobalSiteLink2
* SmallSearchInputBox
* TopNavigationDataSource
* PublishingConsole
* QuickLaunchDataSource

Name	Description
Delegate Control Settings
Name	Required Text. Specifies the name of the control.
Sequence	Optional Integer. Specifies the sequence number for the control, which determines whether the control is added to the control tree for a page. The control with the lowest sequence number is added to the tree.
Id	Optional Text. Specifies the ID of the control, for example, "SmallSearchInputBox".

• MSDN: Control Element (Delegate Control)
• MSDN: How to: Customize a Delegate Control
• Using the Delegate Control to Add Meta Tags to SharePoint Pages

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.4. Delegate Control (.CS)

* AdditionalPageHead
* GlobalSiteLink0
* GlobalSiteLink1
* GlobalSiteLink2
* SmallSearchInputBox
* TopNavigationDataSource
* PublishingConsole
* QuickLaunchDataSource

Name	Description
Delegate Control Settings
Name	Required Text. Specifies the name of the control.
Sequence	Optional Integer. Specifies the sequence number for the control, which determines whether the control is added to the control tree for a page. The control with the lowest sequence number is added to the tree.
Id	Optional Text. Specifies the ID of the control, for example, "SmallSearchInputBox".

• MSDN: Control Element (Delegate Control)
• MSDN: How to: Customize a Delegate Control
• Using the Delegate Control to Add Meta Tags to SharePoint Pages

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.5. Http Handler

Name	Description
HttpHandler Settings
Http Handler Name	Enter the class name of the Http handler.
Http Handler Path	Enter path for which urls the http handler should be called, e.g. */_vti_bin/_vti_aut/author.dll

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.6. Http Module

The Http module assembly needs to be registered in web.config. Therefore the Http module needs to be added to a feature with scope WebApplication and the necessary activation code is added to the feature receiver of the selected feature.

Name	Description
HttpModule Settings
Http Module Name

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.12. Workflows

2.1.1.1. Simple Workflow

Name	Description
Workflow Settings
Name	Required Text. Specifies the workflow name that is displayed in the SharePoint Foundation interface. The workflow name can be up to 256 characters long.
Title	Optional Text.
Description	Optional Text. Specifies the workflow description to be displayed in the SharePoint Foundation interface. The workflow description can be up to 256 characters long.
Id	Required Text. Specifies the globally unique identifier (GUID) for the workflow.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.13. Advanced

2.1.1.4. web.config Modification

In some occasions modifications of the web.config are required when activating a feature i.e. defining web application wide configuration settings.
A web.config modification feature can be utilized to make the neccessary configurations and undo them when the feature is deactivated.

• MSDN: SPWebConfigModification Class
• Mark Wagner: How To: Modify the web.config file in SharePoint using SPWebConfigModification
• Reza Alirezaei: SPWebConfigModification’s Top 6 Issues

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.5. Web Provisioning Provider

Name	Description
Class Name	Required Text. Name of the SPWebProvisioningProvider.

• SPWebProvisioningProvider Class

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.3. Timer Job Definition

Windows SharePoint Services 3.0 lets you create custom jobs that are executed at set intervals. These jobs, known as timer jobs, are similar to those tasks that you can create in any version of Windows by using the Task Scheduler application. This capability is useful for scheduled process jobs because you keep everything in Windows SharePoint Services rather than create a console .exe file that is configured to run at set intervals by using the Windows Task Scheduler. The major benefits to using the Windows SharePoint Services timer service compared to using Windows Task Scheduler is that the timer service knows the topology of the Office SharePoint Server farm, and that you can load balance the jobs across all the servers in the farm or tie them to specific servers that are running particular services. (Source: MSDN).
    
You can run the timer job e.g. in a feature receiver during feature activation or deactivation.
    
Use the following code to start the timer job.
<code>
namespace ApplicationName.WSPSolution
{
public partial class EmptyFeature1FeatureReceiver : SPFeatureReceiver
{
public override void FeatureActivated(SPFeatureReceiverProperties properties)
{
TimerJob1.StartJob("param Value 1", "param Value 2");
}
}
}
</code>

Name	Description
Timer Job Class	Required Text. Name of the Timer Job class file.

• MSDN: Creating, Deploying, and Debugging Custom Timer Jobs in Windows SharePoint Services 3.0
• Andrew Connell: Creating Custom SharePoint Timer Jobs

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.1. Alert Template

Alerts are an e-mail subscription notification service in Windows SharePoint Services 3.0. Users can create alerts to be notified of changes to list items (item level alert), documents, lists (list level alert), or document libraries. Alerts in Windows SharePoint Services 3.0 are quite flexible; when you create an alert you have options such as when to be notified and what kind of changes will trigger the alert. Alerts can be managed by users and administrators and customized by developers.

After an alert has been created, changes that fit the criteria specified in the alert are recorded in an event log. Alerts are generated by a timer job that reads the event log, formats the alert email using an alert template, and then sends that email out to the user.

Alert templates are stored in Alerttemplates.xml. Alerttemplates.xml defines the format, contents, and properties used to create alert messages from each list type in Windows SharePoint Services 3.0. Developers can customize alerts by modifying a copy of Alerttemplates.xml and then loading the customized alert templates using the stsadm -o updatealerttemplates command.
(Source: Microsoft SharePoint Developer Documentation Team Blog)

This recipe creates such an alert template.

• MS SharePoint Developer Documentation Team Blog: Customizing Alert Notifications and Alert Templates in Windows SharePoint Services 3.0
• MS SharePoint Developer Documentation Team Blog: How To: Customizing alert emails using IAlertNotifyHandler

• Torsten Mandelkow
• Matthias Einig

• 1.1 Updated Documentation
• 1.0 Initial Recipe

2.1.1.2. Minimal CAS

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.14. Files

2.1.1.4. Add Assembly for GAC Deployment

GAC assemblies are deployed to the GAC and are globally available. In manifest.xml they are located here:

<Solution xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" SolutionId="00000000-0000-0000-0000-000000000000" ResetWebServer="True" xmlns="http://schemas.microsoft.com/sharepoint/">
 <Assemblies>
  <Assembly Location="WebPartResources.dll" DeploymentTarget="GlobalAssemblyCache">
   <SafeControls>
    <SafeControl Assembly="WebPartResources, Version=1.0.0.0, Culture=neutral, PublicKeyToken=6763c0814d065309" Namespace="WebPartResources" TypeName="*" Safe="True" />
   </SafeControls>
  </Assembly>
 </Assemblies>
</Solution>

Name	Description
Source Files

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.5. Add Global Resource file (.resx)

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.2. Add Assembly for Webapplication Deployment

WebApplication assemblies are added to the project to folder 80/BIN. In manifest.xml these files are located here:

<Solution xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" SolutionId="00000000-0000-0000-0000-000000000000" ResetWebServer="True" xmlns="http://schemas.microsoft.com/sharepoint/">
 <Assemblies>
  <Assembly Location="WebPartResources.dll" DeploymentTarget="WebApplication">
   <SafeControls>
    <SafeControl Assembly="WebPartResources, Version=1.0.0.0, Culture=neutral, PublicKeyToken=6763c0814d065309" Namespace="WebPartResources" TypeName="*" Safe="True" />
   </SafeControls>
  </Assembly>
 </Assemblies>
</Solution>

After deployment these files get deployed to folder \inetpub\wwwroot\wss\VirtualDirectories\80\bin

Name	Description
Source Files

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.3. Add Class Resource Files

Class resource files are added to the project in folder 80/BIN/wpresources/[NameOfAssembly]. In manifest.xml these files are deployed to

<Solution xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" SolutionId="00000000-0000-0000-0000-000000000000" ResetWebServer="True" xmlns="http://schemas.microsoft.com/sharepoint/">
 <Assemblies>
  <Assembly Location="WebPartResources.dll" DeploymentTarget="GlobalAssemblyCache">
   <SafeControls>
    <SafeControl Assembly="WebPartResources, Version=1.0.0.0, Culture=neutral, PublicKeyToken=6763c0814d065309" Namespace="WebPartResources" TypeName="*" Safe="True" />
   </SafeControls>
   <ClassResources>
    <ClassResource Location="testfile.gif" FileName="testfile.gif" />
   </ClassResources>
  </Assembly>
 </Assemblies>
</Solution>

After deployment these files are located here.
For assemblies in GAX: C:\Program Files\Common Files\Microsoft Shared\web server extensions\wpresources\WebPartResources\1.0.0.0__6763c0814d065309\testfile.gif
For assemblies in BIN: C:\inetpub\wwwroot\wss\VirtualDirectories\80\wpresources\1.0.0.0__6763c0814d065309\testfile.gif

In code you can access there files:

SPWeb currentWeb = SPControl.GetContextWeb(Context);
Type currentType = this.GetType();
string classResourcePath = SPWebPartManager.GetClassResourcePath(currentWeb, currentType);  
image = new Image();
image.ImageUrl = classResourcePath + "/testfile.gif";

The file could also be access via URL:

http://servername/_wpresources/[assemblyname]/testfile.gif

Name	Description
Source Files

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.1. Add Application Resource Files

Application resource files are mainly used for .resx files in application pages. They are deployed to folder VirtualDirectories\80\App_GlobalResources of a web application.

This functionality only works in SharePoint 2010. In earlier versions files could not be deployed to VirtualDirectories\80\App_GlobalResources with wsp solutions.

In SharePoint 2010 application resource files are deployed with wsp solutions to folder 12/CONFIG/Resources/ and copied to VirtualDirectories\80\App_GlobalResources with stsadm -o copyappbincontent.

Alternatively these files could be copied with a feature receiver:
- For Central Administration resources (and sitemaps): SPWebService.AdministrationService.ApplyApplicationContentToLocalServer();
- For Application Page resources (and sitemaps): SPFarm.Local.Services.GetValue().ApplyApplicationContentToLocalServer();

In the Visual Studio project application resource files are located here:
80/BIN/resources

Application resource files are located in manifest.xml here:
<Solution xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" SolutionId="00000000-0000-0000-0000-000000000000" ResetWebServer="True" xmlns="http://schemas.microsoft.com/sharepoint/">
 <ApplicationResourceFiles>
  <ApplicationResourceFile Location="80\resources\testfile.gif/>
 </ApplicationResourceFiles>
 <!-- new in SharePoint 2010 -->
 <App_GlobalResources>
  <App_GlobalResourceFile Location="80\resources\testfile.gif/>
 </App_GlobalResources>
</Solution>

These files are deployed to C:\inetpub\wwwroot\wss\VirtualDirectories\80\App_GlobalResources in a webapplication.

Name	Description
Source Files

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.6. Add Image

The recipes adds a image at the appropriate location within the project for deployment to /_images/

Name	Description
Source Files

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.7. Add Layouts file

The recipes adds a file at the appropriate location within the project for deployment to /_layouts/.

Name	Description
Source Files

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.15. Silverlight

2.1.1.1. Silverlight Application

Name	Description
Silverlight Application Settings
Generated Silverlight Application Name	Required String. Generated name of the Silverlight application.
Silverlight Application Name	Required Text. Name of the Silverlight application.
Silverlight Version	Required Text. Target Silverlight version.
WebPart Title	Required Text. Title of the webpart which displays the Silverlight application.
WebPart Description	Required Text. Description of the webpart which displays the Silverlight application.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.2. Sample: Silverlight Data Binding

Name	Description
Silverlight Application Settings
Generated Silverlight Application Name	Required String. Generated name of the Silverlight application.
Silverlight Application Name	Required Text. Name of the Silverlight application.
Silverlight Version	Required Text. Target Silverlight version.
WebPart Title	Required Text. Title of the webpart which displays the Silverlight application.
WebPart Description	Required Text. Description of the webpart which displays the Silverlight application.

• MSDN: Download source of sample application

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.4. Sample: Silverlight Task Adder

Name	Description
Silverlight Application Settings
Generated Silverlight Application Name	Required String. Generated name of the Silverlight application.
Silverlight Application Name	Required Text. Name of the Silverlight application.
Silverlight Version	Required Text. Target Silverlight version.
WebPart Title	Required Text. Title of the webpart which displays the Silverlight application.
WebPart Description	Required Text. Description of the webpart which displays the Silverlight application.

• MSDN: Download source of sample application

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.3. Sample: Silverlight List Viewer

Name	Description
Silverlight Application Settings
Generated Silverlight Application Name	Required String. Generated name of the Silverlight application.
Silverlight Application Name	Required Text. Name of the Silverlight application.
Silverlight Version	Required Text. Target Silverlight version.
WebPart Title	Required Text. Title of the webpart which displays the Silverlight application.
WebPart Description	Required Text. Description of the webpart which displays the Silverlight application.

• MSDN: Download source of sample application

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.16. PowerShell

2.1.1.4. SharePoint CmdLet

The custom cmdlet can be used in powershell scripts (.ps1) to run adminstration jobs for instance, e.g. 'Start-MyCustomJob'.
Use command "Get-Help Start-MyCustomJob' to display a detailed help information.
Use command "Get-Command Start-MyCustomJob' to display general information.

Name	Description
Generated Command	Optional String. Displays the final command
Verb	Required String. Enter the verb e.g. "Start", "Stop", "Backup".
Noun	Required String. Enter the operation or object type e.g. "SPSiteByName".
Description	Required String. Enter the a short description of the cmdlet (used in help file).

• MSDN: Windows PowerShell in the SharePoint Management Shell
• MSDN: Key Concepts for Writing Cmdlets for the SharePoint Management Shell
• MSDN: Development Guidelines for SharePoint Foundation Cmdlets

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.5. SharePoint CmdLet with PipeBind

The custom cmdlet can be used in powershell scripts (.ps1) to handle objects e.g. SPList or SPSite within a pipe.
Use command "Get-Help Get-MyCustomList' to display a detailed help information.
Use command "Get-Command Get-MyCustomList' to display general information.

Name	Description
General Settings
Generated Command	Optional String. Displays the final command
Verb	Required String. Select the verb e.g. "Get", "New", "Set", "Delete".
Noun	Required String. Enter the operation or object type e.g. "SPSiteByName".
Description	Required String. Enter the a short description of the cmdlet (used in help file).
Pipe Object Settings
Object Type	Optional String. Enter the existing type of object that should be used for pipe binding (e.g. SPList, SPWeb).

• MSDN: Windows PowerShell in the SharePoint Management Shell
• MSDN: Key Concepts for Writing Cmdlets for the SharePoint Management Shell
• MSDN: Development Guidelines for SharePoint Foundation Cmdlets
• Gary Lapointe: Creating Custom SharePoint 2010 Cmdlets using Visual Studio 2010

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.1. PowerShell CmdLet

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.2. PowerShell PSCmdLet

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.3. PowerShell Script

• Torsten Mandelkow

• 1.0 Initial Recipe

2.3. SPSF Deploy and Debug

2.1.1. Deployment

2.1.1.1. Deploy Solution(s)

The recipe deploys the selected project(s) to the local SharePoint farm.
    
    If the wsp solution contains web application resources the solution is deployed to a specific web application. This specific web application can be configured with "Configure Deployment".

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.2. Redeploy Solution(s)

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.3. Undeploy Solution(s)

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.4. Upgrade Solution(s)

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.2. Quick Deploy

2.1.1.2. Copy Both

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.3. Copy to SharePoint Hive

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.1. Copy Assembly

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.3. Deploy Sandboxed Solutions Remotely

2.1.1.1. Deploy Sandboxed Solution(s)

The recipe deploys the selected project(s) to the local SharePoint farm.
    
    If the wsp solution contains web application resources the solution is deployed to a specific web application. This specific web application can be configured with "Configure Deployment".

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.2. Undeploy Sandboxed Solution(s)

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.3. Upgrade Sandboxed Solution(s)

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.4. Debugging

2.1.1.7. Start New Instance

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.3. Attach to W3WP Worker Process

Name	Description
Worker Process	Select the worker process.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.2. Attach to SharePoint 2010 User Code Host

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.5. Recycle App Pool

Name	Description
Application Pool	Select the application pool.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.4. IIS Reset

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.1. Attach to OWSTimer

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.6. Restart OWSTimer

• Torsten Mandelkow

• 1.0 Initial Recipe

2.4. SPSF Test and Analyze

2.1.1. Test

2.1.2. Analyze

2.1.1.1. Run SPDisposeChecker

• Torsten Mandelkow

• 1.0 Initial Recipe

2.5. SPSF Helpers

2.1.1. STSADM

2.1.1.3. stsadm deactivatefeature

This recipe is helpfull if hidden features are deployed and a feature needs to be deactivated via stsadm -o activatefeature.

Name	Description
Feature Id	Select the feature to activate.
Url

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.1. stsadm activatefeature

This recipe is helpfull if hidden features are deployed and a feature needs to be activated via stsadm -o activatefeature.

Name	Description
Feature Id	Select the feature to activate.
Url

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.6. stsadm uninstallfeature

Uninstalls the selected feature. This is useful if e.g. by corrupt solution deployments some features are still registered in the database, but the feature folder is already removed.

Name	Description
Feature Id	Select the feature to activate.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.2. stsadm copyappbincontent

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.4. stsadm execadmsvcjobs

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.5. Open stsadm Prompt

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.2. Shortcuts

2.1.1.2. Open Debugging Site in Browser

This recipe provides a shortcut to the debugging site of the current selected project.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.5. Open Latest SharePoint Trace Log

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.3. Open Item in SharePoint Hive

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.6. Open SharePoint Trace Log Folder

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.1. Open Central Administration in Browser

This recipe provides a shortcut to the local Central Administration in SharePoint, e.g. create a new site collection or check farm features.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.4. Open Solution Management in Browser

This recipe provides a shortcut to the Solution Management in SharePoint, e.g. to check which solutions are deployed or undeployed.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.3. Helpers

2.1.1.4. Reload SharePoint Configuration

In several dialogs within the wizards a list of SharePoint elements is provided to the user (e.g. list of available features, content types etc.). The values for this list are taken from the file SharePointConfiguration.xml, which should be located in the current solution.<br/><br/>This recipe recreates the file SharePointConfiguration.xml with the data from the local computer.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.11. Run MSBuild Target

Name	Description
Build Target	Name of the target to be executed.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.1. Exclude item from SourceControl

The recipe removes a file from source control to avoid conflicts during build.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.2. Get AssemblyName

The assembly name of often needed during development, e.g. to specify the assembly of a feature receiver in the feature.xml.

Name	Description
Assembly Name

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.3. Get Installed SharePoint Version

Name	Description
SharePoint Version

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.7. Open WSP solution file as .CAB

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.5. Remove TextTemplating Transformation

Recipe changes a .tt file to a static file. This is usefull e.g. for transforming manifest.tt to manifest.xml to enable editing of manifest.xml.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.6. Open in Browser

The recipe opens the selected file in browser. The recipe is useful to open deployed file in SharePoint directly from within Visual Studio.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.9. Show Properties

Recipe displays the properties in visual studio of the current item. This is used for debugging purposes within Visual Studio.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.10. Open SPSF Help

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.8. About SPSF

Displays the about dialog with information about the SPSF.

Name	Description

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.4. Configuration

2.1.1.6. Migrate Solution to current SPSF version

Migrates the whole solution to the current installed version of SharePoint Software Factory.

Name	Description
Application Settings
Company Name	Required String. Specifies the company name of the SharePoint application, used in copyright statements.
Application Name	Required String. Specifies the name of the SharePoint application, given by the name of the VS solution name.
Application Version	Required String. Specifies the version of the SharePoint application.
SharePoint Version	Required String. Target SharePoint version (12 or 14).
Local Site for debugging	Optional Url. Name of a SharePoint site for local debugging.
Code Quality
Check code with FxCop in 'Release' build	Optional Boolean. If true Microsoft FxCop will be executed during the 'Release' build to check the complied code against certain coding rules. Additionally a SharePoint specific FxCop settings file will be added to the solution.
Check code with StyleCop in 'Release' build	Optional Boolean. If true Microsoft StyleCop will be executed during the 'Release' build to check the C# source code against certain style rules. Additionally a SharePoint specific StyleCop settings file will be added to the solution.
Check code with ShareCop in 'Release' build	Optional Boolean. If true SharePoint Code Analysis will be executed during the 'Release' build to check code against certain style rules. Additionally a SharePoint specific ShareCop settings file will be added to the solution.
Check code with SPDisposeChecker in 'Release' build	Optional Boolean. If true SharePoint Dispose Checker will be executed during the 'Release' build to check the code for potential memory leaks.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.5. Migrate Project to current SPSF version

Migrates the selected project to the current installed version of SharePoint Software Factory.

Name	Description

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.1. Analyze and Fix Project

Checks Visual Studio projects for possible problems. This could be:
        - Output of .TT-Files like mainfest.tt should not be under source control. Otherwise these files cannot be generated during build
        - Hidden files in folder SharePointRoot will be included into the wsp file without intention
        

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.2. Configure Application

Configures the generell settings of the project.

Name	Description
Local Site for debugging	Optional Url. Name of a SharePoint site for local debugging.
Local Site for testing	Optional Url. Name of a SharePoint site for local testing.
SharePoint Version	Required String. Specifies the target SharePoint version.
Generate .resx files automatically	Optional Boolean. If true .resx files are generated automatically.
Generate manifest.xml automatically	Optional Boolean. If true the files manifest.xml and makecab.ddf are generated automatically.

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.3. Configure Project

Configures the generell settings of the project.

Name	Description
DeploymentTarget

• Torsten Mandelkow

• 1.0 Initial Recipe

2.1.1.4. Configure Project

Configures the generell settings of the project.

Name	Description
DeploymentTarget
Sandboxed solution	Optional Boolean. If checked a sandboxed solutions will be created.

• Torsten Mandelkow

• 1.0 Initial Recipe

3. Snippets

1.1. Basic

1.2. CSharp

1.1.1. Content Types

1.1.1.1. Add Document Template To ContentType

ID	ToolTip	Default
type	Property type	int
property	Property name	MyProperty
field	The variable backing this property	myVar

private int myVar;

  [Input()]
   public int MyProperty
   {
      get { return myVar;}
      set { myVar = value;}
   }
   $end$

Torsten Mandelkow

1.1.1.2. AddFieldAsXmlToList

ID	ToolTip	Default
type	Property type	int
property	Property name	MyProperty
field	The variable backing this property	myVar

using (SPWeb oWebsite = SPContext.Current.Site.AllWebs["MySite"])
{
    SPFieldCollection collFields = oWebsite.Lists["MyList"].Fields;

    string strNewField = "<Field Type=\"Calculated\" " +
    "DisplayName=\"New_Field_Display_Name\" ResultType=\"Currency\" " +
    "ReadOnly=\"TRUE\" Name=\"New_Field_Internal_Name\">" +
    "<Formula>=Currency_Field_Name*100</Formula>" +
    "<FieldRefs><FieldRef Name=\"Currency_Field_Name\" />" + 
    "</FieldRefs></Field>";

    collFields.AddFieldAsXml(strNewField);
}

Torsten Mandelkow

http://msdn.microsoft.com/en-us/library/ms457586.aspx

1.1.1.3. AddFieldToContentType

ID	ToolTip	Default
type	Property type	int
property	Property name	MyProperty
field	The variable backing this property	myVar

using (SPWeb oWebsite = new SPSite("http://MyServer/sites/MySiteCollection/MyWebSite").OpenWeb())
{
    SPList oList = oWebsite.GetList("MyWebSite/Lists/MyList");
    SPFieldCollection collFields = oWebsite.Fields;

    string strNewColumn = collFields.Add("MyNewColumn", SPFieldType.Text, false);

    SPFieldLink oFieldLink = new SPFieldLink(fields[strNewColumn]);
    SPContentType oContentType = oList.ContentTypes["Specification"];
    oContentType.FieldLinks.Add(oFieldLink);

    oContentType.Update(true);
}

Torsten Mandelkow

http://msdn.microsoft.com/en-us/library/ms442695.aspx

1.1.1.4. AddFieldToList

ID	ToolTip	Default
type	Property type	int
property	Property name	MyProperty
field	The variable backing this property	myVar

using (SPWeb oWebsite = SPContext.Current.Site.AllWebs["MySite"])
{
    SPFieldCollection collFields = oWebsite.Lists["MyList"].Fields;
    collFields.Add("MyField", Microsoft.SharePoint.SPFieldType.Text, 
        true);
}