Recipe Index

Provides a list of all recipes in the package.

SPSF Artefacts

Title Description
Features
Empty Feature This recipe creates an empty farm, web application, site or web feature.
Feature: Add Activation Dependency Adds a feature activation dependency to a SharePoint feature.
Feature: Add Property Adds a feature property.
Feature: Add Upgrade Action for Content Type Adds a upgrade action that adds a field to a content type.
Lists and Libaries
List Definition Adds a list definition based on a local installed list definition
List Instance Adds a list instance definition to a feature.
Module Adds a module to the current selected feature to provision files
Site Column Adds a site column to the current selected feature
Content Type Adds a content type to the current selected feature
ContentType: Add Field Adds a field reference to the content type
Content Type Binding Adds a binding between a content type and a list
ContentType: Add Document Template Adds a document template to the content type
ContentType: Add Event Receiver Adds a event receiver to the content type
ContentType: Add Custom Form Adds a custom form (New, Edit or Display) to the content type
LINQ to SharePoint Generates the classes from given SharePoint lists
Webs and Sites
Blank Site Definition Adds a custom blank site definition
Team Site Definition Adds a custom team site definition
Feature Stapling Adds a FeatureSitetemplateAssocation to the selected feature
Custom Actions and Ribbons
Custom Action for Content Type Adds a custom action to content type menu (ECB)
Custom Action for File Extension Adds a custom action for a specific extension (e.g. .docx)
Custom Action for ProgID (Document Type) Adds a custom action to a document type e.g. "InfoPath.Document"
Custom Action for List Adds a custom action to existing menus in a list view (Settings, Actions etc.)
Custom Action for List Toolbar Adds a custom action to a toolbar in a list (View, Edit, Display etc.)
Custom Action for Site Adds a custom action to a site
Custom Action for SiteActions menu Adds a custom action to the SiteActions menu
Custom Action Group Adds a custom action to a site
Hide Custom Action Hides an action of an item
Ribbon Tab Adds a new tab to the ribbons
Ribbon Group Adds a new group to an existing ribbon tab
Ribbon Control Adds a new control to an existing ribbon group (e.g. button, label)
Sample: Add Ribbon Button to List Form Add a Button to the ribbons in a List Form
Sample: Add Ribbon Button to Item Form Add a Button to the ribbons in a Edit, New or Display Form
Sample: Add Ribbon Button to Content Type Adds a Button to a Content Type specific ribbon.
Sample: Ribbon Tab with 3 buttons Adds a sample tab which contains 3 buttons
Hide Ribbon Control Hides an existing ribbon control (e.g. button, label)
Event Receivers
Item Event Receivers Adds a event receivers to react of event like ItemAdded, ItemUpdating etc.
List Event Receivers Adds a event receivers to handle events like FieldAdded, FieldUpdating etc.
Web Event Receiver Adds a event receivers to webs
Email Event Receiver Adds a event receivers to handle events like EmailReceived
WebParts
SharePoint Web Part Adds a web part to the project derived from Microsoft.SharePoint.WebPartPages.WebPart
ASP Web Part Adds a web part to the project derived from System.Web.UI.WebControls.WebParts.WebPart
Visual Web Part Adds a smart part to the project
Sample: Ajax Web Part Adds a Ajax web part to the project
Sample: Simple Filter Consumer Web Part Adds a filter web part to the project
Sample: Filter Consumer Web Part Sample filter consumer web part to consumer multiple values (MSDN sample)
Sample: Filter Provider Web Part Sample filter provider web part to provide multiple values (MSDN sample)
Field Types
Field Type Adds a field type to the project
Sample: Field Type with Complex Value Adds a custom field type to store complex objects
Sample: Field Type with Multiple Columns Sample to store a address with multiple columns.
Sample: Field Type with Status Choice Sample to store an employee status
Sample: Field Type for ISBN10 Sample from MSDN for a custom field type to store a ISBN10 number including validation rule
Sample: Field Type for Social Security Number Sample from Ted Pattison for a custom field type to store social security number
Sample: Field Type for Flash Movie Sample for a custom field type to render a flash movie
Sample: Field Type for Ratings Sample for a custom field type to show a rating with graphics
Publishing
Publishing Site Definition Adds a standard publishing site definition along with the required features.
Master Page Adds a master page current selected project.
Page Layout Adds a page layout to the current selected project.
Import
Import .wsp solution Imports an existing WSP solution file into the project
Import .wsp solution from local farm Imports an existing WSP solution from the local SharePoint farm into the project
Import Content Type Imports an existing content type from a given SharePoint site
Import Site Column Import a site column from the local SharePoint into the current selected feature
Import List Definition Imports a list form the local SharePoint farm as list definition into Visual Studio.
Import List Instance Import list instance
Application Pages
Administration Page Add an administration page to the project inherited from LayoutsPageBase
Application Page Add a layouts page to the project inherited from LayoutsPageBase
Unrestricted Layouts Page Add a unsecured layouts page to the project inherited from LayoutsPageBase
ASP.NET
Create WSDL and DISCO Creates the wsdl and disco file
ASMX Webservice Adds a ASP.NET web service
WCF Webservice Adds a WCF web service
Administration Web Service Adds a ASP.NET web service for administration
Delegate Control (.ASCX) Adds a delegate template with a asxc control
Delegate Control (.CS) Adds a delegate template with a webcontrol (.cs)
Http Handler Adds a http handler to the project and a feature to deploy the web.config modifications for the http handler
Http Module Adds a http module to the project and a feature to deploy the web.config modifications for the http handler
Workflows
Simple Workflow Adds a workflow to a feature
Business Connectivity Services
Simple BCS Model Add a simple BCS model
Import Model from Database as SQL Queries Add a BCS model from a database and generates the necessary SQL queries to retrieve and change the data. This recipe will create C# code to retrieve data from the external data source.
Import Model from Database as Classes Add a BCS model from a database and generates the necessary classes which contain the SQL queries to retrieve and update the data.
Import Model from Database as LINQ entities Add a BCS model from a database and generates the necessary LINQ classes to retrieve and change the data. The recipe will also generate a LINQ-to-SQL file (.dbml) from the database.
Design Model with .NET Assembly Designs a new model and generates the necessary WCF web service for the model.
BCS List Instance Add a instance of an external list
Quick Deploy BCS Model Deploys the BCS Model to the farm via powershell.
Quick Deploy BCS Model incl. Assembly Deploys the BCS Model to the farm via powershell and deploys the assembly to GAC.
Advanced
Security
Minimal CAS Adds a minimal Code Access Security policy
Medium CAS Adds a medium Code Access Security policy
AspNetHosting Permission Adds a SecurityPermission to the project
Dns Permission Adds a DnsPermission to the project. Controls rights to access Domain Name System (DNS) servers on the network.
Environment Permission Adds a EnivronmentPermission to the project. Controls access to system and user environment variables.
Reflection Permission Adds a ReflectionPermission to the project
FileIO Permission Adds a FileIOPermission to the project. Controls the ability to access files and folders.
Printing Permission Adds a PrintingPermission to the project. Controls access to printers.
SqlClient Permission Adds a SqlClientPermission to the project. Enables the .NET Framework Data Provider for SQL Server to help make sure that a user has a security level sufficient to access a data source.
WebPart Permission Adds a WebPartPermission to the project. Represents a custom permission that controls the ability to access Web Part resources
Registry Permission Adds a RegistryPermission to the project. Controls the ability to access registry variables.
Security Permission Adds a SecurityPermission to the project. Describes a set of security permissions applied to code.
SharePoint Permission Adds a SharePointPermission to the project. Represents a custom permission that controls the ability to access Microsoft SharePoint Products and Technologies.
SMTP Permission Adds a SmtpPermission to the project. The SmtpPermission and SmtpPermissionAttribute classes control access to SMTP host computers.
Files
Add Global Resource file (.resx) This recipe adds a empty resource file (.resx) to the project.
Add Class Resource Files This recipe allows to add a file which should be deployed as class resource file for an assembly.
Add Application Resource Files This recipe allows to add a file which should be deployed to the Global Assembly Cache.
Add Image This recipe allows to add a file which should be deployed to /_images/.
Add Layouts file This recipe allows to add a file which should be deployed to /_layouts/.
Silverlight
Silverlight Application Adds an empty Silverlight Application to the project and adds the output of that project to a SharePoint Feature.
Sample: Silverlight Data Binding Adds an sampe Silverlight Application which shows the binding of Silverlight to the data of a list.
Sample: Silverlight Task Adder Adds an sampe Silverlight Application which adds a task to the task list.
Sample: Silverlight List Viewer Adds an sampe Silverlight Application which provides a data grid to display the contents of a list.
PowerShell
SharePoint CmdLet Adds a SharePoint cmdlet to the project which does not use objects from the pipe (e.g. Start-MyCustomJob). The recipe creates the cmdlet class, the xml for the registration in SharePoint and a corresponding help file to store help information about the cmdlet.
SharePoint CmdLet with PipeBind Adds a SharePoint cmdlet which uses or returns objects from the pipe (e.g. Get-SPSiteTitle, Set-SPSiteTitle). The recipe creates the cmdlet class, the class for the piped object, the xml for the registration in SharePoint and a corresponding help file to store help information about the cmdlet.
PowerShell CmdLet Adds a cmdlet to the project.
PowerShell PSCmdLet Adds a pscmdlet to the project.
PowerShell Script Adds a .ps1 script file to the project.

