SharePoint Web パーツをファームソリューションのアドインパーツに置き換える

[アーティクル]
04/08/2023

変換プロセスを使用して、ページ上にある SharePoint Web パーツをアドインパーツに置換できます。その際、CSOM を使用して特定の Web パーツを検索および削除し、新しいアドインパーツを追加します。

重要

ファームソリューションは、SharePoint Online に移行できません。この記事で取り上げられている技法とコードを適用すると、ファームソリューションと同様の機能を提供する新しいソリューションを構築して、SharePoint Online に展開できます。これらの技法を適用すると、その後、アドインパーツを使用するようにページが更新され、それを SharePoint Online に移行できるようになります。

完全に機能するソリューションを実現するには、この記事のコードに、追加のコードが必要になります。たとえば、この記事では、Office 365 に対する認証を実行する方法や、必要な例外処理を実装する方法などについては取り上げていません。追加のコードサンプルについては、「Office 365 Developer Patterns and Practices プロジェクト」を参照してください。

注:

この記事で提供されるコードは、明示または黙示のいかなる種類の保証なしに現状のまま提供されるものであり、特定目的への適合性、商品性、権利侵害の不存在についての暗黙的な保証は一切ありません。

Web パーツを新しいアドインパーツに置換するには次のようにします。

新しいアドインパーツをエクスポートして、アドインパーツ定義を取得します。
アドインパーツ定義を使用して、ページ上に新しいアドインパーツを作成します。
置換対象の Web パーツが含まれるすべてのページを検出し、それらの Web パーツを削除します。

はじめに

Web パーツをアドインパーツに置換するためにこの記事の手順を実行する前に、以下を確認してください。

使用している SharePoint 環境がアドインをサポートするように構成済みであること。SharePoint Online がアドインをサポートするように構成されていること。オンプレミスの SharePoint Server を使用している場合には、「SharePoint Server 用アプリの環境を構成する」をご覧ください。
新しいアドインパーツが SharePoint に既に展開されていること。
Web に対する FullControl アクセス許可がアドインに割り当てられていること。詳細については、「SharePoint 2013 でのアドインのアクセス許可」を参照してください。

新しいアドインパーツをエクスポートする

CSOM を使用して Web パーツをアドインパーツに置換するには、アドインパーツをエクスポートしてアドインパーツ定義を取得する必要があります。アドインパーツの定義を取得するためにアドインパーツをエクスポートするには、次のようにします。

SharePoint サイトを開き、[設定] を選択するか、ギアアイコンを選択し、[ページの編集] を選択します。
リボンで、[挿入]>[アドインパーツ] を選択します。
目的のアドインパーツを選択し、[追加] を選択します。
アドインパーツがページに追加されたら、アドインパーツの右上隅にある下矢印を選択し、[Web パーツの編集] を選択します。
[詳細] の [エクスポートモード] で [すべてのデータをエクスポート]、[OK] の順に選択します。
ご使用のアドインパーツが表示された編集ページに戻ったら、アドインパーツの右上隅にある下矢印を選択して、[エクスポート] を選択します。
[保存] を選択します。
ダウンロードの完了後、[フォルダーを開く] を選択します。
[メモ帳] を開き、[ファイル]>[開く] を選択します。
ダウンロードしたアドインパーツファイルを選択し、[開く] を選択してアドインパーツ定義を表示します。

<webParts>
  <webPart xmlns="http://schemas.microsoft.com/WebPart/v3">
    <metaData>
      <type name="Microsoft.SharePoint.WebPartPages.ClientWebPart, Microsoft.SharePoint, Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" />
      <importErrorMessage>Cannot import this web part.</importErrorMessage>
    </metaData>
    <data>
      <properties>
        <property name="TitleIconImageUrl" type="string" />
        <property name="Direction" type="direction">NotSet</property>
        <property name="ExportMode" type="exportmode">All</property>
        <property name="HelpUrl" type="string" />
        <property name="Hidden" type="bool">False</property>
        <property name="Description" type="string">WelcomeAppPart Description</property>
        <property name="FeatureId" type="System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">0b846986-3474-4f1a-93cf-b7817ef057f9</property>
        <property name="CatalogIconImageUrl" type="string" />
        <property name="Title" type="string">WelcomeAppPart</property>
        <property name="AllowHide" type="bool">True</property>
        <property name="ProductWebId" type="System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">741c5404-f43e-4f01-acfb-fcd100fc7d24</property>
        <property name="AllowZoneChange" type="bool">True</property>
        <property name="TitleUrl" type="string" />
        <property name="ChromeType" type="chrometype">Default</property>
        <property name="AllowConnect" type="bool">True</property>
        <property name="Width" type="unit" />
        <property name="Height" type="unit" />
        <property name="WebPartName" type="string">WelcomeAppPart</property>
        <property name="HelpMode" type="helpmode">Navigate</property>
        <property name="AllowEdit" type="bool">True</property>
        <property name="AllowMinimize" type="bool">True</property>
        <property name="ProductId" type="System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">0b846986-3474-4f1a-93cf-b7817ef057f8</property>
        <property name="AllowClose" type="bool">True</property>
        <property name="ChromeState" type="chromestate">Normal</property>
      </properties>
    </data>
  </webPart>
