SharePoint ホスト型の SharePoint アドインにカスタム列を追加するAdd custom columns to a SharePoint-hosted SharePoint Add-in

これは、SharePoint ホスト型の SharePoint アドインの開発の基本に関する記事のシリーズの 3 番目です。SharePoint アドイン とこのシリーズの前の記事 (SharePoint ホスト型の SharePoint アドインの作成を始めるにある記事) をよく理解しておいてください。This is the third in a series of articles about the basics of developing SharePoint-hosted SharePoint Add-ins. You should first be familiar with SharePoint Add-ins and the previous articles in this series, which you can find at Get started creating SharePoint-hosted SharePoint Add-ins.


SharePoint ホスト型アドインに関するこのシリーズを続けて学習してきた方は、このトピックでも引き続き使用できる Visual Studio ソリューションをお持ちです。If you have been working through this series about SharePoint-hosted add-ins, you have a Visual Studio solution that you can use to continue with this topic. また、SharePoint_SP-hosted_Add-Ins_Tutorials でリポジトリをダウンロードし、BeforeColumns.sln ファイルを開くこともできます。You can also download the repository at SharePoint_SP-hosted_Add-Ins_Tutorials and open the BeforeColumns.sln file.

この記事では、新入社員オリエンテーション SharePoint アドインにいくつかのサイト列を追加することでコーディングに戻ります。In this article, we get back to coding by adding some site columns to the Employee Orientation SharePoint Add-in.

カスタムの列の種類を作成するCreate custom column types

  1. ソリューション エクスプローラーで、プロジェクトを右クリックして、[追加] > [新しいフォルダー] の順に選択します。In Solution Explorer, right-click the project and select Add > New Folder. フォルダーに「サイト列」という名前を付けます。Name the folder Site Columns.

  2. 新しいフォルダーを右クリックし、[追加] > [新しいアイテム] の順に選択します。Right-click the new folder, and select Add > New Item. [新しいアイテムの追加] ダイアログ ボックスが Office/SharePoint ノードに開きます。The Add New Item dialog opens to the Office/SharePoint node.

  3. [サイト列] を選択して「Division」という名前を付け、[追加] を選択します。Select Site Column, give it the name Division, and then select Add.

  4. 新しいサイト列の elements.xml ファイルで、以下の例に示す属性と値を持つよう Field 要素を編集します。ただし、Visual Studio が生成した値から ID 属性の GUID を変更しないでください。このため、コピーして貼り付けを使用するときは注意してくださいIn the elements.xml file for the new site column, edit the Field element so that it has the attributes and values shown in the following example, except that you should not change the GUID for the ID attribute from the value that Visual Studio generated for it, so be careful if you are using copy-and-paste.

      <Field ID="{generated GUID}" 
           Description="The division of the company where the employee works." 
           Group="Employee Orientation" 
           Required ="FALSE">

  5. 同じフォルダーに「OrientationStage」という名前の別のサイト列を追加します。Add another Site Column named OrientationStage to the same folder .

  6. 新しいサイト列に対する elements.xml ファイルで、次の例に示す属性と値が設定されるように Field 要素を編集します。ただし、ID 属性の GUID は、Visual Studio が生成した値から変更しないでください。In the elements.xml file for the new site column, edit the Field element so that it has the attributes and values shown in the following example, except that you should not change the GUID for the ID attribute from the value that Visual Studio generated for it.

      <Field ID="{generated GUID}" 
           DisplayName="Orientation Stage" 
           Group="Employee Orientation" 
           Description="The current orientation stage of the employee." 
           Required ="TRUE">

  7. これは選択肢フィールドなので、選択可能な項目とユーザーが選択するときにドロップダウン リストに表示する順序を指定する必要があります。Because this is a Choice field, you must specify the possible choices and the order in which they should appear in the drop-down list when a user is making a choice. これは必須フィールドなので、既定値を指定する必要があります。Because it is a required field, you must specify a default value. 次の子マークアップを Field 要素に追加し、すべてのファイルを保存します。Add the following child markup to the Field element, and then save all the files.

          <CHOICE>Not Started</CHOICE>
          <CHOICE>Tour of building</CHOICE>
          <CHOICE>HR paperwork</CHOICE>
          <CHOICE>Corporate network access</CHOICE>
          <MAPPING Value="1">Not Started</MAPPING>
          <MAPPING Value="2">Tour of building</MAPPING>
          <MAPPING Value="3">HR paperwork</MAPPING>
          <MAPPING Value="4">Corp network access</MAPPING>
          <MAPPING Value="5">Completed</MAPPING>
    <Default>Not Started</Default>

