ファームソリューションでの SharePoint コンテンツタイプとサイト列の置換

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

この記事では、SharePoint クライアント側オブジェクトモデル (CSOM) を使用して、コンテンツタイプとサイト列を置換し、新しいコンテンツタイプにサイト列を追加してから、従来のコンテンツタイプを新しいコンテンツタイプに置換するときに使用する変換プロセスについて説明します。

重要

ファームソリューションは、SharePoint Online に移行できません。この記事に記載されている手法やコードを適用することにより、更新されたコンテンツタイプとサイト列を使用して、同様の機能をファームソリューションまたは宣言型サンドボックスソリューションに提供する新しいソリューションを構築できます。構築した新しいソリューションは、SharePoint Online に展開できます。

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

注:

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

CSOM を使用して、コンテンツタイプとサイト列を置換するには、次のようにします。

新しいコンテンツタイプを作成します。
新しいサイト列 (フィールドとも呼ばれる) を作成します。
新しいサイト列を新しいコンテンツタイプに追加します。
古いコンテンツタイプの参照を新しいコンテンツタイプに置換します。

次のコードで、Main は CSOM を使用してコンテンツタイプとサイト列を置換するために実行する操作の順序を示しています。

static void Main(string[] args)
{
    using (var clientContext = new ClientContext("http://contoso.sharepoint.com"))
    {

        Web web = clientContext.Web;
        
        CreateContentType(clientContext, web);
        CreateSiteColumn(clientContext, web);
        AddSiteColumnToContentType(clientContext, web);

        // Replace the old content type with the new content type.
        ReplaceContentType(clientContext, web);
    }

}

次のコードで、GetContentTypeByName は、現在のサイトから以下のようにしてコンテンツタイプを取得します。

Web.ContentTypes プロパティを使用して ContentTypeCollection (現在のサイトにおけるコンテンツタイプのコレクション) を取得します。
サイトからコンテンツタイプを検索して返します。その場合、サイトのコンテンツタイプ名を既存のコンテンツタイプ名と突き合わせます。コンテンツタイプ名は name パラメーターで送信されます。

    private static ContentType GetContentTypeByName(ClientContext cc, Web web, string name)
    {
        ContentTypeCollection contentTypes = web.ContentTypes;
        cc.Load(contentTypes);
        cc.ExecuteQuery();
        return contentTypes.FirstOrDefault(o => o.Name == name);
    }

新しいコンテンツタイプを作成する

次のコードで、CreateContentType は、次のようにして新しいコンテンツタイプを作成します。

コンテンツタイプの名前を格納するための contentTypeName という名前の定数を作成します。新しいコンテンツタイプの名前は、以前のコンテンツタイプの名前に設定されます。
GetContentTypeByName を呼び出して、サイト上で一致するコンテンツタイプを検索します。
コンテンツタイプが既に存在する場合は、必要な操作はなく、return が呼び出されたときに制御が Main に戻されます。

コンテンツタイプが存在しない場合は、newCt という名前の ContentTypeCreationInformation オブジェクトを使用して、コンテンツタイプのプロパティが設定されます。

基本ドキュメントコンテンツタイプ ID 0x0101 を使用して、新しいコンテンツタイプ ID が newCt.Id に割り当てられます。詳細については、「コンテンツタイプの基本的な階層」を参照してください。
ContentTypeCollection.Add を使用して、新しいコンテンツタイプを追加します。

private static void CreateContentType(ClientContext cc, Web web)
{
    // The new content type will be created using this name.
    const string contentTypeName = "ContosoDocumentByCSOM";

    // Determine whether the content type already exists.
    var contentType = GetContentTypeByName(cc, web, contentTypeName);

    // The content type exists already. No further action required.
    if (contentType != null) return;

    // Create the content type using the ContentTypeInformation object.
    ContentTypeCreationInformation newCt = new ContentTypeCreationInformation();
    newCt.Name = "ContosoDocumentByCSOM";

    // Create the new content type based on the out-of-the-box document (0x0101) and assign the ID to the new content type.
    newCt.Id = "0x0101009189AB5D3D2647B580F011DA2F356FB2";

    // Assign the content type to a specific content type group.
    newCt.Group = "Contoso Content Types";

    ContentType myContentType = web.ContentTypes.Add(newCt);
    cc.ExecuteQuery();
}

新しいサイト列を作成する

次のコードで、CreateSiteColumn は、以下のようにして、新しいサイト列を作成します。

