Field 要素 (フィールド型)
適用対象: SharePoint 2016 |SharePoint Foundation 2013 |SharePoint Online |SharePoint Server 2013
フィールド型の特性を表します。
<Field Name="Text"></Field>
要素と属性
以下のセクションで、属性、子要素、親要素について説明します。
属性
| 属性 | 説明 |
|---|---|
| 名前 | 必須の Text。 Field 要素が表すフィールド型の、ある性質を表す名前文字列です。 値は、[ 解説] の下の表に一覧表示されている文字列のいずれかである必要があります。 |
子要素
None
親要素
注釈
FieldType 要素の Field 要素の子は、%ProgramFiles%\Common Files\Microsoft Shared\web サーバー拡張機能\15\TEMPLATE\XML の fldtypes*.xml ファイルで構成されます。
各 FieldType 要素には、Name 属性で識別される必須および省略可能な Field 要素がいくつかあります。 次の表では、これらの要素について説明します。 オブジェクト モデルでは、フィールド型は SPFieldTypeDefinition クラスによって表されます。 後者のクラスには、テーブルの 2 行を除くすべての行に対応する読み取り専用プロパティがあります (例外は InternalType と SQLType です)。 特に明記されていない場合を除き、プロパティ名は対応する Name 属性の値と一致します。
Field 要素の属性の Name 値 |
説明 |
|---|---|
| AllowBaseTypeRendering | 省略可能 なブール値。 既定値は FALSE です。 ユーザー設定フィールド型をどのようにレンダリングするかをクライアント アプリケーションが判断できない場合に、フィールドを基本型 (ParentType とも呼ばれます) としてレンダリングするかどうかを指定します。 TRUE に設定されていて、クライアント アプリケーションがユーザー設定フィールドの種類を適切にレンダリングできない場合、クライアント アプリケーションは、そのフィールドを継承元の既定の SharePoint Foundation 親フィールド型としてレンダリングします。 |
| CAMLRendering | 省略可能 なブール値。 既定値は FALSE です。 親 FieldType 要素内の RenderPattern 要素の CAML マークアップを使用して、リスト ビューにフィールドをレンダリングするかどうかを指定します。 既定の FALSE は、フィールドが fldtypes*.xsl ファイル内の XSL 変換によってリスト ビューにレンダリングされることを意味します。これは、リスト ビューでのフィールド レンダリングの標準システムです。 (ただし、この要素は、表示、新規作成、および編集フォームでのフィールド レンダリングには影響しません。 RenderPattern は、表示フォームでフィールドをレンダリングする標準的な方法です)。 |
| FieldTypeClass | 省略可能な文字列。ただし、すべてのユーザー設定フィールド型に必要です。 フィールド型クラス ライブラリの厳密な名前を表します。 FieldTypeClass には、 Version、 Culture、 PublicKeyToken を含むクラス名とアセンブリ名が含まれています。例えば：<Field Name="FieldTypeClass">CustomFieldTypes.RegularExpression.RegularExpressionField, CustomFieldTypes.RegularExpression, Version=1.0.0.0, Culture=neutral, PublicKeyToken=57e55365ec0ce80a</Field>SharePoint Foundation に組み込まれているフィールド型には、完全修飾クラス名のみが含まれます。 |
| FieldEditorUserControl | 文字列型 (String) の値を使用します。 [新しいサイト列] ページの [追加の列設定] セクションの SharePoint Foundation に表示されるコントロールを定義する、field_type FieldEditor.ascx ファイルへの相対パスを表します。 このコントロールにより、特定の列に対して、列クリエーターはフィールド型の変数プロパティを設定できます。 以下に例を示します。 "/_controltemplates/RegularExpressionFieldEditor.ascx".要素がない <Field Name="FieldEditorUserControl"> 場合、フィールド型の特殊なプロパティは PropertySchema 要素 (Field Types) 要素 によってレンダリングされます。FieldEditorUserControl は、ローカライズによっても値が変わらない、固定文字列である必要があります。 |
| フィルター処理可能 | 必須の Boolean。 このフィールド型をベースとする列が含まれるリストが、この型を使用する列の値に従ってフィルタ処理できるかどうかを表します。 TRUE であれば、列のヘッダーは、ユーザーがリストをフィルタ処理するのに使用できるコントロールになります。 |
| InternalType | 文字列型 (String) の値を使用します。 内部基本型を表します。 ユーザー設定フィールド型の定義で要素を使用 <Field Name="InternalType"> しないでください。 |
| ParentType | 必須の String (空の文字列にすることもできます)。 フィールド クラスが派生する型の名前を表します。 指定できる値は、Field 要素 (List) 要素の Type 属性に使用できる値とまったく同じです。 フィールド型が別の型から派生していない場合、値は空の文字列です。<Field Name="ParentType"> </Field>. ユーザー設定フィールド型では空にしないでください。 すべてのカスタム型は、別の型から継承します。SharePoint Foundation オブジェクト モデルでは、 ParentType は BaseRenderingTypeName と呼ばれます。 |
| ShowOnListAuthoringPages | 省略可能 なブール値。 既定値は TRUE です。 このフィールド型をリストに追加できるよう、画面に表示するかどうかを表します。 TRUE に設定されている場合、SharePoint Foundation はリスト作成ページにこのフィールドの種類を表示し、ユーザーがリストにフィールドの種類を含めることができます。 SharePoint Foundation オブジェクト モデルでは、 ShowOnListAuthoringPages は ShowOnListCreate と呼ばれます。 |
| ShowOnDocumentLibraryAuthoringPages | 省略可能 なブール値。 既定値は TRUE です。 このフィールド型をドキュメント ライブラリに追加できるよう、画面に表示するかどうかを表します。 TRUE に設定されている場合、SharePoint Foundation はドキュメント ライブラリ作成ページにこのフィールドの種類を表示し、ユーザーがドキュメント ライブラリにフィールドの種類を含めることができます。 SharePoint Foundation オブジェクト モデルでは、 ShowOnDocumentLibraryAuthoringPages は ShowOnDocumentLibraryCreate と呼ばれます。 |
| ShowOnSurveyAuthoringPages | 省略可能 なブール値。 既定値は TRUE です。 このフィールド型をアンケートに追加できるよう、画面に表示するかどうかを表します。 TRUE に設定されている場合、SharePoint Foundation では、ユーザーがアンケートにフィールドの種類を含めることができるように、このフィールドの種類がアンケート作成ページに表示されます。 SharePoint Foundation オブジェクト モデルでは、 ShowOnSurveyAuthoringPages は ShowOnSurveyCreate と呼ばれます。 |
| ShowOnColumnTemplateAuthoringPages | 省略可能 なブール値。 既定値は TRUE です。 このフィールド型を、列テンプレート フィールド型として表示するかどうかを表します。 TRUE に設定すると、SharePoint Foundation は列テンプレート作成ページにこのフィールドの種類を表示し、ユーザーがこのフィールド型の列テンプレートを作成することを選択できるようにします。 SharePoint Foundation オブジェクト モデルでは、 ShowOnColumnTemplateAuthoringPages は ShowOnColumnTemplateCreate と呼ばれます。 |
| SQLType | 文字列型 (String) の値を使用します。 コンテンツ データベースにデータを格納するために使用される SQL データ型を表します。 ユーザー設定フィールド型の定義で要素を使用 <Field Name="SQLType"> しないでください。 |
| 並べ替え可能か | 必須の Boolean。 このフィールド型をベースとする列が含まれるリストが、この型を使用する列で並べ替えることができるかどうかを表します。 TRUE であれば、列のヘッダーは、ユーザーがリストを並べ替えするのに使用できるコントロールになります。 |
| TypeDisplayName | 文字列 が必要です。 ユーザー インターフェイス (UI) のフィールド型の表示名を表します。 SharePoint Foundation では、[リストのカスタマイズ] ページ (listedit.aspx) の [種類] 列に表示されます。 後者が存在しない場合は 、TypeShortDescription の代わりにも使用されます。 TypeDisplayName はローカライズ可能な文字列にする必要があります。 |
| TypeName | 文字列 が必要です。 フィールド型の名前を表します。 これは、SharePoint サーバー ファームのすべてのフィールド型の名前で一意である必要があります。 TypeName は、固定の非ローカライズ可能な文字列である必要があります。 |
| TypeShortDescription | 文字列型 (String) の値を使用します。 UI に表示される、フィールド型の簡単な説明です。 SharePoint Foundation では、[新しいサイト列] ページと [列の作成] ページの [名前と種類] セクションと、[サイト列ギャラリー] の [種類] 列にラジオ ボタンが表示されます。 要素がない <Field Name="TypeShortDescription"> 場合は、 TypeDisplayName が使用されます。TypeShortDescription はローカライズ可能な文字列にする必要があります。 |
| UserCreatable | 省略可能 なブール値。 既定値は TRUE で、ユーザーはこのフィールド型のフィールドをリストに追加できます。 値を FALSE に設定すると、リスト スキーマでフィールド型を使用できますが、[新しいサイトの列] ページと [列の作成] ページの [名前と種類] セクションではフィールドの種類がユーザーに表示されなくなります。 |
例
ユーザー設定フィールド型を定義する例を示します。
重要
RenderPattern は廃止されました。 ここでは、以前のバージョンの SharePoint Foundation に対して最初に開発されたカスタム フィールドのデバッグを支援するためだけに示されています。
<FieldType>
<Field Name="TypeName">SocialSecurityNumber</Field>
<Field Name="ParentType">Text</Field>
<Field Name="TypeDisplayName">Social Security Number</Field>
<Field Name="TypeShortDescription">Social Security Number (123456789, 123-45-6789)</Field>
<Field Name="AllowBaseTypeRendering">TRUE</Field>
<Field Name="FieldTypeClass">
AdventureWorks.FieldTypes.SPFieldSSN, AdventureWorks.FieldTypes.SPFieldSSN,
Version=1.0.0.0,Culture=neutral,PublicKeyToken=90734cc53324b79c
</Field>
<RenderPattern Name="DisplayPattern">
<Column HTMLEncode="TRUE" />
<Column HTMLEncode="TRUE" UseRelatedField="TRUE"/>
</RenderPattern>
</FieldType>