ファームソリューション内のモジュールを使用して展開された SharePoint ファイルを置き換える

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

ファームソリューション内のモジュールを使用してファイルを宣言して展開した場合は、それらをファイルへの参照を更新する新しいソリューションに変換し、クライアントオブジェクトモデル (CSOM) を使用して同様の機能を提供する方法を学習します。以前は、マスターページやページレイアウトなどのファイルを展開するためのモジュールが使用されました。

重要

ファームソリューションは、SharePoint Online に移行できません。この記事で取り上げられている技法とコードを適用することで、ファームソリューションと同様の機能を提供する新しいソリューションの構築と、ファイルへの参照の更新が可能となり、新しいソリューションを SharePoint Online に展開することができます。その後、機能を無効にして、以前のファームソリューションを取り消すことができます。

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

注:

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

この記事では、以下を実行する変換プロセスの使用方法について説明します。

マスターページのアップロードとマスターページへの参照の更新
ページレイアウトのアップロードとページレイアウトへの参照の更新

次の場合に、この変換プロセスを使用します。

既存のファームソリューションで、モジュールを使用してファイルを展開した場合。
ファームソリューション内のマスターページとページレイアウトを新しいマスターページとページレイアウトに置換し、それを SharePoint Online に移行する場合。
ファームソリューションのマスターページやページレイアウトに宣言的にドキュメントコンテンツタイプを設定してある場合。

はじめに

理想的には、既存のファームソリューションを確認して、この記事に記載されている手法を学習してから、それらの手法をシナリオに適用する方法を計画する必要があります。ファームソリューションに慣れていない場合や操作するファームソリューションが存在しない場合は、ファームソリューションについて学習することが役に立つ場合があります。

詳細については、「SharePoint でのファームソリューションの作成」を参照してください。

サイトコレクションとサイトで発行機能を有効にする

コードサンプルを実行する前に、以下のようにして、サイトコレクションとサイトで発行機能を有効にします。

サイトコレクションで SharePoint Server 発行インフラストラクチャ機能を有効にするには

SharePoint サイトを開き、[設定]>[サイトの設定] に移動します。
[サイトコレクションの管理] で、[サイトコレクションの機能] を選択します。
[SharePoint Server 発行インフラストラクチャ] で、[アクティブにする] を選択します。

サイトで SharePoint Server 発行機能を有効にするには

SharePoint サイトを開き、[設定]>[サイトの設定] に移動します。
[サイトアクション] で、[サイト機能の管理] を選択します。
[SharePoint Server 発行機能] で、[アクティブにする] を選択します。

Visual Studio プロジェクトをセットアップする

サンプルプロジェクトをダウンロードします。 [生データの表示] を選択してサンプルプロジェクトのダウンロードを開始し、zip ファイルからファイルを抽出してから、Module9/ModuleReplacement フォルダーに移動します。
ModuleReplacement.sln を開きます。
settings.xml を開きます。以下の属性を確認し、お客様の要件に合わせて更新します。
- masterpage 要素 - file 属性を使用してマスターページギャラリーに展開する新しいマスターページを指定します。また replaces 属性を使用してマスターページギャラリー内の既存のマスターページを指定します。
- pagelayout 要素 - file 属性を使用して新しいページレイアウトファイルを指定し、replaces 属性を使用して既存のページレイアウトファイルを指定します。また、他のいくつかの属性を使用して追加のページレイアウト情報を指定します。
```
 	<?xml version="1.0" encoding="utf-8" ?>
 	<branding>
 	  <masterPages>
 	       <masterPage file="contoso_app.master" replaces="contoso.master"/>
 	  </masterPages>
 	  <pageLayouts>
 	       <pageLayout file="ContosoWelcomeLinksApp.aspx" replaces="ContosoWelcomeLinks.aspx" title="Contoso Welcome Links add-in" associatedContentTypeName="Contoso Web Page" defaultLayout="true" />
 	  </pageLayouts>
 	</branding>
```
MasterPageGalleryFiles.cs の MasterPageGalleryFile クラスと LayoutFile クラスは、SharePoint にアップロードする新しいマスターページとページレイアウトに関する情報を格納するビジネスオブジェクトを定義します。

