チュートリアル: SharePoint アプリケーションページを作成する

[アーティクル]
01/13/2024

アプリケーションページとは、特殊なフォームの ASP.NET ページです。アプリケーションページには、SharePoint のマスターページとマージされるコンテンツが含まれます。詳細については、SharePoint のアプリケーションページの作成に関するページを参照してください。

このチュートリアルでは、アプリケーションページを作成し、そのページをローカル SharePoint サイトを使ってデバッグする方法を説明します。このページには、サーバーファーム上のあらゆるサイトで、各ユーザーが作成または変更したすべての項目が表示されます。

このチュートリアルでは、次の作業について説明します。

SharePoint プロジェクトを作成する
SharePoint プロジェクトにアプリケーションページを追加する
アプリケーションページに ASP.NET コントロールを追加する
ASP.NET コントロールに分離コードを追加する
アプリケーションページをテストする

Note

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

前提条件

サポート対象エディションの Windows と SharePoint

SharePoint プロジェクトを作成する

まず、空の SharePoint プロジェクトを作成します。後で、このプロジェクトに [アプリケーションページ] 項目を追加します。

Visual Studio を起動します。
[新しいプロジェクト] ダイアログボックスを開き、使用する言語の [Office/SharePoint] ノードを展開して、[SharePoint ソリューション] ノードを選択します。
[Visual Studio にインストールされたテンプレート] ペインで [SharePoint 2010 - 空のプロジェクト] を選択します。プロジェクトに MySharePointProject という名前を付け、[OK] をクリックします。

SharePoint カスタマイズウィザードが表示されます。このウィザードを使用すると、プロジェクトのデバッグに使用するサイトや、ソリューションの信頼レベルを選択できます。
[ファームソリューションとして配置する] オプションボタンをクリックしてから、[完了] をクリックして、ローカル SharePoint サイトの構成を既定値のままにします。

アプリケーションページを作成する

アプリケーションページを作成するには、プロジェクトに [アプリケーションページ] 項目を追加します。

ソリューションエクスプローラーで、MySharePointProject プロジェクトを選択します。
メニューバーで [プロジェクト]>[新しい項目の追加] の順に選択します。
[新しい項目の追加] ダイアログボックスで、[アプリケーションページ (ファームソリューションのみ)] テンプレートを選択します。
このページに SearchItems という名前を付け、[追加] をクリックします。

Visual Web Developer デザイナーのソース ビューにアプリケーションページが表示されます。このビューでは、対象ページの HTML 要素を確認できます。デザイナーにはいくつかの Content コントロールのマークアップが表示されます。各コントロールは、既定のアプリケーションマスターページに定義されている ContentPlaceHolder コントロールにマップされます。

アプリケーションページのレイアウトをデザインする

アプリケーションページ項目を使用すると、デザイナーで ASP.NET コントロールをアプリケーションページに追加できます。このデザイナーは、Visual Web Developer で使用するデザイナーと同じです。ラベル、オプションボタンリスト、およびテーブルをデザイナーのソース ビューに追加し、標準的な ASP.NET ページをデザインする場合と同様にプロパティを設定します。

メニューバーで [表示]、[ツールボックス] の順にクリックします。
ツールボックスの [標準] ノードで、次のいずれかの手順に従います。
- [Label] 項目のショートカットメニューを開き、[コピー] を選択します。デザイナーで、PlaceHolderMain コンテンツコントロールの下にある行のショートカットメニューを開き、[貼り付け] を選択します。
- ツールボックスの [Label] 項目を、PlaceHolderMain コンテンツコントロールの本体までドラッグします。
上記と同じ手順で、[DropDownList] 項目と [Table] 項目を PlaceHolderMain コンテンツコントロールに追加します。
デザイナーで、ラベルコントロールの Text 属性の値を [すべての項目を表示] に変更します。

デザイナーで、<asp:DropDownList> 要素を次の XML に置き換えます。

<asp:DropDownList ID="DropDownList1" runat="server" AutoPostBack="true"
 OnSelectedIndexChanged="DropDownList1_SelectedIndexChanged">
    <asp:ListItem Text="Created by me" Value="Author"></asp:ListItem>
    <asp:ListItem Text="Modified by me" Value="Editor"></asp:ListItem>
</asp:DropDownList>

ページ上のコントロールのイベントを処理する

ASP.NET ページと同様に、アプリケーションページのコントロールを処理します。この手順では、ドロップダウンリストの SelectedIndexChanged イベントを処理します。

[表示] メニューの [コード] を選択します。

コードエディターでアプリケーションページコードファイルが開きます。

次のメソッドを SearchItems クラスに追加します。このコードでは、このチュートリアルでこれから作成するメソッドを呼び出して、SelectedIndexChanged の DropDownList イベントを処理します。

protected void DropDownList1_SelectedIndexChanged(object sender, EventArgs e)
{
    SPSecurity.RunWithElevatedPrivileges(GetItems);
   
}

 Protected Sub DropDownList1_SelectedIndexChanged _
(ByVal sender As Object, ByVal e As EventArgs) _
Handles DropDownList1.SelectedIndexChanged
     SPSecurity.RunWithElevatedPrivileges(AddressOf GetItems)
 End Sub

