フィールド型のプロパティ用のエディター コントロール
最終更新日: 2009年9月30日
適用対象: SharePoint Foundation 2010
あるフィールド型の可変プロパティ用のエディター コントロールを PropertySchema 要素 (フィールド型)の代わりに使用して、[サイト内の新しい列] ページ、[サイト内の列の変更] ページ、[列の作成] ページ、および [列の変更] ページにあるフィールドのプロパティをレンダリングできます。2 つのオプションの概要、およびどのような場合にそれぞれのオプションを使用するかについては、「ユーザー設定フィールド型のプロパティのレンダリング」を参照してください。
エディター コントロールの作成
エディター コントロールは、%ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE\ControlTemplates にある .ascx ファイル、および分離コード ファイルに定義され、この 2 つのファイルはユーザー設定フィールド クラスとして同じアセンブリにコンパイルされます。エディター コントロールは、フィールド プロパティのレンダリングのほか、対象となるプロパティを設定しようとする列の作成者を、複雑な計算ロジック、データ ソースの値の検索、カスタムのデータ検証などの特別な機能でサポートします。
メモ エディター コントロール クラスには、次の命名規則を使用して名前を付けることをお勧めします。
フィールド型名FieldEditor
たとえば、TargetDateFieldEditor、RegularExpressionFieldEditor のようにします。同様に, .ascx ファイルの名前も、フィールド型名FieldEditor.ascx となり、フィールド型名FieldEditor という分離コード クラスの名前を継承します。
IFieldEditor インターフェイス
フィールド エディター ユーザー コントロールとして機能するためには、分離コード クラスで以下の処理を行う必要があります。
UserControl クラス、またはその派生クラスから継承する。
IFieldEditor インターフェイスを実装する。
IFieldEditor インターフェイスには、以下のプロパティとメソッドが含まれます。それぞれの名前をクリックすると、実装方法が表示されます。
DisplayAsNewSection このプロパティを使用して、[サイト内の新しい列]、[サイト内の列の変更]、[列の作成]、および [ 列の変更] ページの [列の追加設定] セクションにコントロールを表示するか、または新しいセクションに単独で表示するかを指定します。
OnSaveChange このメソッドを使用して、列の作成者または編集者によるフィールド (列) プロパティへの変更を検証、保存します。
InitializeWithField このメソッドを使用して、フィールド (列) の既定値または現在のプロパティ値のどちらかでエディター コントロールを初期化します。