マスターページのアップロードとマスターページへの参照の更新

SharePoint サイトで新しいマスターページをアップロードしてマスターページへの参照を更新するには

Program.cs で、次の using ステートメントを追加します。
```
 	using System.Security;
```
Program.cs で、Office 365 に対する認証を実行するために次のメソッドを追加します。

static SecureString GetPassword()
      {
          SecureString sStrPwd = new SecureString();
          try
          {
              Console.Write("Password: ");

              for (ConsoleKeyInfo keyInfo = Console.ReadKey(true); keyInfo.Key != ConsoleKey.Enter; keyInfo = Console.ReadKey(true))
              {
                  if (keyInfo.Key == ConsoleKey.Backspace)
                  {
                      if (sStrPwd.Length > 0)
                      {
                          sStrPwd.RemoveAt(sStrPwd.Length - 1);
                          Console.SetCursorPosition(Console.CursorLeft - 1, Console.CursorTop);
                          Console.Write(" ");
                          Console.SetCursorPosition(Console.CursorLeft - 1, Console.CursorTop);
                      }
                  }
                  else if (keyInfo.Key != ConsoleKey.Enter)
                  {
                      Console.Write("*");
                      sStrPwd.AppendChar(keyInfo.KeyChar);
                  }

              }
              Console.WriteLine("");
          }
          catch (Exception e)
          {
              sStrPwd = null;
              Console.WriteLine(e.Message);
          }

          return sStrPwd;
      }

      static string GetUserName()
      {
          string strUserName = string.Empty;
          try
          {
              Console.Write("Username: ");
              strUserName = Console.ReadLine();
          }
          catch (Exception e)
          {
              Console.WriteLine(e.Message);
              strUserName = string.Empty;
          }
          return strUserName;
      }

Program.cs で、以下のタスクを実行する次のコードを Main メソッドに追加します。

settings.xml ファイルを読み込みます。
GetCatalog (116) を使用して、マスターページギャラリーへの参照を取得します。

マスターページがマスターページギャラリーにアップロードされます。マスターページギャラリーのリストテンプレートの識別子は 116 です。詳細については、「ListTemplate 要素 (サイト)」を参照してください。マスターページギャラリーに関するその他の詳細が読み込まれます。これには、マスターページギャラリーに関連付けられたコンテンツタイプを取得するための List.ContentTypes の使用が含まれます。
Web.ContentTypes、Web.MasterUrl、Web.CustomMasterUrl などの Web オブジェクトのプロパティを読み込みます。
parentMasterPageContentTypeId を、マスターページのコンテンツタイプ ID に設定します。詳細については、「コンテンツタイプの基本的な階層」を参照してください。

マスターページギャラリーからマスターページのコンテンツタイプを取得します。このコンテンツタイプは、後述する新しいマスターページのコンテンツタイプを設定するために使用します。

 static void Main(string[] args)
 	{ 
 		string userName = GetUserName();
 		SecureString pwd = GetPassword();

 	// End program if no credentials were entered.
 		if (string.IsNullOrEmpty(userName) || (pwd == null))
 		return;

 		using (var clientContext = new ClientContext("http://sharepoint.contoso.com"))
 		{

 			clientContext.AuthenticationMode = ClientAuthenticationMode.Default;
 			clientContext.Credentials = new SharePointOnlineCredentials(userName, pwd);

 			XDocument settings = XDocument.Load("settings.xml");

 			// Get a reference to the Master Page Gallery which will be used to upload new master pages. 

 			Web web = clientContext.Web;
 			List gallery = web.GetCatalog(116);
 			Folder folder = gallery.RootFolder;

 			// Load additional Master Page Gallery properties.
 			clientContext.Load(folder);
 			clientContext.Load(gallery,
 								g => g.ContentTypes,
 								g => g.RootFolder.ServerRelativeUrl);

 			// Load the content types and master page information from the web.
 			clientContext.Load(web,
 								w => w.ContentTypes,
 								w => w.MasterUrl,
 								w => w.CustomMasterUrl);
 			clientContext.ExecuteQuery();

 			// Get the content type for the master page from the Master Page Gallery using the content type ID for masterpages (0x010105).
 			const string parentMasterPageContentTypeId = "0x010105";  
 			ContentType masterPageContentType = gallery.ContentTypes.FirstOrDefault(ct => ct.StringId.StartsWith(parentMasterPageContentTypeId));
 			UploadAndSetMasterPages(web, folder, clientContext, settings, masterPageContentType.StringId);

 		}

 	}

