SP Tricks

Create a Custom Site Workflow Activity Using C#

Posted on January 6, 2012 Updated on March 6, 2013

First, create a project to hold and test the custom workflow activity.

To create a site workflow custom activity project

1. Display the New Project dialog box by pointing to New on the File menu, and then click New Project.

2. Expand the SharePoint node under either Visual C# or Visual Basic, and then click 2010.

3. In the Templates pane, select Sequential Workflow.

4. In the Name box, type AnnouncementBackup and then click OK.

   The SharePoint Customization Wizard appears.

5. In the What is the local site you want to use for debugging? page, click Next to accept the default site.

   This step also sets the trust level for the solution as farm solution, the only available option for workflow projects.

6. In the Specify the workflow name for debugging page, accept the default name (AnnouncementBackup – Workflow1). Change the workflow template type to Site Workflow and then click Next.

7. Click Finish to accept the remaining default settings.

Adding a Custom Workflow Activity Class

Next, add a class to the project to contain the code for the custom workflow activity.

To add a custom workflow activity class

1. Click Add New Item on the Project menu to display the Add New Item dialog box.

2. In the Installed Templates tree view, click the Code node and then click Class in the list of project item templates. Use the default name Class1.

3. Replace all of the code in Class1 with the following:

   using System;
   using System.Collections.Generic;
   using System.Linq;
   using System.Text;
   using Microsoft.SharePoint;
   
   namespace AnnouncementBackup
   {
       // This custom activity will back up all of the announcements in 
       // the Announcements list on the SharePoint site.
       public class Class1 : System.Workflow.ComponentModel.Activity
           {
           public Class1()
           { }
   
           // Triggers when the activity is executed.
           protected override System.Workflow.ComponentModel.ActivityExecutionStatus Execute(System.Workflow.ComponentModel.ActivityExecutionContext executionContext)
           {
               try
               {
                   // Get a reference to the SharePoint site.
                   SPSite site = new SPSite("http://" + System.Environment.MachineName);
                   SPWeb web = site.OpenWeb("/");
   
                   // Reference the original Announcements list.
                   SPList aList = web.GetList("/Lists/Announcements");
   
                   // If the Announcements Backup list already exists, delete it.
                   try
                   {
                       SPList bList = web.GetList("/Lists/Announcements Backup");
                       bList.Delete();
                   }
                   catch
                   { }
   
                   // Create a new backup Announcements list and reference it.
                   Guid newAnnID = web.Lists.Add("Announcements Backup", "A backup Announcements list.", SPListTemplateType.Announcements);
                   SPList bakList = web.Lists[newAnnID];
   
                   // Copy announcements from original to backup Announcements list.
                   foreach (SPListItem item in aList.Items)
                   {
                       SPListItem newAnnItem = bakList.Items.Add();
                       foreach (SPField field in aList.Fields)
                       {
                           if (!field.ReadOnlyField)
                               newAnnItem[field.Id] = item[field.Id];
                       }
                       newAnnItem.Update();
                   }
   
                   // Put the Backup Announcements list on the QuickLaunch bar.
                   bakList.OnQuickLaunch = true;
                   bakList.Update();
   
               }
   
               catch (Exception errx)
               {
                   System.Diagnostics.Debug.WriteLine("Error: " + errx.ToString());
               }
   
               return base.Execute(executionContext);
           }
   
   
       }
   }

4. Save the project and then click Build Solution on the Build menu.

5. Class1 appears as a custom action in the Toolbox under the SharePoint Workflow tab in the Toolbox.

Adding the Custom Activity to the Site Workflow

Next, add an activity to the Workflow to contain the custom code.

To add a custom activity to the site Workflow

1. Open Workflow1 in the workflow designer in design view.

2. Click and drag Class1 from the Toolbox and drop it under the onWorkflowActivated1 activity.

3. Save the project.

Testing the Site Workflow Custom Activity

Next, run the project and start the site workflow. The custom activity creates a backup Announcements list and copies the contents from the current Announcements list into it. The code also checks whether a backup list already exists before creating one. If a backup list already exists, it is deleted. The code also adds a link to the new list on the SharePoint site’s QuickLaunch bar.

To test the site workflow custom activity

1. Press F5 to run the project and deploy it to SharePoint.

2. On the QuickLaunch bar, click Lists to display all of the lists available in the SharePoint site. Notice there is only one list for announcements named Announcements.

3. At the top of the SharePoint Web page, click the Site Actions button and then click Site Workflows.

4. Under the Start a New Workflow section, click the link for AnnouncementBackup – Workflow1. This starts the site workflow and runs the code in the custom action.

5. Click the link called Announcements Backup that appears on the QuickLaunch bar. Notice that all of the announcements that are contained in the Announcements list have been copied to this new list.

Original Reference

SharePoint: Create Custom Workflow Activities Using VS 2008 (Video)