フィールドの名前を格納するための fieldName という名前の定数を作成します。新しいフィールドの名前は、以前のフィールドの名前に設定されます。
Web.Fields プロパティを使用して、サイト上に定義されているサイト列を取得します。
サイト上のフィールド名を fieldName と照合することにより、サイト上で一致するフィールドを検索します。フィールドが既に存在する場合は、必要な操作はなく、return が呼び出されたときに制御が Main に戻されます。フィールドが存在しない場合は、フィールドスキーマを指定する CAML 文字列が FieldAsXML に割り当てられてから、FieldCollection.AddFieldAsXml を使用してフィールドが作成されます。

private static void CreateSiteColumn(ClientContext cc, Web web)
{
    // The new field will be created using this name.
    const string fieldName = "ContosoStringCSOM";

    // Load the list of fields on the site.
    FieldCollection fields = web.Fields;
    cc.Load(fields);
    cc.ExecuteQuery();

    // Check fields on the site for a match.
    var fieldExists = fields.Any(f => f.InternalName == fieldName);

     // The field exists already. No further action required.    
    if (fieldExists) return;

    // Field does not exist, so create the new field.
    string FieldAsXML = @"<Field ID='{CB8E24F6-E1EE-4482-877B-19A51B4BE319}' 
                                Name='" + fieldName + @"' 
                                DisplayName='Contoso String by CSOM' 
                                Type='Text' 
                                Hidden='False' 
                                Group='Contoso Site Columns' 
                                Description='Contoso Text Field' />";
    Field fld = fields.AddFieldAsXml(FieldAsXML, true, AddFieldOptions.DefaultValue);
    cc.ExecuteQuery();
}

新しいサイト列を新しいコンテンツタイプに追加する

次のコードで、AddSiteColumnToContentType は、コンテンツタイプとフィールド間の接続を以下のようにして作成します。

コンテンツタイプを読み込み、そのコンテンツタイプを ContentType.FieldLinks プロパティを使用してフィールドが参照します。
フィールドを読み込みます。
contentType.FieldLinks.Any(f => f.Name == fieldName) を使用して、コンテンツタイプがフィールドを参照しているかどうかを判断します。
コンテンツタイプが対象フィールドを既に参照している場合、追加アクションは不要で、 return が呼び出されると制御が Main に戻ります。コンテンツタイプが対象フィールドを参照していない場合には、フィールド参照プロパティは FieldLinkCreationInformation オブジェクトで設定されます。
FieldLinkCreationInformation オブジェクトを ContentType.FieldLinks プロパティに追加します。

private static void AddSiteColumnToContentType(ClientContext cc, Web web)
{
    // The name of the content type. 
    const string contentTypeName = "ContosoDocumentByCSOM";
    // The field name.
    const string fieldName = "ContosoStringCSOM";

    // Load the content type.
    var contentType = GetContentTypeByName(cc, web, contentTypeName);
    if (contentType == null) return; // content type was not found

    // Load field references in the content type.
    cc.Load(contentType.FieldLinks);
    cc.ExecuteQuery();

    // Load the new field.
    Field fld = web.Fields.GetByInternalNameOrTitle(fieldName);
    cc.Load(fld);
    cc.ExecuteQuery();

    // Determine whether the content type refers to the field.
    var hasFieldConnected = contentType.FieldLinks.Any(f => f.Name == fieldName);

    // A reference exists already, no further action is required.
    if (hasFieldConnected) return;

    // The reference does not exist, so we have to create the reference.
    FieldLinkCreationInformation link = new FieldLinkCreationInformation();
    link.Field = fld;
    contentType.FieldLinks.Add(link);
    contentType.Update(true);
    cc.ExecuteQuery();
}

古いコンテンツタイプの参照を新しいコンテンツタイプに置換する

次のコードで、ReplaceContentType は、すべてのライブラリにある項目すべてで古いコンテンツタイプを参照するコンテンツを検査し、こうした参照を新しいコンテンツタイプ (ContosoDocumentByCSOM) に以下のようにして置換します。

