SharePoint Workflow Project Templates

  • Article

Applies to

The information in this topic applies only to the specified Visual Studio Tools for Office projects and versions of Microsoft Office.

Project type

  • SharePoint Workflow

Microsoft Office version

  • SharePoint Server 2007

For more information, see Features Available by Application and Project Type.

The SharePoint Workflow project templates include the necessary project references, files, and basic code to use as a starting point for building sequential and state machine workflow templates for Microsoft Office SharePoint Server 2007.

For information about how to create a SharePoint workflow template, see SharePoint Workflow Solutions.

By default, some of the files and references listed below are hidden. To see them, click Show All Files on the Solution Explorer toolbar. Additionally, there are some files and references not listed below that are common to many Visual Studio Tools for Office project templates.

Template Code

The following field declarations are included in the project template code file.

workflowId

The workflowId field is a GUID that identifies the workflow instance.

workflowProperties

The workflowProperties field contains properties of the workflow instance. This includes properties that are common to all workflows. The workflowProperties field can also include custom properties passed to Microsoft Office SharePoint 2007 by a custom workflow initiation form. For more information, see Workflow Association and Initialization Forms.

Files

These are the main user files. They are visible by default.

  • Workflow1 (.vb file for Visual Basic or .cs file for Visual C#) - The main code file for the workflow template.

  • Feature.xml - Contains references to all workflow template definition files for the feature. By default, Feature.xml contains a reference to Workflow.xml. For more information, see Workflow Deployment Using Features. You cannot rename this file.

  • Workflow.xml - The workflow template definition file. You cannot rename this file. This file contains the following information:

    • The path of the workflow template assembly.

    • The Uniform Resource Name (URN) of InfoPath forms used in the workflow.

    • The GUID, description, and name of the workflow template.

Note

You do not have to edit this file to run or debug the workflow template. You will edit this file when you deploy the workflow feature to your staging or production SharePoint 2007 Server. For more information, see Debugging SharePoint Workflow Solutions.

Hidden Files

Visual Studio Tools for Office generates the following hidden file. Do not modify this file manually; it is regenerated when changes are made to the project and it does not retain manual modifications.

  • Workflow1.designer (.vb file for Visual Basic or .cs file for Visual C#) - a file that contains code generated by the Windows Workflow Foundation designer.

References

Assembly reference

Description

Microsoft.Office.Workflow.Tasks

A collection of SharePoint Server 2007 activities.

Microsoft.SharePoint.WorkflowActions

A collection of SharePoint activities.

Microsoft.SharePoint

Classes that you can use to manage workflows deployed to a SharePoint site.

Microsoft.SharePoint.Search

Classes that you can use to search for information on a SharePoint site.

System.Workflow.Activities

Classes that define activities which run an executable representation of a work process. This assembly also provides classes that define conditions and actions that form a rule, and also manage the rule set editor and the rule condition editor dialog boxes.

System.Workflow.ComponentModel

Classes that you can use to build activities, custom workflow design-time behavior, and user interfaces for configuring workflows and activities.

Also contains classes and interfaces that are used to create, validate, and compile activities and workflows.

System.Workflow.Runtime

Classes and interfaces that configure and control the workflow runtime engine, workflow runtime services, and the execution of a workflow instance.

Microsoft .NET Framework assemblies

A collection of references to some of the Microsoft .NET Framework assemblies that are used when you develop Visual Studio Tools for Office solutions.

See Also

Tasks

How to: Create Visual Studio Tools for Office Projects

Concepts

SharePoint Workflow Solutions

Assemblies in Office Solutions Overview

Reference

2003 Microsoft Office Add-in Project Templates

2007 Microsoft Office Add-in Project Templates

Other Resources

Managing Solutions, Projects, and Files

Office Project Templates