</webParts>

アドインパーツ定義を使用して、ページ上に新しいアドインパーツを作成する

CSOM コードでアドインパーツ定義を使用するには、次のようにします。

アドインパーツ定義にあるすべての二重引用符 (") を二重引用符のペア ("") に置き換えます。
アドインパーツ定義を、CSOM コードで使用する文字列に割り当てます。

private const string appPartXml = @"<webParts>
  <webPart xmlns=""http://schemas.microsoft.com/WebPart/v3"">
    <metaData>
      <type name=""Microsoft.SharePoint.WebPartPages.ClientWebPart, Microsoft.SharePoint, Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c"" />
      <importErrorMessage>Cannot import this web part.</importErrorMessage>
    </metaData>
    <data>
      <properties>
        <property name=""TitleIconImageUrl"" type=""string"" />
        <property name=""Direction"" type=""direction"">NotSet</property>
        <property name=""ExportMode"" type=""exportmode"">All</property>
        <property name=""HelpUrl"" type=""string"" />
        <property name=""Hidden"" type=""bool"">False</property>
        <property name=""Description"" type=""string"">WelcomeAppPart Description</property>
        <property name=""FeatureId"" type=""System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"">0b846986-3474-4f1a-93cf-b7817ef057f9</property>
        <property name=""CatalogIconImageUrl"" type=""string"" />
        <property name=""Title"" type=""string"">WelcomeAppPart Title</property>
        <property name=""AllowHide"" type=""bool"">True</property>
        <property name=""ProductWebId"" type=""System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"">717c00a1-08ea-41a5-a2b7-4c8f9c1ce770</property>
        <property name=""AllowZoneChange"" type=""bool"">True</property>
        <property name=""TitleUrl"" type=""string"" />
        <property name=""ChromeType"" type=""chrometype"">Default</property>
        <property name=""AllowConnect"" type=""bool"">True</property>
        <property name=""Width"" type=""unit"" />
        <property name=""Height"" type=""unit"" />
        <property name=""WebPartName"" type=""string"">WelcomeAppPart</property>
        <property name=""HelpMode"" type=""helpmode"">Navigate</property>
        <property name=""AllowEdit"" type=""bool"">True</property>
        <property name=""AllowMinimize"" type=""bool"">True</property>
        <property name=""ProductId"" type=""System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"">0b846986-3474-4f1a-93cf-b7817ef057f8</property>
        <property name=""AllowClose"" type=""bool"">True</property>
        <property name=""ChromeState"" type=""chromestate"">Normal</property>
      </properties>
    </data>
  </webPart>
</webParts>";

置換対象の Web パーツが含まれるページをすべて検出し、それらの Web パーツを削除します。

置換する Web パーツを検出する

ReplaceWebPartsWithAppParts は、次のようにして、置換対象の Web パーツの検出プロセスを開始します。

Web からいくつかのプロパティを取得して、サイト上の Pages ライブラリを見つけます。
Pages ライブラリで、リスト項目と、そのリスト項目に関連付けられているファイルを取得します。

Pages ライブラリから戻されるそれぞれのリスト項目ごとに、FindWebPartToReplace を呼び出します。

 protected void ReplaceWebPartsWithAppParts(object sender, EventArgs e)
 {
     var spContext = SharePointContextProvider.Current.GetSharePointContext(Context);
     using (var clientContext = spContext.CreateUserClientContextForSPHost())
     {
         Web web = clientContext.Web;
         // Get properties from the Web.
         clientContext.Load(web,
                             w => w.ServerRelativeUrl,
                             w => w.AllProperties);
         clientContext.ExecuteQuery();
         // Read the Pages library name from the Web properties.
         var pagesListName = web.AllProperties["__pageslistname"] as string;

         var list = web.Lists.GetByTitle(pagesListName);
         var items = list.GetItems(CamlQuery.CreateAllItemsQuery());
         // Get the file associated with each list item.
         clientContext.Load(items,
                             i => i.Include(
                                     item => item.File));
         clientContext.ExecuteQuery();

         // Iterate through all pages in the Pages list.
         foreach (var item in items)
         {
             FindWebPartForReplacement(item, clientContext, web);
         }
     }
 }

新しいアドインパーツに置換される Web パーツを検出する

FindWebPartToReplace は、次のようにして、新しいアドインパーツに置換する必要がある Web パーツを検出します。

page を、Pages ライブラリから返されたリスト項目に関連付けられているファイルに設定します。
LimitedWebPartManager を使用して、特定のページ上のすべての Web パーツを検出します。また、各 Web パーツのタイトルもラムダ式に返されます。

Web パーツマネージャーの WebParts プロパティにあるそれぞれの Web パーツについて、Web パーツのタイトルと、(置換前の Web パーツのタイトルに設定されている) oldWebPartTitle 変数が等しいかどうか判別します。 Web パーツタイトルと oldWebPartTitle が等しい場合は、ReplaceWebPart を呼び出します。等しくない場合は、foreach ループの次の反復を続行します。

 private static void FindWebPartToReplace(ListItem item, ClientContext clientContext, Web web)
 {
     File page = item.File;
     // Requires Full Control permissions on the Web.
     LimitedWebPartManager webPartManager = page.GetLimitedWebPartManager(PersonalizationScope.Shared);
     clientContext.Load(webPartManager,
                         wpm => wpm.WebParts,
                         wpm => wpm.WebParts.Include(
                                             wp => wp.WebPart.Title));
     clientContext.ExecuteQuery();

     foreach (var oldWebPartDefinition in webPartManager.WebParts)
     {
         var oldWebPart = oldWebPartDefinition.WebPart;
         // Modify the web part if we find an old web part with the same title.
         if (oldWebPart.Title != oldWebPartTitle) continue;

         ReplaceWebPart(web, item, webPartManager, oldWebPartDefinition, clientContext, page);
     }
 }

新しい Web パーツに置換する

ReplaceWebPart は、次のようにして、新しい Web パーツを置換します。

LimitedWebPartManager.ImportWebPart を使用して、appPartXml 内の XML 文字列を WebPartDefinition に変換します。
LimitedWebPartManager.AddWebPart を使用して、特定の Web パーツ領域内でページに Web パーツを追加します。必ず zoneId を AddWebPart に渡してください。そうでないと、ExecuteQuery の実行時に例外がスローされます。

WebPartDefinition.DeleteWebPart を使用して、ページから古い Web パーツを削除します。

 private static void ReplaceWebPart(Web web, ListItem item, LimitedWebPartManager webPartManager,
       WebPartDefinition oldWebPartDefinition, ClientContext clientContext, File page)
   {

       // Create a web part definition using the XML string.
       var definition = webPartManager.ImportWebPart(appPartXml);
       webPartManager.AddWebPart(definition.WebPart, "RightColumn", 0);

       // Delete the old web part from the page.
       oldWebPartDefinition.DeleteWebPart();
       clientContext.Load(page,
                           p => p.CheckOutType,
                           p => p.Level);

       clientContext.ExecuteQuery();

   }

SharePoint Web パーツをファームソリューションのアドインパーツに置き換える

はじめに

新しいアドインパーツをエクスポートする

アドインパーツ定義を使用して、ページ上に新しいアドインパーツを作成する

置換対象の Web パーツが含まれるページをすべて検出し、それらの Web パーツを削除します。

置換する Web パーツを検出する

新しいアドインパーツに置換される Web パーツを検出する

新しい Web パーツに置換する

関連項目

その他のリソース

SharePoint Web パーツをファーム ソリューションのアドイン パーツに置き換える

はじめに

新しいアドイン パーツをエクスポートする

アドイン パーツ 定義を使用して、ページ上に新しいアドイン パーツを作成する

置換対象の Web パーツが含まれるページをすべて検出し、それらの Web パーツを削除します。

置換する Web パーツを検出する

新しいアドイン パーツに置換される Web パーツを検出する

新しい Web パーツに置換する

関連項目

その他のリソース

SharePoint Web パーツをファームソリューションのアドインパーツに置き換える

新しいアドインパーツをエクスポートする

アドインパーツ定義を使用して、ページ上に新しいアドインパーツを作成する

新しいアドインパーツに置換される Web パーツを検出する