古いコンテンツタイプ ID を定数に割り当てます。
GetContentTypeByName を使用して、新しいコンテンツタイプを取得します。
Web.Lists を使用して、サイト上のすべてのリストを取得します。
cc.Load(lists, l => l.Include(list => list) を使用して、サイト上のすべてのリストと各リストのすべてのコンテンツタイプを読み込みます。ContentTypes)。
返されたリストごとに、リストを使用して、リストのコンテンツタイプを検索して、コンテンツタイプと古いコンテンツタイプ ID を一致 させます。ContentTypes.Any(c => c.StringId.StartsWith(oldContentTypeId)))。一致項目が見つかると、古いコンテンツタイプが含まれるリストが listsWithContentType に追加されます。
listsWithContentType の各リストについて、以下を行います。
新しいコンテンツタイプがリストに追加されているかどうかを判別します。その新しいコンテンツタイプがリストに追加されていない場合、 ContentTypeCollection.AddExistingContentType を使用して、対象の新しいコンテンツタイプをリストに追加します。
リストのすべての項目を取得します。
それぞれのリスト項目に関して、リスト項目のコンテンツタイプ ID を取得します。リスト項目のコンテンツタイプ ID が古いコンテンツタイプ ID と等しいかどうかを判別します。対象コンテンツタイプ ID が等しくない場合、次のリスト項目にスキップます。対象コンテンツタイプ ID が等しい場合、 ContentType.StringId を使用して、その新しいコンテンツタイプ ID をリスト項目に割り当てます。

注:

古いコンテンツタイプはリストにあるものの、既に使用されていません。これで、古いコンテンツタイプをリストから削除してから、取り消すことできます。この記事では、ドキュメントコンテンツタイプを置換する方法のみについて説明します。ページレイアウトでコンテンツタイプを置換する場合は、サイトコレクションの各ページレイアウトで AssociatedContentType プロパティを必ず更新してください。

private static void ReplaceContentType(ClientContext cc, Web web)
{
    // The old content type. 
    const string oldContentTypeId = "0x010100C32DDAB6381C44868DCD5ADC4A5307D6";
    // The new content type name.
    const string newContentTypeName = "ContosoDocumentByCSOM";

    // Get the new content type and lists on the site.
    ContentType newContentType = GetContentTypeByName(cc, web, newContentTypeName);
    ListCollection lists = web.Lists;
    
    // Load the new content type and the content types on all lists on the site. 
    cc.Load(newContentType);
    cc.Load(lists,
            l => l.Include(list => list.ContentTypes));
    cc.ExecuteQuery();
    var listsWithContentType = new List<List>();
    foreach (List list in lists)
    {
        bool hasOldContentType = list.ContentTypes.Any(c => c.StringId.StartsWith(oldContentTypeId));
        if (hasOldContentType)
        {
            listsWithContentType.Add(list);
        }
    }
    foreach (List list in listsWithContentType)
    {
        // Determine whether the new content type is already attached to the list.
        var listHasContentTypeAttached = list.ContentTypes.Any(c => c.Name == newContentTypeName);
        if (!listHasContentTypeAttached)
        {
            // Attach content type to list.
            list.ContentTypes.AddExistingContentType(newContentType);
            cc.ExecuteQuery();
        }
        // Get all list items.
        CamlQuery query = CamlQuery.CreateAllItemsQuery();
        ListItemCollection items = list.GetItems(query);
        cc.Load(items);
        cc.ExecuteQuery();

        // For each list item, determine whether the old content type is used, and then update to the new content type. 
        foreach (ListItem listItem in items)
        {
            // Get the current content type for this list item.
            var currentContentTypeId = listItem["ContentTypeId"] + "";
            var isOldContentTypeAssigned = currentContentTypeId.StartsWith(oldContentTypeId);

            // This item does not use the old content type - skip to next list item.
            if (!isOldContentTypeAssigned) continue;

            // Update the list item content type to the new content type.
            listItem["ContentTypeId"] = newContentType.StringId; // new content type Id;
            listItem.Update();
        }
        // Save all changes.
        cc.ExecuteQuery();
    }
}

次の方法で共有

ファームソリューションでの SharePoint コンテンツタイプとサイト列の置換

新しいコンテンツタイプを作成する

新しいサイト列を作成する

新しいサイト列を新しいコンテンツタイプに追加する

古いコンテンツタイプの参照を新しいコンテンツタイプに置換する

関連項目

その他のリソース

次の方法で共有

ファーム ソリューションでの SharePoint コンテンツ タイプとサイト列の置換

新しいコンテンツ タイプを作成する

新しいサイト列を作成する

新しいサイト列を新しいコンテンツ タイプに追加する

古いコンテンツ タイプの参照を新しいコンテンツ タイプに置換する

関連項目

その他のリソース

ファームソリューションでの SharePoint コンテンツタイプとサイト列の置換

新しいコンテンツタイプを作成する

新しいサイト列を新しいコンテンツタイプに追加する

古いコンテンツタイプの参照を新しいコンテンツタイプに置換する