チュートリアル: サイトのカスタムワークフローアクティビティの作成

このチュートリアルでは、サイトレベルのワークフローに使用するカスタムアクティビティを Visual Studio で作成する方法について説明します。サイトレベルのワークフローは、サイト上のリストだけでなく、サイト全体に適用されます。カスタムアクティビティによって、バックアップのお知らせリストが作成され、そこにお知らせリストの内容がコピーされます。

このチュートリアルでは、次のタスクを実行します。

サイトレベルのワークフローを作成する。
カスタムワークフローアクティビティを作成する。
SharePoint リストを作成および削除する。
リスト間で項目をコピーする。
クイック起動バーにリストを表示する。

[!メモ]

お使いのマシンで、Visual Studio ユーザーインターフェイスの一部の要素の名前や場所が、次の手順とは異なる場合があります。これらの要素は、使用している Visual Studio のエディションや独自の設定によって決まります。詳細については、「Visual Studio の設定」を参照してください。

必須コンポーネント

このチュートリアルを実行するには、次のコンポーネントが必要です。

サポート対象エディションの Microsoft Windows および SharePoint。詳細については、「SharePoint ソリューションの開発要件」を参照してください。
Visual Studio

サイトのカスタムワークフローアクティビティプロジェクトの作成

まず、カスタムワークフローアクティビティを格納し、テストするプロジェクトを作成します。

サイトのカスタムワークフローアクティビティプロジェクトを作成するには

メニューバーで、新しいプロジェクト のダイアログボックスを表示するに ファイル、新規作成、プロジェクト を選択します。
SharePoint のノードを [Visual C#] か Visual Basicの下に配置し、2010 のノードを選択します。
テンプレート のペインで、SharePoint 2010 プロジェクト テンプレートを選択します。
名前ボックスに " AnnouncementBackup " を入力し、を OK のボタンをクリックします。

SharePoint カスタマイズウィザードが表示されます。
デバッグのサイトとセキュリティレベルの指定 のページで、ファームソリューションとして配置する のオプションボタンを選択し、信頼レベルと既定のサイトを受け入れるように完了のボタンをクリックします。

また、この段階で、ソリューションの信頼レベルがファームソリューション (ワークフロープロジェクトではこれ以外は選択できません) として設定されます。
次に ソリューションエクスプローラーで、プロジェクトノードを選択し、メニューバーで、をクリックします プロジェクト、新しい項目の追加を選択します。
[Visual C#] か Visual Basicの下に、SharePoint のノードを展開し、2010 のノードを選択します。
テンプレート のペインで、シーケンシャルワークフロー (ファームソリューションのみ) テンプレートを選択し、追加のボタンをクリックします。

SharePoint カスタマイズウィザードが表示されます。
デバッグのワークフロー名の指定 のページで、既定の名前 (AnnouncementBackup - Workflow1) を受け入れます。ワークフローテンプレートの種類を サイトワークフローに変更し、次へのボタンをクリックします。
残りの既定の設定をそのまま使用する場合完了のボタンをクリックします。

カスタムワークフローアクティビティクラスの追加

次に、カスタムワークフローアクティビティのコードを記述するためのクラスをプロジェクトに追加します。

カスタムワークフローアクティビティクラスを追加するには

メニューバーで、新しい項目の追加 のダイアログボックスを表示するに プロジェクト、新しい項目の追加 を選択します。
インストールされているテンプレート のツリービューで、コード のノードを選択し、プロジェクト項目テンプレートの一覧の クラス テンプレートを選択します。既定の名前である Class1 を使用します。[追加] ボタンをクリックします。

Class1 のすべてのコードを次のコードに置き換えます。

Imports System
Imports System.Collections.Generic
Imports System.Linq
Imports System.Text
Imports 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
        Inherits System.Workflow.ComponentModel.Activity
        Public Sub New()
            MyBase.New()
        End Sub

        ' Triggers when the activity is executed.
        Protected Overrides Function Execute(ByVal executionContext As System.Workflow.ComponentModel.ActivityExecutionContext) As System.Workflow.ComponentModel.ActivityExecutionStatus
            Try
                ' Get a reference to the SharePoint site.
                Dim site As SPSite = New SPSite(("http://" + System.Environment.MachineName))
                Dim web As SPWeb = site.OpenWeb("/")
                ' Reference the original Announcements list.
                Dim aList As SPList = web.GetList("/Lists/Announcements")
                ' If the Announcements Backup list already exists, delete it.
                Try
                    Dim bList As SPList = web.GetList("/Lists/Announcements Backup")
                    bList.Delete()
                Catch
                End Try
                ' Create a new backup Announcements list and reference it.
                Dim newAnnID As Guid = web.Lists.Add("Announcements Backup", "A backup Announcements list.", SPListTemplateType.Announcements)
                Dim bakList As SPList = web.Lists(newAnnID)
                ' Copy announcements from original to backup Announcements list.
                For Each item As SPListItem In aList.Items
                    Dim newAnnItem As SPListItem = bakList.Items.Add
                    For Each field As SPField In aList.Fields
                        If Not field.ReadOnlyField Then
                            newAnnItem(field.Id) = item(field.Id)
                        End If
                    Next
                    newAnnItem.Update()
                Next
                ' Put the Backup Announcements list on the QuickLaunch bar.
                bakList.OnQuickLaunch = True
                bakList.Update()
            Catch errx As Exception
                System.Diagnostics.Debug.WriteLine(("Error: " + errx.ToString))
            End Try
            Return MyBase.Execute(executionContext)
        End Function
    End Class
End Namespace

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);
        }


    }
}

