基本的な SharePoint Web パーツの作成

[アーティクル]
06/15/2015

このプログラミングタスクでは、基本的なカスタムの Windows SharePoint Services Web パーツを作成する手順について説明します。作成するのは、Web パーツの Title プロパティを変更できる簡単な Web パーツです。このプロパティは、Web パーツのタイトルバーのテキストを設定する、Windows SharePoint Services の WebPart 基本クラスのプロパティです。

重要

Windows SharePoint Services 3.0 から、Windows SharePoint Services の Web パーツインフラストラクチャは Microsoft ASP.NET 2.0 の Web パーツインフラストラクチャをベースにするようになり、ASP.NET の WebPart クラスクラスから派生する Web パーツが Windows SharePoint Services で完全にサポートされるようになりました。可能な場合には常に、ASP.NET の Web パーツを作成する必要があります。

派生元として最善の Web パーツ基本クラスを選択する方法の詳細については、Windows SharePoint Services ソフトウェア開発キット (SDK) の「Windows SharePoint Services で Web パーツを開発する」を参照してください。ASP.NET の Web パーツの詳細については、ASP.NET のマニュアルにある「Web パーツコントロールセットの概要」を参照してください。

前提条件

Microsoft Visual Studio 2005

Windows SharePoint Services 3.0

手順 1 : 新しい Web コントロールライブラリプロジェクトを作成する

Web パーツは、ASP.NET の Web フォームコントロールが基になっています。Web パーツは Microsoft Visual C# または Microsoft Visual Basic で作成し、その際には ASP.NET の Web コントロールライブラリテンプレートを使用します。

新しい Web コントロールライブラリプロジェクトを作成するには