Program.cs で、UploadAndSetMasterPages メソッドを追加します。このメソッドは、以下のようにして、MasterPageGalleryFile ビジネスオブジェクトのリストを作成します。
1. settings.xml で定義されたすべての masterPage 要素を読み取ります。
2. それぞれの masterPage 要素は、SharePoint にアップロードするマスターページを指定します。また、MasterPageGalleryFile ビジネスオブジェクトに属性値を読み込みます。
3. リスト内の各 MasterPageGalleryFile ビジネスオブジェクトは、UploadAndSetMasterPage を呼び出します。
```
 private static void UploadAndSetMasterPages(Web web, Folder folder, ClientContext clientContext, XDocument settings, string contentTypeId)
 {
 	IList<MasterPageGalleryFile> masterPages = (from m in settings.Descendants("masterPage")
 												select new MasterPageGalleryFile
 												{
 													File = (string)m.Attribute("file"),
 													Replaces = (string)m.Attribute("replaces"),
 													ContentTypeId = contentTypeId
 												}).ToList();
 	foreach (MasterPageGalleryFile masterPage in masterPages)
 	{
 		UploadAndSetMasterPage(web, folder, clientContext, masterPage);
 	}
 }
```

Program.cs で、UploadAndSetMasterPage メソッドを追加します。このメソッドは、以下のタスクを実行します。

マスターページをチェックアウトします。
FileCreationInformation を使用して新しいファイルをアップロードします。
新たにアップロードされたファイルに関連付けられているリスト項目を取得します。
リスト項目に各種プロパティを設定します。それには、リスト項目のコンテンツタイプ ID をマスターページのコンテンツタイプ ID に設定するという操作も含まれます。
新しいマスターページをチェックイン、発行、承認します。

現在のサイトのマスターページまたはカスタムのマスターページの URL が古いマスターページに設定されている場合は、Web.MasterUrl または Web.CustomMasterUrl を更新して、新しくアップロードされたマスターページの URL を使用するようにします。

 private static void UploadAndSetMasterPage(Web web, Folder folder, ClientContext clientContext, MasterPageGalleryFile masterPage)
 {
 	using (var fileReadingStream = System.IO.File.OpenRead(masterPage.File))
 	{
 		// If necessary, ensure that the master page is checked out.
 		PublishingHelper.CheckOutFile(web, masterPage.File, folder.ServerRelativeUrl);

 // Use the FileCreationInformation class to upload the new file.
 		var fileInfo = new FileCreationInformation();
 		fileInfo.ContentStream = fileReadingStream;
 		fileInfo.Overwrite = true;
 		fileInfo.Url = masterPage.File;
 		File file = folder.Files.Add(fileInfo);

 // Get the list item associated with the newly uploaded master page file.
 		ListItem item = file.ListItemAllFields;
 		clientContext.Load(file.ListItemAllFields);
 		clientContext.Load(file,
 							f => f.CheckOutType,
 							f => f.Level,
 							f => f.ServerRelativeUrl);
 		clientContext.ExecuteQuery();

 item["ContentTypeId"] = masterPage.ContentTypeId;
 		item["UIVersion"] = Convert.ToString(15);
 		item["MasterPageDescription"] = "Master Page Uploaded using CSOM";
 		item.Update();
 		clientContext.ExecuteQuery();

 // If necessary, check in, publish, and approve the new master page file. 
 		PublishingHelper.CheckInPublishAndApproveFile(file);

 // On the current site, update the master page references to use the new master page. 
 		if (web.MasterUrl.EndsWith("/" + masterPage.Replaces))
 		{
 			web.MasterUrl = file.ServerRelativeUrl;
 		}
 		if (web.CustomMasterUrl.EndsWith("/" + masterPage.Replaces))
 		{
 			web.CustomMasterUrl = file.ServerRelativeUrl;
 		}
 		web.Update();
 		clientContext.ExecuteQuery();
 	}
 }