アドインを実行して列をテストするRun the add-in and test the columns

  1. F5 キーを使用して、アドインを展開して実行します。Visual Studio が、テスト用 SharePoint サイトにアドインを一時的にインストールして、すぐにアドインを実行します。Use the F5 key to deploy and run your add-in. Visual Studio makes a temporary installation of the add-in on your test SharePoint site and immediately runs the add-in.

  2. アドインの既定のページが開いたら、[シアトルの新入社員] リンクを選択してユーザー設定リストのインスタンスを開きます。When the add-in's default page opens, select the New Employees in Seattle link to open the custom list instance.

  3. リストの [設定] ページを開き、次の手順で 2 つの列を追加します。Open the list's Settings page and add the two columns to it with these steps:

    1. リストのすぐ上の吹き出しボタン (· · ·) をクリックして、[ビューの作成] を選択します。Select the callout button, · · · just above the list, and then select Create View.

    2. [ビューの種類] ページが開き、階層リスト構造の [設定] > [ビューの種類] が上部に表示されます。The View Type page opens, with the breadcrumb structure Settings > View Type near the top. 階層リストの [設定] をクリックします。Select the Settings breadcrumb.

      図 1. [リストの設定] ページを開く手順Figure 1. Steps to open the list settings page


    3. [設定] ページで、約半ページ下の左側にある [既存のサイト列から追加] リンクを開きます。On the Settings page, open the Add from existing site columns link on the left about halfway down the page.

      図 2. [リストの設定] ページFigure 2. List settings page

      強調表示されたサイト列から列の追加のためのリンクを含むリスト インスタンスの設定ページです。

    4. [サイト列から列を追加] ページで、[サイト列の選択元] ドロップダウン リストから [新入社員オリエンテーション] を選択します。On the Add Columns from Site Columns page, select Employee Orientation on the Select site columns from drop-down list.

      図 3. [サイト列から列を追加] ページFigure 3. Add Columns from Site Columns page

      サイトの選択列とラベル付けされているドロップ ダウンで新入社員オリエンテーションが選択された、SharePoint 列の選択コントロールです。

    5. [Division] 列と [OrientationStage] 列を [追加する列] ボックスに追加します。Add the Division and OrientationStage columns to the Columns to add box.

    6. [OK] を選択して [設定] ページに戻り、ページ上部の構造リストの [New Employees in Seattle] を選択します。Select OK to return to the Settings page, and then select the New Employees in Seattle breadcrumb near the top of the page.

  4. これで、新しい列がリストに追加されました。新しいアイテムをリストに追加します。編集フォームで、[オリエンテーションのステージ] フィールドには、既に既定値の「未開始」が入力されています。(既存のアイテムはフィールドがリストに追加される前に作成されているため、このフィールドでは空白になります。)The new columns are now on the list. Add a new item to the list. On the edit form, the Orientation Stage field will already have the default value Not Started. (The existing items will be blank in this field because they were created before the field was on the list.)

    図 4. 新しい列があるリストFigure 4. The list with new columns

    部門とオリエンテーション ステージの新しい列を含むリストです。

  5. デバッグ セッションを終了するには、ブラウザー ウィンドウを閉じるか、Visual Studio でデバッグを停止します。To end the debugging session, close the browser window or stop debugging in Visual Studio. F5 を選択するたびに、Visual Studio によって、以前のバージョンのアドインが取り消され、最新のバージョンがインストールされます。Each time that you select F5, Visual Studio will retract the previous version of the add-in and install the latest one.

  6. このアドインおよび他の記事の Visual Studio ソリューションを操作し、ひととおり操作を終了したら前回のアドインを取り消すとよいでしょう。You will work with this add-in and Visual Studio solution in other articles, and it's a good practice to retract the add-in one last time when you are done working with it for a while. ソリューション エクスプローラーでプロジェクトを右クリックして、[取り消し] を選択します。Right-click the project in Solution Explorer, and then select Retract.

次の手順Next steps

ユーザーがカスタム列をリストに手動で追加できないようにするために、このシリーズの次の記事では、カスタム列を含むカスタムのコンテンツ タイプを作成して、新しい従業員のリストのテンプレートに自動的に関連付けるようにします (「SharePoint ホスト型 SharePoint アドインにカスタム コンテンツ タイプを追加する」)。You don't really want your users to have to manually add the custom columns to the list, so in the next article in this series, you'll create a custom content type that includes the custom columns and is automatically associated with the New Employees list template: Add a custom content type to a SharePoint-hosted SharePoint Add-in.