アプリケーションページコードファイルの先頭に次のステートメントを追加します。

using System.Web.UI.WebControls;
using Microsoft.SharePoint.Administration;
using System.Collections;

Imports System.Web.UI.WebControls
Imports Microsoft.SharePoint.Administration
Imports System.Collections

次のメソッドを SearchItems クラスに追加します。このメソッドでは、サーバーファーム上のすべてのサイトについて反復処理を行い、現在のユーザーが作成または変更した項目を検索します。

private void GetItems()
{
     SPFieldUserValue currentUser = new SPFieldUserValue
     (this.Web, this.Web.CurrentUser.ID, this.Web.CurrentUser.Name);

    ArrayList resultsList = new ArrayList();

    SPFarm thisFarm = SPFarm.Local;
    SPWebService service = thisFarm.Services.GetValue<SPWebService>("");

    foreach (SPWebApplication webApp in service.WebApplications)
    {
        foreach (SPSite siteCollection in webApp.Sites)
        {
            foreach (SPWeb web in siteCollection.AllWebs)
            {
                SPListCollection lists = web.Lists;
                foreach (SPList list in lists)
                {
                    try
                    {
                        foreach (SPListItem item in list.Items)
                        {
                            if (item[DropDownList1.SelectedValue].ToString() ==
                                currentUser.ToString())
                            {
                                resultsList.Add(item);
                            }
                        }
                    }
                    catch (Exception)
                    {
                        // An error with the list. Move onto the next list.
                    }
                }
            }
        }
    }
    CreateResultsTable(resultsList);

}

Private Sub GetItems()
    Dim CurrentUser As New SPFieldUserValue _
        (Me.Web, Me.Web.CurrentUser.ID, Me.Web.CurrentUser.Name)

    Dim ResultsList As New ArrayList()

    Dim ThisFarm As SPFarm = SPFarm.Local
    Dim Service As SPWebService = _
        ThisFarm.Services.GetValue(Of SPWebService)("")

    Dim WebApp As SPWebApplication
    For Each WebApp In Service.WebApplications
        Dim SiteCollection As SPSite
        For Each SiteCollection In WebApp.Sites
            Dim Web As SPWeb
            For Each Web In SiteCollection.AllWebs
                Dim Lists As SPListCollection = Web.Lists
                Dim List As SPList
                For Each List In Lists
                    Dim Item As SPListItem
                    Try
                        For Each Item In List.Items
                            If Item(DropDownList1.SelectedValue).ToString() = _
                                CurrentUser.ToString() Then
                                ResultsList.Add(Item)
                            End If
                        Next Item
                    Catch exception As Exception
                        'Error in list. Move on to the next list.
                    End Try
                Next List
            Next Web
        Next SiteCollection
    Next WebApp
    CreateResultsTable(ResultsList)
End Sub

次のメソッドを SearchItems クラスに追加します。このメソッドでは、現在のユーザーが作成または変更した項目をテーブルに表示します。

private void CreateResultsTable(ArrayList resultsList)
{
    string currentList = "";
    string currentSite = "";
    Table1.Rows.Clear();

    foreach (SPListItem item in resultsList)
    {
        if (item.ParentList.ParentWeb.Title != currentSite)
        {
            currentSite = item.ParentList.ParentWeb.Title;

            TableCell newSiteCell = new TableCell();
            newSiteCell.Text = currentSite;

            TableRow newSiteRow = new TableRow();
            newSiteRow.Cells.Add(newSiteCell);
            newSiteRow.Font.Bold = true;
            newSiteRow.Font.Size = FontUnit.Larger;
            newSiteRow.Font.Underline = true;

            Table1.Rows.Add(newSiteRow);
        }
        if (item.ParentList.Title != currentList)
        {
            currentList = item.ParentList.Title;
            TableCell newListCell = new TableCell();
            newListCell.Text = currentList;

            TableRow newListRow = new TableRow();
            newListRow.Cells.Add(newListCell);
            newListRow.Font.Bold = true;

            Table1.Rows.Add(newListRow);

            TableCell itemHeading = new TableCell();
            itemHeading.Text = "Item";
            itemHeading.Font.Italic = true;

            TableCell createdHeading = new TableCell();
            createdHeading.Text = "Created";
            createdHeading.Font.Italic = true;

            TableCell modifiedHeading = new TableCell();
            modifiedHeading.Text = "Last Modified";
            modifiedHeading.Font.Italic = true;

            TableRow headingRow = new TableRow();
            headingRow.Cells.Add(itemHeading);
            headingRow.Cells.Add(createdHeading);
            headingRow.Cells.Add(modifiedHeading);

            Table1.Rows.Add(headingRow);
        }

        TableCell itemName = new TableCell();
        HyperLink itemLink = new HyperLink();
        try
        {
            itemLink.NavigateUrl = item.ParentList.ParentWeb.Url + "/" +
                item.ParentList.Forms[PAGETYPE.PAGE_DISPLAYFORM].Url +
                "?ID=" + item.ID;
        }
        catch (Exception)
        {
            // Some items might not have a form page. Ignore the exception.
        }
        itemLink.Text = item.DisplayName;
        itemName.Controls.Add(itemLink);

        TableCell created = new TableCell();
        created.Text = item["Created"].ToString();

        TableCell modified = new TableCell();
        modified.Text = item["Modified"].ToString();

        TableRow dataRow = new TableRow();
        dataRow.Cells.Add(itemName);
        dataRow.Cells.Add(created);
        dataRow.Cells.Add(modified);

        Table1.Rows.Add(dataRow);
    }
}

