SharePoint 2010のイベントレシーバーの作成

はじめに

　作成に入る前に、本連載の第1回『SharePoint 2010開発の紹介』を参考にして、SharePoint 2010の開発環境を整えてください。

対象読者

• Visual Studio 2010によるSharePoint 2010開発に関心がある開発者
• SharePoint 2010のイベントレシーバーの開発に関心がある開発者

SharePoint 2010のイベントとイベントレシーバー

　SharePoint 2010では、Webサイト、リストやリストアイテムなどに対する処理や操作の前後に発生するさまざまなイベントが定義されています。

　SharePointのイベントは、サイトイベント、Webイベント、リストイベントなど、主に5つの種類に分かれます。これら5つのイベントの種類にそれぞれ対応したイベントレシーバーのクラスがMicrosoft.SharePoint名前空間には用意されています（表1）。

　SPEmailEventReceiverクラスを除くどのイベントレシーバーも、SPEventReceiverBaseクラスから派生しています。また、どのイベントレシーバークラスも直接インスタンス化はせず、派生させて使用する必要があります。Visual Studio 2010でイベントレシーバープロジェクトを作成する際に、ウィザード内でどのイベントレシーバーを使用するかを選択することにより、そのイベントレシーバーの派生クラスを自動生成できます。

　次に、イベントの種類別にすべてのイベントをまとめます（表2）。多くの場合、「～されています」と「～されました」のように、何かの処理や操作の前後にそれぞれイベントが発生することが分かります。これらをBeforeイベントとAfterイベントと呼びます。

　表2をご覧いただくと分かるように、サイト、リスト、リストアイテムなどSharePointの各構成要素に対して、さまざまなイベントが定義されています。これらのイベントを扱うイベントレシーバーを作成することにより、SharePointのサイトを細かく制御することが可能となります。たとえば、リスト作成時のBeforeイベントをキャッチし一定の条件に適合する場合にのみリスト作成を許可するなどの業務上のルールに応じた振る舞いを追加できます。

　Visual Studio 2010で作成したイベントレシーバーは、SharePointのサイトに配置するだけで、特に他の手順を必要とすることなくサイト上で実行されます。