ページレイアウトのアップロードとページレイアウトへの参照の更新

注:

このセクションのコードサンプルは、この記事内で既に取り上げているコードサンプルに基づいて構築されています。

ファームソリューション内のモジュールを使用して展開されたページレイアウトを置き換えるには、次のようにして、新しいページレイアウトをアップロードし、そのレイアウトを使用するように参照を更新します。

Main メソッドを次のコードで更新します。このコードには、ページレイアウトファイルをアップロードして、そのファイルへの参照を更新するための追加手順が含まれています。

parentPageLayoutContentTypeId をページレイアウトのコンテンツタイプ ID に設定します。
マスターページギャラリーから parentPageLayoutContentTypeId と一致するコンテンツタイプを取得します。

UploadPageLayoutsAndUpdateReferences を呼び出します。

 			static void Main(string[] args)
 	{ 
 		string userName = GetUserName();
 		SecureString pwd = GetPassword();

 	// End program if no credentials were entered.
 		if (string.IsNullOrEmpty(userName) || (pwd == null))
 		return;

 		using (var clientContext = new ClientContext("http://sharepoint.contoso.com"))
 		{

 			clientContext.AuthenticationMode = ClientAuthenticationMode.Default;
 			clientContext.Credentials = new SharePointOnlineCredentials(userName, pwd);

 			XDocument settings = XDocument.Load("settings.xml");

 			// Get a reference to the Master Page Gallery, which will be used to upload new master pages. 

 			Web web = clientContext.Web;
 			List gallery = web.GetCatalog(116);
 			Folder folder = gallery.RootFolder;

 			// Load additional Master Page Gallery properties. 
 			clientContext.Load(folder);
 			clientContext.Load(gallery,
 								g => g.ContentTypes,
 								g => g.RootFolder.ServerRelativeUrl);

 			// Load the content types and master page information from the web.
 			clientContext.Load(web,
 								w => w.ContentTypes,
 								w => w.MasterUrl,
 								w => w.CustomMasterUrl);
 			clientContext.ExecuteQuery();

 			// Get the content type for the master page from the Master Page Gallery using the content type ID for masterpages (0x010105).
 			const string parentMasterPageContentTypeId = "0x010105";  
 			ContentType masterPageContentType = gallery.ContentTypes.FirstOrDefault(ct => ct.StringId.StartsWith(parentMasterPageContentTypeId));
 			UploadAndSetMasterPages(web, folder, clientContext, settings, masterPageContentType.StringId);

 		// Get the content type ID for the page layout, and then update references to the page layouts.
 		const string parentPageLayoutContentTypeId = "0x01010007FF3E057FA8AB4AA42FCB67B453FFC100E214EEE741181F4E9F7ACC43278EE811"; 
 		ContentType pageLayoutContentType = gallery.ContentTypes.FirstOrDefault(ct => ct.StringId.StartsWith(parentPageLayoutContentTypeId));
 		UploadPageLayoutsAndUpdateReferences(web, folder, clientContext, settings, pageLayoutContentType.StringId);
 		}

 	}

Program.cs で、UploadPageLayoutsAndUpdateReferences メソッドを追加します。このメソッドは、以下の手順を実行します。

ページレイアウト置換情報を読み込みます。その際、settings.xml から pagelayout 要素を読み取り、ページレイアウト置換情報を LayoutFile ビジネスオブジェクトに格納し、すべてのビジネスオブジェクトをリストに追加します。

置き換えるページレイアウトごとに、以下を行います。