Private Sub CreateResultsTable(ByVal ResultsList As ArrayList)
    Dim CurrentList As String = ""
    Dim CurrentSite As String = ""
    Table1.Rows.Clear()

    Dim Item As SPListItem
    For Each Item In ResultsList
        If Item.ParentList.ParentWeb.Title <> CurrentSite Then
            CurrentSite = Item.ParentList.ParentWeb.Title

            Dim NewSiteCell As New TableCell()
            NewSiteCell.Text = CurrentSite

            Dim NewSiteRow As New TableRow()
            With NewSiteRow
                .Cells.Add(NewSiteCell)
                .Font.Bold = True
                .Font.Size = FontUnit.Larger
                .Font.Underline = True
            End With
            Table1.Rows.Add(NewSiteRow)

        End If

        If Item.ParentList.Title <> CurrentList Then
            CurrentList = Item.ParentList.Title
            Dim NewListCell As New TableCell()
            NewListCell.Text = CurrentList

            Dim NewListRow As New TableRow()
            With NewListRow
                .Cells.Add(NewListCell)
                .Font.Bold = True
            End With
            Table1.Rows.Add(NewListRow)

            Dim ItemHeading As New TableCell()
            With ItemHeading
                .Text = "Item"
                .Font.Italic = True
            End With

            Dim CreatedHeading As New TableCell()
            With CreatedHeading
                .Text = "Created"
                .Font.Italic = True
            End With


            Dim ModifiedHeading As New TableCell()
            With ModifiedHeading
                .Text = "Last Modified"
                .Font.Italic = True
            End With

            Dim HeadingRow As New TableRow()
            HeadingRow.Cells.Add(ItemHeading)
            HeadingRow.Cells.Add(CreatedHeading)
            HeadingRow.Cells.Add(ModifiedHeading)

            Table1.Rows.Add(HeadingRow)
        End If

        Dim ItemName As New TableCell()
        Dim ItemLink As New HyperLink()
        Try
            ItemLink.NavigateUrl = Item.ParentList.ParentWeb.Url & _
                "/" & Item.ParentList.Forms(PAGETYPE.PAGE_DISPLAYFORM).Url & _
                "?ID=" & Item.ID
        Catch exception As Exception
            ' Some items might not have a form page. Ignore the exception.
        End Try
        ItemLink.Text = Item.DisplayName
        ItemName.Controls.Add(ItemLink)

        Dim Created As New TableCell()
        Created.Text = Item("Created").ToString()

        Dim Modified As New TableCell()
        Modified.Text = Item("Modified").ToString()

        Dim DataRow As New TableRow()
        DataRow.Cells.Add(ItemName)
        DataRow.Cells.Add(Created)
        DataRow.Cells.Add(Modified)

        Table1.Rows.Add(DataRow)
    Next Item
End Sub

アプリケーションページをテストする

プロジェクトを実行すると、SharePoint サイトが開き、アプリケーションページが表示されます。

ソリューションエクスプローラーで、アプリケーションページのショートカットメニューを開き、[スタートアップアイテムとして設定] を選択します。
F5 キーを押します。

SharePoint サイトが開きます。
アプリケーションページで [自分が更新者] を選択します。

アプリケーションページが更新され、サーバーファーム上のすべてのサイトで自分が変更したすべての項目が表示されます。
アプリケーションページの一覧で [現在のユーザーが作成] を選択します。

アプリケーションページが更新され、サーバーファーム上のすべてのサイトで自分が作成したすべての項目が表示されます。

次のステップ

SharePoint アプリケーションページの詳細については、「SharePoint のアプリケーションページの作成」を参照してください。

Visual Web Designer を使用して、SharePoint ページの内容をデザインする方法の詳細については、以下のトピックを参照してください。

次の方法で共有

チュートリアル: SharePoint アプリケーションページを作成する

前提条件

SharePoint プロジェクトを作成する

アプリケーションページを作成する

アプリケーションページのレイアウトをデザインする

ページ上のコントロールのイベントを処理する

アプリケーションページをテストする

次のステップ

フィードバック

その他のリソース

次の方法で共有

チュートリアル: SharePoint アプリケーション ページを作成する

前提条件

SharePoint プロジェクトを作成する

アプリケーション ページを作成する

アプリケーション ページのレイアウトをデザインする

ページ上のコントロールのイベントを処理する

アプリケーション ページをテストする

次のステップ

関連するコンテンツ

フィードバック

その他のリソース

チュートリアル: SharePoint アプリケーションページを作成する

アプリケーションページを作成する

アプリケーションページのレイアウトをデザインする

アプリケーションページをテストする