Web パーツまたはアプリケーション ページの再利用できるコントロールを作成する

Visual Studio では、SharePoint で実行されるアプリケーション ページと Web パーツで使用できる、再利用可能なカスタム コントロールを作成できます。 これらのコントロールは、ユーザー コントロールと呼ばれます。 ユーザー コントロールは、ASP.NET Web ページと同様に動作する一種の複合コントロールです。既存の Web サーバー コントロールやマークアップをユーザー コントロールに追加し、コントロールのプロパティとメソッドを定義することができます。 その後、それらを ASP.NET Web ページに埋め込むと、1 つの単位として機能します。

ユーザー コントロールを作成する

ユーザー コントロールを作成するには、空の SharePoint プロジェクトにユーザー コントロールを追加します。 詳細については、「方法:SharePoint アプリケーション ページまたは Web パーツのユーザー コントロールを作成する」を参照してください。

ユーザー コントロール項目を追加すると、Visual Studio によってプロジェクトにフォルダーが作成され、そのフォルダーにいくつかのファイルが追加されます。 各ファイルの説明を次の表に示します。

ユーザー コントロールをデザインする

Visual Studio の Visual Web Developer デザイナーを使用してユーザー コントロールをデザインします。 このデザイナーは、プロジェクトでユーザー コントロール ファイルを開き、[デザイン] タブをクリックすると表示されます。

ユーザー コントロールを使用する

ユーザー コントロールは、アプリケーション ページまたは Web パーツに含めるまでは SharePoint に表示されません。

アプリケーション ページにユーザー コントロールを含めるには、ASP.NET ユーザー コントロールを追加する Web ページを開きます。 デザイン ビューに切り替え、ソリューション エクスプローラーでカスタム ユーザー コントロール ファイルを選択して、ページにドラッグします。 ASP.NET ユーザー コントロールがページに追加され、デザイナーによって @ Register ディレクティブが作成されます。これは、ページがユーザー コントロールを認識するために必要です。 これで、コントロールのパブリック プロパティおよびメソッドを操作できるようになりました。

Web パーツにユーザー コントロールを追加するには、Web パーツ コード ファイルの Web パーツ Controls コレクションにユーザー コントロールを追加します。 次の例では、Web パーツの Controls コレクションにユーザー コントロールを追加します。

[ToolboxItemAttribute(false)]
public class VisualWebPart1 : WebPart
{
    private const string _ascxPath = @"~/_CONTROLTEMPLATES/CS/VisualWebPart1/VisualWebPart1UserControl.ascx";

    public VisualWebPart1()
    {
    }

    protected override void CreateChildControls()
    {
        Control control = this.Page.LoadControl(_ascxPath);
        Controls.Add(control);
        base.CreateChildControls();
    }

    protected override void RenderContents(HtmlTextWriter writer)
    {
        base.RenderContents(writer);
    }
    
}

<ToolboxItemAttribute(false)> _
Public Class VisualWebPart1
    Inherits WebPart

    Private Const _ascxPath As String = "~/_CONTROLTEMPLATES/VB/VisualWebPart1/VisualWebPart1UserControl.ascx"

    Public Sub New()
    End Sub

    Protected Overrides Sub CreateChildControls()
        Dim control As Control = Page.LoadControl(_ascxPath)
        Controls.Add(control)
        MyBase.CreateChildControls()
    End Sub

    Protected Overrides Sub RenderContents(ByVal writer As HtmlTextWriter)
        MyBase.RenderContents(writer)
    End Sub

End Class

ユーザー コントロールをデバッグする

ユーザー コントロールをデバッグするには、SharePoint プロジェクトのアプリケーション ページまたは Web パーツにユーザー コントロールが含まれていることを確認します。 次に、Visual Studio プロジェクトでコードをデバッグするのと同じように、ユーザー コントロールのコードをデバッグできます。

Visual Studio デバッガーを開始すると、SharePoint サイトが開きます。

SharePoint で、ユーザー コントロールを含むアプリケーション ページを開きます。 ユーザー コントロールが Web パーツに含まれている場合は、SharePoint の Web パーツ ページに Web パーツを追加します。

SharePoint プロジェクトのデバッグの詳細については、「SharePoint ソリューションのトラブルシューティング」を参照してください。

関連トピック