フォームのカスタムコントロールを作成する

[アーティクル]
06/15/2015

リストアイテムフォームをカスタマイズするには、既定の Windows SharePoint Services サーバーコントロールを拡張して独自のカスタムコントロールを定義してから、カスタムコントロールを参照するカスタムテンプレートで既存の既定のフォームテンプレートをオーバーライドします。カスタムクラスを定義するクラスライブラリを作成し、プロジェクトの DLL をグローバルアセンブリキャッシュ (GAC) にコピーしてから、DLL を参照するカスタムコントロールテンプレート定義を含む .ascx ファイルをローカルドライブ:\\Program Files\Common Files\Microsoft Shared\web server extensions\12\TEMPLATE\CONTROLTEMPLATES に追加できます。

ListFieldIterator コントロール

Microsoft.SharePoint.WebControls.ListFieldIterator コントロールは、フォーム内に表示するためにアイテムフィールドを列挙するために使用されます。このコントロールは、\CONTROLTEMPLATES\DefaultTemplates.ascx に定義されている一連のネストしたコントロールテンプレートを通じてリストアイテムフォームに挿入されます。DocumentLibraryForm テンプレートはフォームのツールバーコントロールとリンクをレイアウトしますが、このテンプレートは、DocumentLibraryFields コントロールを挿入する DocumentLibraryFormCore テンプレートも挿入します。DocumentLibraryFields コントロールの既定のテンプレートは FileFormFields です。これは、ListFieldIterator を挿入する DefaultTemplates.ascx で定義されたコントロールです。

例

次の例では、ListFieldIterator クラスを拡張するカスタムリストフィールド反復子コントロールを定義し、その IsFieldExcluded メソッドをオーバーライドします。例では、ユーザーがサイト管理者でない限り、特定のグループのメンバであるユーザーに対してドキュメントライブラリフォームの特定のフィールドが表示されないようにします。

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SharePoint
Imports Microsoft.SharePoint.WebControls

Namespace CustomOverrideControls

   Public Class CustomListFieldIterator
      Inherits ListFieldIterator
      
      Protected Overrides Function IsFieldExcluded(field As SPField) As Boolean
         Dim site As SPWeb = SPContext.Current.Web
         Dim groupId As Integer = site.Groups("ExcludeGroup").ID
         
         If site.IsCurrentUserMemberOfGroup(groupId) AndAlso field.Title = "MySpecialColumn" AndAlso site.CurrentUser.IsSiteAdmin = False Then
            Return True
         End If
         Return MyBase.IsFieldExcluded(field)
      End Function 'IsFieldExcluded
   End Class 'CustomListFieldIterator
End Namespace 'CustomOverrideControls

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SharePoint;
using Microsoft.SharePoint.WebControls;

namespace CustomOverrideControls
{
   public class CustomListFieldIterator : ListFieldIterator
   {
      protected override bool IsFieldExcluded(SPField field)
      {
         SPWeb site = SPContext.Current.Web;
         int groupId = site.Groups["ExcludeGroup"].ID;

         if (site.IsCurrentUserMemberOfGroup(groupId) && field.Title == "MySpecialColumn" && site.CurrentUser.IsSiteAdmin == false)
         {
            return true;
         }
         return base.IsFieldExcluded(field);
      }
   }
}

リストフィールド反復子を拡張するカスタムコントロールを作成するには

Microsoft Visual Studio 2005 で、[ファイル] をクリックし、[新規作成] をポイントしてから [プロジェクト] をクリックします。
[新しいプロジェクト] ダイアログボックスの [プロジェクトの種類] ボックスでプロジェクトの言語を選択し、[テンプレート] ボックスで [ クラスライブラリ] を選択してプロジェクトを構築するための名前と場所を入力し、[OK] をクリックします。
Microsoft.SharePoint アセンブリへの参照を追加するには、ソリューションエクスプローラでプロジェクトを右クリックし、[参照の追加] ダイアログボックスの [.NET] タブで [Windows SharePoint Services] を選択し、[OK] をクリックします。
プロジェクトの作成時にカスタムアセンブリに厳密な名前を付けるには、ソリューションエクスプローラで [プロパティ] を右クリックし、[署名]、[アセンブリの署名] の順に選択して、厳密な名前のキーファイル名を指定します。
ソリューションエクスプローラでプロジェクトの .cs または .vb ファイルをダブルクリックし、前の例のようなコードを追加して、Windows SharePoint Services コントロールを拡張するカスタムコントロールのクラスを定義します。
Ctrl + Shift + B キーを押してソリューションをビルドします。
Windows エクスプローラで、プロジェクトフォルダから GAC に DLL をドラッグします。

カスタムフォームコントロールを実装するには、既定のテンプレートをオーバーライドするコントロールテンプレートを含む .ascx ファイルを作成して、フォームページにカスタムコントロールを挿入する必要があります。

例

次の例では、フォームに対して 3 つのネストしたカスタムテンプレートを定義します。最初のテンプレートは、DocumentLibraryForm テンプレートをオーバーライドして 2 番目のテンプレート CustomDocumentLibraryFormCore への参照を作成します。2 番目のテンプレートは、3 番目のテンプレート CustomFileFormFields を DocumentLibraryFields コントロールの定義テンプレートとして指定します。3 番目のテンプレートは、前の例のようにクラスライブラリに定義できるカスタムリストフィールド反復子を挿入します。