サイトのコンテンツタイプに関するクエリを実行します。その際、 Web.ContentTypes を使用して、サイトのコンテンツタイプが、新しいページレイアウト用に settins.xml で指定された associatedContentTypeName と等しいコンテンツタイプを検出します。
UploadPageLayout を呼び出します。

UpdatePages を呼び出して、新しいページレイアウトを使用するように既存のページを更新します。

   		private static void UploadPageLayoutsAndUpdateReferences(Web web, Folder folder, ClientContext clientContext, XDocument settings, string contentTypeId)
   {
   	// Read the replacement settings stored in pageLayout elements in settings.xml.
   	IList<LayoutFile> pageLayouts = (from m in settings.Descendants("pageLayout")
   								select new LayoutFile
   								{
   									File = (string)m.Attribute("file"),
   									Replaces = (string)m.Attribute("replaces"),
   									Title = (string)m.Attribute("title"),
   									ContentTypeId = contentTypeId,
   									AssociatedContentTypeName = (string)m.Attribute("associatedContentTypeName"),
   									DefaultLayout = m.Attribute("defaultLayout") != null &amp;&amp; (bool)m.Attribute("defaultLayout")
   								}).ToList();
   // Update the content type association.
   			foreach (LayoutFile pageLayout in pageLayouts)
   	{
   		ContentType associatedContentType =
   			web.ContentTypes.FirstOrDefault(ct => ct.Name == pageLayout.AssociatedContentTypeName);
   		pageLayout.AssociatedContentTypeId = associatedContentType.StringId;                
   		UploadPageLayout(web, folder, clientContext, pageLayout);
   	}

   			UpdatePages(web, clientContext, pageLayouts);
   		}

Program.cs で、UploadPageLayout メソッドを追加します。このメソッドは、以下のタスクを実行します。

ページレイアウトファイルをチェックアウトします。
FileCreationInformation を使用して新しいファイルをアップロードします。
新たにアップロードされたファイルに関連付けられているリスト項目を取得します。
リスト項目に各種プロパティを設定します。これらのプロパティには、ContentTypeId や PublishingAssociatedContentType などが含まれます。
新しいページレイアウトファイルをチェックイン、発行、および承認します。
古いページレイアウトファイルに対する参照を削除するには、 PublishingHelper.UpdateAvailablePageLayouts を呼び出して、現在のサイトの PageLayouts プロパティに格納されている XML を更新します。

settings.xml で新たにアップロードされたページレイアウトファイルの defaultLayout 属性値が true に設定されている場合は、PublishingHelper.SetDefaultPageLayout を使用して、現在のサイトの DefaultPageLayout プロパティに格納されている XML を更新します。

 private static void UploadPageLayout(Web web, Folder folder, ClientContext clientContext, LayoutFile pageLayout)
 {
 	using (var fileReadingStream = System.IO.File.OpenRead(pageLayout.File))
 	{
 		PublishingHelper.CheckOutFile(web, pageLayout.File, folder.ServerRelativeUrl);
 		// Use FileCreationInformation to upload the new page layout file.
 		var fileInfo = new FileCreationInformation();
 		fileInfo.ContentStream = fileReadingStream;
 		fileInfo.Overwrite = true;
 		fileInfo.Url = pageLayout.File;
 		File file = folder.Files.Add(fileInfo);
 		// Get the list item associated with the newly uploaded file.
 		ListItem item = file.ListItemAllFields;
 		clientContext.Load(file.ListItemAllFields);
 		clientContext.Load(file,
 							f => f.CheckOutType,
 							f => f.Level,
 							f => f.ServerRelativeUrl);
 		clientContext.ExecuteQuery();

 item["ContentTypeId"] = pageLayout.ContentTypeId;
 		item["Title"] = pageLayout.Title;
 		item["PublishingAssociatedContentType"] = string.Format(";#{0};#{1};#", pageLayout.AssociatedContentTypeName, pageLayout.AssociatedContentTypeId);
 		item.Update();
 		clientContext.ExecuteQuery();

 PublishingHelper.CheckInPublishAndApproveFile(file);

 PublishingHelper.UpdateAvailablePageLayouts(web, clientContext, pageLayout, file);

 if (pageLayout.DefaultLayout)
 		{
 			PublishingHelper.SetDefaultPageLayout(web, clientContext, file);
 		}
 	}
 }