Visual Studio 2005 を起動します。
[ファイル] メニューの [新規作成] をポイントし、[プロジェクト] をクリックします。
[新しいプロジェクト] ダイアログボックスで、[Visual C# プロジェクト] または [Visual Basic プロジェクト] をクリックし、[Web コントロールライブラリ] テンプレートをクリックします。
名前として「SimpleWebPart」と入力し、プロジェクトファイルの保存場所を指定した後、[OK] をクリックします。

手順 2 : Microsoft.SharePoint.dll への参照を追加する

Web パーツを作成するには、Microsoft.SharePoint アセンブリ (Microsoft.SharePoint.dll) への参照を、Web コントロールライブラリプロジェクトに追加する必要があります。

Microsoft.SharePoint.dll への参照を追加するには

[プロジェクト] メニューの [参照の追加] をクリックします。
[.NET] タブの [Windows SharePoint Services] をダブルクリックします。
[OK] をクリックします。

手順 3 : バージョン番号を設定し、部分的に信頼された呼び出し元をセットアップする

既定では、プロジェクトの AssemblyVersion プロパティは、Web パーツを再コンパイルするたびにインクリメントするように設定されています。Web パーツページでは、web.config ファイル内で指定されているバージョン番号で Web パーツを識別します。AssemblyVersion プロパティがインクリメントする設定になっている場合、Web パーツを Web パーツページにインポートした後で再コンパイルすると、Web パーツフレームワークは web.config ファイル内で指定されているバージョン番号を検索します。バージョン番号が一致しないと、エラーが発生します。再コンパイルのたびに Web パーツのバージョン番号がインクリメントされないようにするには、AssemblyInfo ファイルでバージョン番号を設定する必要があります。

ここでは署名付きコードを作成するので、アセンブリに対し、部分的に信頼されたコードの呼び出しを許可するように指示する必要もあります。既定では、部分的に信頼されたコードでの使用を明示的に選択していない厳密な名前のアセンブリがある場合、そのアセンブリの呼び出しは、セキュリティポリシーによって完全信頼が付与された他のアセンブリからのみ実行できます。

バージョン番号を設定し、部分的に信頼された呼び出し元を許可するには

ソリューションエクスプローラで、AssemblyInfo ファイルをダブルクリックします。

行を編集します。

[assembly: AssemblyVersion(“1.0.*”)]

<Assembly: AssemblyVersion(“1.0.*”)>

上の行を、次のように変更します。

[assembly: AssemblyVersion(“1.0.0.0”)]

<Assembly: AssemblyVersion(“1.0.0.0”>

次の行を、ファイルの先頭に追加します。
```
using System.Security;
```
```
Imports System.Security;
```

次の行を、ファイルの末尾に追加します。

[assembly: AllowPartiallyTrustedCallers]

<Assembly: AllowPartiallyTrustedCallers()>

手順 4 : クラスと名前空間の名前を変更する

複数の Web パーツを作成する場合は、通常、すべての Web パーツで同じ名前空間を使用する必要があります。既定では、Web コントロールライブラリによって、プロジェクトと同じ名前が名前空間に割り当てられます。この例では、WebPart クラスに任意の名前空間 MyWebParts を使用します。プロジェクトを作成すると空のクラスファイルが表示されますが、既定のクラス名 WebCustomControl を変更して、新しい Web パーツを簡単に識別できるような名前を付けることができます。

クラスと名前空間の名前を変更するには

既定のクラスの名前を変更します。これには、ソリューションエクスプローラで WebCustomControl1 を選択して右クリックし、[名前の変更] をクリックして、「SimpleWebPart」というファイル名を入力します。
C# の場合は、Web パーツの名前空間を変更します。これには、次の行を編集します。
```
namespace SimpleWebPart
```
上の行を、次のように変更します。
```
namespace MyWebParts
```
Visual Basic の場合は、ソリューションエクスプローラで SimpleWebPart プロジェクトを右クリックし、[プロパティ] をクリックして、[アセンブリ名] および [ルート名前空間] テキストボックスのテキストを「MyWebParts.SimpleWebPart」に変更します。

手順 5 : 名前空間ディレクティブを追加する

基本の WebPart クラスを簡単に記述できるようにするには、C# の場合は using ディレクティブ、Visual Basic の場合は Imports ディレクティブを使用して、コード内で次の名前空間を参照します。

Microsoft.SharePoint.WebPartPages 名前空間。この名前空間により、Microsoft.SharePoint.WebPartPages.WebPart クラスのような、Web パーツページの種類が提供されます。

名前空間ディレクティブを追加するには

次の using ディレクティブまたは Imports ディレクティブを、コードの先頭付近に追加します。
```
using Microsoft.SharePoint.WebPartPages;
```
```
Imports Microsoft.SharePoint.WebPartPages
```

手順 6 : Web パーツクラスから継承する

既定では、Web コントロールライブラリテンプレートによって、System.Web.UI.Control クラスから継承したカスタムコントロールが作成されます。このクラスは、ASP.NET および SharePoint の両 WebPart クラスの親クラスです。SharePoint の Web パーツを作成するには、Microsoft.SharePoint.WebPartPages.WebPart 基本クラスから継承する必要があります。

Web パーツ基本クラスから継承するには

次の行を探します。

public class SimpleWebPart : WebControl

Public Class SimpleWebPart
   Inherits WebControl

上の行を、次の行に置き換えます。

public class SimpleWebPart : WebPart

Public Class SimpleWebPart
   Inherits WebPart

手順 7 : RenderWebPart メソッドを使用する

Web パーツインフラストラクチャが Web パーツのコンテンツのレンダリングを制御する必要があるため、WebPart 基本クラスは、System.Web.UI.Control の Render メソッドをシールしています。このため、カスタム Web パーツでは、WebPart 基本クラスの RenderWebPart メソッドを無効にする必要があります。

RenderWebPart メソッドを使用するには

次の行を探します。

protected override void Render(HtmlTextWriter output)

Protected Overrides Sub RenderContents(ByVal output as HtmlTextWriter)

上の行を、次の行に置き換えます。

protected override void RenderWebPart(HtmlTextWriter output)

Protected Overrides Sub RenderWebPart(ByVal output as HtmlTextWriter)

手順 8 : Web パーツのロジックとレンダリングを定義する

ここまでの手順を完了したら、Web パーツのロジックとレンダリングを定義できます。このパーツには、いくつかの基本の ASP.NET コードを記述して、テキストボックスとボタンの 2 つのコントロールを作成します。これらのコントロールにより、Web パーツの Title プロパティが設定されます。

Web パーツのロジックとレンダリングを定義するには

2 つのユーザーインターフェイスオブジェクトを作成します。これには、次のコードを、SimpleWebPart ファイルの先頭付近に追加します。
```
Button saveTitle;
TextBox newTitle;
```
```
Public saveTitle as Button
Public newTitle as TextBox
```

ボタン処理イベントを作成します。これには、次のコードをクラス内に追加します。

public void saveTitle_click(object sender, EventArgs e)
{
     this.Title = newTitle.Text;
     try
     {
          this.SaveProperties = true;
     }
     catch (Exception ex)
     {
          this.Title = "Error: " + ex.Message;
     }
}

Public Sub saveTitle_Click(ByVal sender As Object, ByVal e As EventArgs)
    Me.Title = newTitle.Text
    Try
        Me.SaveProperties = True
    Catch ex As Exception
        Me.Title = "Error: " & ex.Message
    End Try
End Sub

CreateChildControls() メソッドを無効にします。これには、次のコードをクラス内に追加します。

protected override void CreateChildControls()
{
     //Create text box
     newTitle = new TextBox();
     newTitle.Text = "";
     Controls.Add(newTitle);

     //Create button
     saveTitle = new Button();
     saveTitle.Text = "Set Web Part Title";
     saveTitle.Click += new EventHandler(saveTitle_click);
     Controls.Add(saveTitle);
}

Protected Overrides Sub CreateChildControls()
    'Create text box
    newTitle = New TextBox()
    newTitle.Text = ""
    Controls.Add(newTitle)

    'Create button
    saveTitle = New Button()
    saveTitle.Text = "Set Web Part Title"
    AddHandler saveTitle.Click, AddressOf saveTitle_Click
    Controls.Add(saveTitle)
End Sub

RenderWebPart() メソッドを、次のコード行に置き換えます。

protected override void  RenderWebPart(HtmlTextWriter output)
{
     RenderChildren(output);
}

Protected Overrides Sub RenderWebPart(ByVal output as HtmlTextWriter)
    RenderChildren(output)
End Sub

手順 9 : アセンブリ用の有効な厳密名を作成する

Web パーツは、インターネットまたはイントラネット上で配布するものとして設計されています。セキュリティ上の理由により、カスタム Web パーツの作成時には、ユーザーが Web パーツを信頼できるように、Web パーツに厳密名を付与する必要があります。厳密名の付与の詳細については、「Windows SharePoint Services で Web パーツを展開する」と、このウォークスルーの最後にある「Related Topics」を参照してください。

アセンブリに厳密名を割り当てるには

ソリューションエクスプローラで、SimpleWebPart プロジェクトを右クリックし、[プロパティ] をクリックします。
SimpleWebPart のプロパティで、左側にある [署名] タブをクリックします。
[署名] タブの、[アセンブリの署名] チェックボックスをオンにします。
[厳密な名前のキーファイルを選択してください] ボックスの一覧から、[新規作成] を選択します。
[厳密な名前キーの作成] ダイアログボックスで、「SimpleWebPartKey」と入力し、[キーファイルをパスワードで保護する] チェックボックスをオフにします。
これで、アセンブリはビルド時に署名されます。

手順 10 : Web パーツをビルドする

上記のコードをすべて追加したら、サンプル Web パーツをビルドすることができます。

Web パーツをビルドするには

[ビルド] メニューの [ソリューションのビルド] をクリックします。

手順 11 : DLL を bin ディレクトリにコピーする

Web パーツをビルドしたら、生成された DLL を bin ディレクトリにコピーする必要があります。

DLL を bin ディレクトリにコピーするには

ファイルシステムで SimpleWebPart.dll ファイルを探します。Visual Studio 2005 の場合、このファイルの既定の場所は、C:\Documents and Settings\ユーザー名\My Documents\Visual Studio 2005\Projects\SimpleWebPart\SimpleWebPart\bin\Debug です。
SimpleWebPart.dll ファイルを、出力ディレクトリから、Web アプリケーションルートにある bin ディレクトリにコピーします。の Web アプリケーションルートの既定の場所は、C:\Inetpub\wwwroot\wss\VirtualDirectories\ポート番号\bin です。

詳細については、「[方法] Web アプリケーションルートを調査する」を参照してください。

手順 12 : 既定の信頼レベルを上げ、Web パーツ用の SafeControl エントリを追加する

ユーザーが ASPX ページ内に不適切なサーバー側コードを追加しないようにするために、では SafeControls リストを使用できます。SafeControls リストには、特定の SharePoint サイトに関して、サイト内のどの ASPX ページでも安全に起動できることを保証するコントロールと Web パーツを列挙します。このリストは、Web アプリケーションルートの web.config ファイル内に指定します。ローカルパスには、web.config ファイルの物理的な場所を指定します。

既定の設定では、このサーバーに対する信頼レベルは WSS_Minimal で、Windows SharePoint Services オブジェクトモデルにはアクセスできません。この Web パーツで SaveProperties プロパティを設定するには、次の 3 つの作業のいずれかを行う必要があります。

アセンブリに対するカスタムポリシーファイルを作成します。
アセンブリをグローバルアセンブリキャッシュにインストールします。
仮想サーバー全体に対する信頼レベルを上げます。

この例では、web.config ファイルで、既定の信頼レベルを WSS_Minimal から WSS_Medium に上げます。


web.config ファイルは、Web サイト用の仮想ディレクトリが実行されているフォルダ内にあります。通常、このディレクトリは c:\inetpub\wwwroot\wss\VirtualDirectories\PortNumber ですが、管理者が別の方法でディレクトリを設定している場合、ファイルはこの場所にないこともあります。 web.config ファイルの場所を探すには、インターネットインフォメーションサービス (IIS) スナップインを使用できます。IIS スナップインは、IIS 用の管理ツールで、他の管理機能と統合されています。IIS スナップインを起動して web.config ファイルの場所を探すには、次のようにします。 [スタート] ボタンをクリックし、[プログラム]、[管理ツール] の順にポイントして、[インターネットインフォメーションサービス (IIS) マネージャ] をクリックします。ツリーで、コンピュータ名のノードを展開し、[Web サイト] を展開します。インストールしている Windows SharePoint Services の実行 Web サイトを特定します。多くの場合は、[既定の Web サイト] です。右クリックして [プロパティ] をクリックします。 [ホームディレクトリ] タブをクリックします。

web.config ファイルは、Web サイト用の仮想ディレクトリが実行されているフォルダ内にあります。通常、このディレクトリは c:\inetpub\wwwroot\wss\VirtualDirectories\PortNumber ですが、管理者が別の方法でディレクトリを設定している場合、ファイルはこの場所にないこともあります。

web.config ファイルの場所を探すには、インターネットインフォメーションサービス (IIS) スナップインを使用できます。IIS スナップインは、IIS 用の管理ツールで、他の管理機能と統合されています。IIS スナップインを起動して web.config ファイルの場所を探すには、次のようにします。

[スタート] ボタンをクリックし、[プログラム]、[管理ツール] の順にポイントして、[インターネットインフォメーションサービス (IIS) マネージャ] をクリックします。
ツリーで、コンピュータ名のノードを展開し、[Web サイト] を展開します。
インストールしている Windows SharePoint Services の実行 Web サイトを特定します。多くの場合は、[既定の Web サイト] です。
右クリックして [プロパティ] をクリックします。
[ホームディレクトリ] タブをクリックします。

既定の信頼レベルを上げ、Web パーツ用の SafeControl エントリを追加するには

Web アプリケーションルートにある web.config ファイルを開きます。
trust セクションで、level 属性の WSS_Minimal を「WSS_Medium」に変更します。

web.config ファイルの SafeControls セクションに、カスタムアセンブリ用の SafeControl エントリを次のように追加します。

<SafeControl Assembly="SimpleWebPart, Version=1.0.0.0, Culture=neutral, PublicKeyToken=PublicKeyToken" Namespace="MyWebParts" TypeName="SimpleWebPart" Safe="True"/>

PublicKeyToken を、Web パーツのアセンブリに使用する実際の値に置き換えます。Web パーツ用の正しい PublicKeyToken を確認するには、コマンドラインユーティリティ sn.exe を使用します。
```
sn.exe -T C:\inetpub\wwwroot\wss\VirtualDirectories\PortNumber\bin\SimpleWebPart.dll
```

手順 13 : Web パーツ展開用の DWP ファイルを作成する

Web パーツ定義ファイル (.dwp) は、単一の Web パーツのプロパティ設定値を格納する簡単な XML ファイルです。.dwp ファイルをアップロードするだけで、Web パーツページに Web パーツをインポートできます。Web パーツをアップロードしたら、Web パーツページのゾーンのいずれかに Web パーツをドラッグして表示できます。

.dwp ファイルで必須のプロパティは、Assembly と TypeName の 2 つです。ただし、インポートの後で Web パーツの既定の名前と説明を表示するには、Title プロパティと Description プロパティも含める必要があります。インポート中に他の Web パーツプロパティを設定する場合は、それらのプロパティも .dwp ファイル内で定義できます。.dwp ファイルの形式は次のとおりです。

<?xml version="1.0"?>
<WebPart xmlns="https://schemas.microsoft.com/WebPart/v2">
   <Assembly>AssemblyName(with no .dll extension),
     Version=VersionNumber, Culture=Culture,
     PublicKeyToken=PublicKeyToken</Assembly>
   <TypeName>WebPartNameSpace.WebPartClassName</TypeName>
   <Title>DefaultWebPartTitle</Title>
   <Description>WebPartDescription</Description>
</WebPart>

DWP ファイルを作成するには

次の XML をコピーして、新しいテキストファイルに貼り付けます。

<?xml version="1.0"?>
<WebPart xmlns="https://schemas.microsoft.com/WebPart/v2">
   <Assembly>SimpleWebPart, Version=1.0.0.0, Culture=Neutral, PublicKeyToken=PublicKeyToken</Assembly>
   <TypeName>MyWebParts.SimpleWebPart</TypeName>
   <Title>My Simple Web Part</Title>
   <Description>A simple Web Part</Description>
</WebPart>

重要

XML 内の PublicKeyToken は、アセンブリ用の公開キートークンに置き換えてください。

このファイルに「SimpleWebPart.dwp」という名前を付け、Web アプリケーションルートの bin ディレクトリに保存します。

手順 14 : Web パーツを Web パーツページにインポートする

Web パーツを使用およびテストするには、Windows SharePoint Services または Microsoft Office SharePoint Server 2007 が稼働しているサーバー上の Web パーツページに Web パーツをインポートします。

Web パーツをインポートするには

SharePoint サイトの中で、Web パーツをアクセス可能にするページに移動します。
Web バーツページで [サイトの操作] メニューの [サイトの設定] をクリックします。
[サイトの設定] ページで、見出し [ギャラリー] にある [Web パーツ] をクリックします。
Web パーツギャラリーで、ツールバーの [アップロード] をクリックします。
[Web パーツのアップロード] ページで、[参照] をクリックし、作成した .dwp ファイルを選択します。

注意

このファイルは、C:\inetpub\wwwroot\wss\VirtualDirectories\PortNumber\bin\ にあります。

[OK] をクリックします。
Web パーツページに戻り、[サイトの操作] をクリックして、[ページの編集] を選択します。
任意のゾーンで [Web パーツの追加] をクリックし、ダイアログボックス内の [My Simple Web Part] の横にあるチェックボックスをオンにして、[追加] をクリックします。
Web パーツをゾーンに追加したら、テキストボックスに適切なテキストを入力し、[Set Web Part Title] をクリックして Web パーツをテストします。

Share via

基本的な SharePoint Web パーツの作成

前提条件

手順 1 : 新しい Web コントロールライブラリプロジェクトを作成する

新しい Web コントロールライブラリプロジェクトを作成するには

手順 2 : Microsoft.SharePoint.dll への参照を追加する

Microsoft.SharePoint.dll への参照を追加するには

手順 3 : バージョン番号を設定し、部分的に信頼された呼び出し元をセットアップする

バージョン番号を設定し、部分的に信頼された呼び出し元を許可するには

手順 4 : クラスと名前空間の名前を変更する

クラスと名前空間の名前を変更するには

手順 5 : 名前空間ディレクティブを追加する

名前空間ディレクティブを追加するには

手順 6 : Web パーツクラスから継承する

Web パーツ基本クラスから継承するには

手順 7 : RenderWebPart メソッドを使用する

RenderWebPart メソッドを使用するには

手順 8 : Web パーツのロジックとレンダリングを定義する

Web パーツのロジックとレンダリングを定義するには

手順 9 : アセンブリ用の有効な厳密名を作成する

アセンブリに厳密名を割り当てるには

手順 10 : Web パーツをビルドする

Web パーツをビルドするには

手順 11 : DLL を bin ディレクトリにコピーする

DLL を bin ディレクトリにコピーするには

手順 12 : 既定の信頼レベルを上げ、Web パーツ用の SafeControl エントリを追加する

既定の信頼レベルを上げ、Web パーツ用の SafeControl エントリを追加するには

手順 13 : Web パーツ展開用の DWP ファイルを作成する

DWP ファイルを作成するには

手順 14 : Web パーツを Web パーツページにインポートする

Web パーツをインポートするには

See Also

その他のリソース

その他のリソース

Share via

基本的な SharePoint Web パーツの作成

前提条件

手順 1 : 新しい Web コントロール ライブラリ プロジェクトを作成する

新しい Web コントロール ライブラリ プロジェクトを作成するには

手順 2 : Microsoft.SharePoint.dll への参照を追加する

Microsoft.SharePoint.dll への参照を追加するには

手順 3 : バージョン番号を設定し、部分的に信頼された呼び出し元をセットアップする

バージョン番号を設定し、部分的に信頼された呼び出し元を許可するには

手順 4 : クラスと名前空間の名前を変更する

クラスと名前空間の名前を変更するには

手順 5 : 名前空間ディレクティブを追加する

名前空間ディレクティブを追加するには

手順 6 : Web パーツ クラスから継承する

Web パーツ基本クラスから継承するには

手順 7 : RenderWebPart メソッドを使用する

RenderWebPart メソッドを使用するには

手順 8 : Web パーツのロジックとレンダリングを定義する

Web パーツのロジックとレンダリングを定義するには

手順 9 : アセンブリ用の有効な厳密名を作成する

アセンブリに厳密名を割り当てるには

手順 10 : Web パーツをビルドする

Web パーツをビルドするには

手順 11 : DLL を bin ディレクトリにコピーする

DLL を bin ディレクトリにコピーするには

手順 12 : 既定の信頼レベルを上げ、Web パーツ用の SafeControl エントリを追加する

既定の信頼レベルを上げ、Web パーツ用の SafeControl エントリを追加するには

手順 13 : Web パーツ展開用の DWP ファイルを作成する

DWP ファイルを作成するには

手順 14 : Web パーツを Web パーツ ページにインポートする

Web パーツをインポートするには

See Also

その他のリソース

その他のリソース

手順 1 : 新しい Web コントロールライブラリプロジェクトを作成する

新しい Web コントロールライブラリプロジェクトを作成するには

手順 6 : Web パーツクラスから継承する

手順 14 : Web パーツを Web パーツページにインポートする