<SharePoint:RenderingTemplate ID="DocumentLibraryForm" runat="server">
  <Template>
    <SharePoint:InformationBar runat="server"/>
    <wssuc:ToolBar CssClass="ms-formtoolbar" id="toolBarTbltop" RightButtonSeparator="&nbsp;" runat="server">
      <Template_RightButtons>
        <SharePoint:SaveButton TabIndex=1 runat="server"/>
        <SharePoint:GoBackButton runat="server"/>
      </Template_RightButtons>
    </wssuc:ToolBar>
    <SharePoint:FormToolBar runat="server"/>
    <SharePoint:FormComponent TemplateName="CustomDocumentLibraryFormCore" runat="server"/>
  </Template>
</SharePoint:RenderingTemplate>

<SharePoint:RenderingTemplate ID="CustomDocumentLibraryFormCore" runat="server">
  <Template>
    <TABLE class="ms-formtable" style="margin-top: 8px;" border=0 cellpadding=0 id="formTbl" cellspacing=0 width=100%>
      <SharePoint:ChangeContentType runat="server"/>
      <SharePoint:DocumentLibraryFields TemplateName="CustomFileFormFields" runat="server"/>
      <SharePoint:ApprovalStatus runat="server"/>
    </TABLE>


    <SharePoint:WebPartPageMaintenanceMessage runat="server"/>
    <SharePoint:DocumentTransformersInfo runat="server"/>
    <table cellpadding=0 cellspacing=0 width=100%><tr><td class="ms-formline">
      <IMG SRC="/_layouts/images/blank.gif" width=1 height=1 alt="">   
    </td></tr></table>
    <TABLE cellpadding=0 cellspacing=0 width=100% style="padding-top: 7px">
    <tr><td width=100%>
    <SharePoint:ItemHiddenVersion runat="server"/>
    <SharePoint:InitContentType runat="server"/>
    <wssuc:ToolBar CssClass="ms-formtoolbar" id="toolBarTbl" RightButtonSeparator="&nbsp;" runat="server">
      <Template_Buttons>
        <SharePoint:CreatedModifiedInfo runat="server"/>
      </Template_Buttons>
      <Template_RightButtons>
        <SharePoint:SaveButton runat="server"/>
        <SharePoint:GoBackButton runat="server"/>
      </Template_RightButtons>
    </wssuc:ToolBar>
    </td></tr></TABLE>
  </Template>
</SharePoint:RenderingTemplate>

<SharePoint:RenderingTemplate ID="CustomFileFormFields" runat="server">
  <Template>
    <CustomOverrideControls:CustomListFieldIterator runat="server"/>
  </Template>
</SharePoint:RenderingTemplate>

ドキュメントライブラリのカスタムコントロールテンプレートファイルを作成するには

テキストエディタで、必要なディレクティブを含む .ascx ファイルを \12\TEMPLATE\CONTROLTEMPLATES に作成します。前の例では、カスタムコントロールのアセンブリと名前空間を登録するために次のようなディレクティブが必要です。

<%@ Control Language="C#"   %>
<%@Assembly Name="Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
<%@Register TagPrefix="SharePoint" Assembly="Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" namespace="Microsoft.SharePoint.WebControls"%>
<%@ Register TagPrefix="wssuc" TagName="ToolBar" src="/_controltemplates/ToolBar.ascx" %>
<%@ Register TagPrefix="wssuc" TagName="ToolBarButton" src="/_controltemplates/ToolBarButton.ascx" %>
<%@Assembly Name="CustomOverrideControls, Version=1.0.0.0, Culture=neutral, PublicKeyToken=b23bfc50a92c9e0d" %>
<%@Register TagPrefix="CustomOverrideControls" Assembly="CustomOverrideControls, Version=1.0.0.0, Culture=neutral, PublicKeyToken=b23bfc50a92c9e0d" namespace="CustomOverrideControls"%>

前の例のような、特定の既定のコントロールテンプレートをオーバーライドするテンプレート定義を .ascx ファイルに追加します。
変更を有効にするために、Internet Information Services (IIS) をリセットします。
前の例をテストするには、ユーザーインターフェイスを使用してタイトルが "z" で始まるフィールドを作成し、ドキュメントライブラリ内のアイテムのフォームに移動して変更を確認します。

フォームのカスタムコントロールを作成する

ListFieldIterator コントロール

例

リストフィールド反復子を拡張するカスタムコントロールを作成するには

例

ドキュメントライブラリのカスタムコントロールテンプレートファイルを作成するには

その他のリソース

その他のリソース

フォームのカスタム コントロールを作成する

ListFieldIterator コントロール

例

リスト フィールド反復子を拡張するカスタム コントロールを作成するには

例

ドキュメント ライブラリのカスタム コントロール テンプレート ファイルを作成するには

その他のリソース

その他のリソース

フォームのカスタムコントロールを作成する

リストフィールド反復子を拡張するカスタムコントロールを作成するには

ドキュメントライブラリのカスタムコントロールテンプレートファイルを作成するには