Program.cs で、UpdatePages メソッドを追加します。このメソッドは、以下のタスクを実行します。

Pages ライブラリを取得して、Pages ライブラリのすべてのリスト項目を取得します。

リスト項目ごとに、リスト項目の PublishingPageLayout フィールドを使用して、以前は settings.xml で指定されていたが、現在は pagelayouts に格納される、更新対象の一致するページレイアウトを検索します。リスト項目の PublishingPageLayout フィールドを、新しいページレイアウトを参照するように更新する必要がある場合:

PublishingHelper.CheckOutFile を使用して、リスト項目のファイルをチェックアウトします。
新しいページレイアウトファイルを参照するようにページレイアウトの URL を更新してから、リスト項目の PublishingPageLayout フィールドを更新します。

リスト項目が参照するファイルをチェックイン、発行、承認します。

   private static void UpdatePages(Web web, ClientContext clientContext, IList<LayoutFile> pageLayouts)
   {
   	// Get the Pages Library, and then get all the list items in it.
   	List pagesList = web.Lists.GetByTitle("Pages");
   	var allItemsQuery = CamlQuery.CreateAllItemsQuery();
   	ListItemCollection items = pagesList.GetItems(allItemsQuery);
   	clientContext.Load(items);
   	clientContext.ExecuteQuery();
   	foreach (ListItem item in items)
   	{
   		// Only update those pages that are using a page layout which is being replaced.
   		var pageLayout = item["PublishingPageLayout"] as FieldUrlValue;
   		if (pageLayout != null)
   		{
   			LayoutFile matchingLayout = pageLayouts.FirstOrDefault(p => pageLayout.Url.EndsWith("/" + p.Replaces));
   			if (matchingLayout != null)
   			{
   				// Check out the page so that we can update the page layout. 
   				PublishingHelper.CheckOutFile(web, item);

   // Update the pageLayout reference.
   				pageLayout.Url = pageLayout.Url.Replace(matchingLayout.Replaces, matchingLayout.File);
   				item["PublishingPageLayout"] = pageLayout;
   				item.Update();
   				File file = item.File;

   // Get the file and other attributes so that you can check in the file.
   				clientContext.Load(file,
   					f => f.Level,
   					f => f.CheckOutType);
   				clientContext.ExecuteQuery();

   				PublishingHelper.CheckInPublishAndApproveFile(file);
   			}
   		}
   	}
   }

次の方法で共有

ファームソリューション内のモジュールを使用して展開された SharePoint ファイルを置き換える

はじめに

サイトコレクションとサイトで発行機能を有効にする

サイトコレクションで SharePoint Server 発行インフラストラクチャ機能を有効にするには

サイトで SharePoint Server 発行機能を有効にするには

Visual Studio プロジェクトをセットアップする

マスターページのアップロードとマスターページへの参照の更新

ページレイアウトのアップロードとページレイアウトへの参照の更新

関連項目

その他のリソース

次の方法で共有

ファーム ソリューション内のモジュールを使用して展開された SharePoint ファイルを置き換える

はじめに

サイト コレクションとサイトで発行機能を有効にする

サイト コレクションで SharePoint Server 発行インフラストラクチャ機能を有効にするには

サイトで SharePoint Server 発行機能を有効にするには

Visual Studio プロジェクトをセットアップする

マスター ページのアップロードとマスター ページへの参照の更新

ページ レイアウトのアップロードとページ レイアウトへの参照の更新

関連項目

その他のリソース

ファームソリューション内のモジュールを使用して展開された SharePoint ファイルを置き換える

サイトコレクションとサイトで発行機能を有効にする

サイトコレクションで SharePoint Server 発行インフラストラクチャ機能を有効にするには

マスターページのアップロードとマスターページへの参照の更新

ページレイアウトのアップロードとページレイアウトへの参照の更新