次に、プロジェクトを保存し、メニューバーで、ビルド、ソリューションのビルドを選択します。

Class1 が [AnnouncementBackup のコンポーネント] のタブの ツールボックス カスタム動作として表示されます。

サイトのワークフローへのカスタムアクティビティの追加

次に、カスタムコードを含んだアクティビティをワークフローに追加します。

サイトのワークフローにカスタムアクティビティを追加するには

ワークフローデザイナーのデザインビューで Workflow1 を開きます。
onWorkflowActivated1 のアクティビティの下に表示されるドラッグ、または Class1 のショートカットメニューを開き、コピーを選択し、onWorkflowActivated1 のアクティビティの下に行のショートカットメニューを開き、を選択します。貼り付けように ツールボックス の Class1 が。
プロジェクトを保存します。

サイトのカスタムワークフローアクティビティのテスト

次に、プロジェクトを実行して、サイトのワークフローを開始します。カスタムアクティビティによって、バックアップのお知らせリストが作成され、そこに最新のお知らせリストの内容がコピーされます。このコードは、バックアップリストの作成前に、既存のバックアップリストが存在するかどうかもチェックします。既存のバックアップリストが存在する場合は、それを削除します。また、このコードは、SharePoint サイトのクイック起動バーに新しいリストへのリンクを追加します。

サイトのカスタムワークフローアクティビティをテストするには

プロジェクトを実行し、SharePoint に配置するには、F5 キーを選択します。
クイック起動バーで、SharePoint サイトで使用できる一覧を表示するに リスト のリンクを選択します。**[お知らせ]**という名前のお知らせのリストが 1 つだけ表示されます。
SharePoint Web ページの一番上に、サイトワークフロー のリンクを選択します。
新しいワークフローの開始] セクションで、[AnnouncementBackup – Workflow1] のリンクを選択します。これで、サイトのワークフローが開始されて、カスタム動作のコードが実行されます。
クイック起動バーで、[バックアップのお知らせ] のリンクを選択します。[お知らせ] ボックスにあるすべてのお知らせが、この新しいリストにコピーされていることがわかります。

参照

処理手順

方法: イベントレシーバーを作成する

その他の技術情報

SharePoint ソリューションの開発

Last updated on 2013-02-21

チュートリアル: サイトのカスタム ワークフロー アクティビティの作成

必須コンポーネント

サイトのカスタム ワークフロー アクティビティ プロジェクトの作成

サイトのカスタム ワークフロー アクティビティ プロジェクトを作成するには

カスタム ワークフロー アクティビティ クラスの追加

カスタム ワークフロー アクティビティ クラスを追加するには

サイトのワークフローへのカスタム アクティビティの追加

サイトのワークフローにカスタム アクティビティを追加するには

サイトのカスタム ワークフロー アクティビティのテスト

サイトのカスタム ワークフロー アクティビティをテストするには

参照