SPSF Deploy and Debug

Title Description
Quick Deploy
Copy Both Copies the assembly of the selected project to GAC and all files to SharePoint hive.
Copy to SharePoint Hive Copies all files in project folder to the SharePoint hive on the local machine.
Copy Assembly Copies the assembly of the selected project to GAC.
Deploy Sandboxed Solutions Remotely
Deploy Sandboxed Solution(s) Deploys the selected sandboxed solution(s) to a remote SharePoint farm.
Undeploy Sandboxed Solution(s) Undeploys the selected sandboxed solution from a remote SharePoint farm.
Upgrade Sandboxed Solution(s) Upgrades the selected sandboxed solution in a remote SharePoint farm.

SPSF Helpers

Title Description
SP Helpers
Activate Feature Activates the selected feature in the selected site or web.
Deactivate Feature Deactivates the selected feature in the selected site or web.
Uninstall Feature Uninstalls the selected feature.
Copy Appbin Content Runs stsadm -o copyappbincontent.
Execute Admin Service Jobs Runs stsadm -o execadmsvcjobs to run all pending deployment jobs.
Open stsadm Prompt Opens a prompt to enter stsadm commands manually.
Shortcuts
Reload SharePoint Configuration Reloads the file SharePointConfiguration.xml with the contents of the local SharePoint farm (features, listtemplates, content types etc.).
Open Debugging Site in Browser Opens the site for debugging of the project in the browser.
Open Item in SharePoint Hive Opens the current selected item in SharePoint Hive.
Open Latest SharePoint Trace Log Opens the latest SharePoint Trace Log file e.g. to check deployment issues.
Open SharePoint Trace Log Folder Opens the folder with the SharePoint Trace Log files.
Open Central Administration in Browser Displays the Central Administration.
Open Solution Management in Browser Displays the web page "Solution Management" in SharePoint Central Administration.
Helpers
Exclude item from SourceControl Removes the item from source control, e.g. import for manifest.xml and makecab.ddf to enable automatic generation of these files.
Run MSBuild Target Runs a target from an msbuild file.
Get AssemblyName Displays the full assembly name of the current selected project.
Get Installed SharePoint Version Displays the version of SharePoint on the local machine.
Open WSP solution file as .CAB Displays the contents of the wsp solution file.
Open in Browser Opens the selected item in browser.
Open SPSF Help Opens the SPSF help in the browser.
About SPSF Displays information about the current installed SPSF version.
Configuration
Update Solution to current SPSF version Updates the current project or solution to the current installed SPSF version or adds it to a non .
Update Project to current SPSF version Updates the current project or solution to the current installed SPSF version.
Analyze and Fix SPSF Project Analyzes the project for conflicts and allows to fix them.
Configure SPSF Solution Configures general settings of the whole application.


Disclaimer: The views and opinions expressed in this documentation and in SPSF are those of the authors and do not necessarily reflect the opinions and recommendations of Microsoft or any member of Microsoft. All trademarks, service marks, collective marks, copyrights, registered names, and marks used or cited by this documentation are the property of their respective owners.
SharePoint Software Factory, Version 4.1.3.2705, GPLv2, see http://spsf.codeplex.com for more information