Field 要素 (フィールド型)
最終更新日: 2015年3月9日
適用対象: SharePoint Foundation 2010
この記事の内容
属性
子要素
親要素
フィールド型の特性を表します。
<Field
Name="Text">
</Field>
属性
属性 |
説明 |
|---|---|
Name |
必須の Text。Field 要素が表すフィールド型の、ある性質を表す名前文字列です。値は、下表に示されている文字列のいずれかである必要があります。 |
子要素
なし |
親要素
コメント
FieldType 要素の子要素である Field 要素は、%ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE\XML 内の fldtypes*.xml ファイルに構成されます。
各 FieldType 要素には必須およびオプションの Field 要素がいくつかあり、その Name 属性によって識別されます。この要素を次の表に示します。 オブジェクト モデルでは、フィールド型は、SPFieldTypeDefinition クラスによって表されます。後者のクラスには、表のうち 2 行を除くすべてに対応する、読み取り専用のプロパティがあります (例外は、InternalType と SQLType です)。特に指定のない限り、プロパティ名は対応する Name 属性の値に一致します。
Field 要素の Name 属性の値 |
説明 |
|---|---|
AllowBaseTypeRendering |
オプションの Boolean。既定は FALSE です。ユーザー設定フィールド型をどのようにレンダリングするかをクライアント アプリケーションが判断できない場合に、フィールドを基本型 (ParentType とも呼ばれます) としてレンダリングするかどうかを指定します。TRUE に設定され、クライアント アプリケーションがユーザー設定フィールド型を適切にレンダリングできない場合、クライアント アプリケーションは、フィールドを既定の SharePoint Foundation 親 (継承元) フィールド型としてレンダリングします。 |
CAMLRendering |
オプションの Boolean。既定は FALSE です。親 FieldType 要素内の RenderPattern 要素の CAML マークアップを使用して、リスト ビューでフィールドをレンダリングするかどうかを指定します。既定の FALSE は、fldtypes*.xsl ファイルの XSL 変換によってリスト ビューでフィールドがレンダリングされることを意味します (ただし、この要素は、表示、新規作成、および編集フォームのフィールドのレンダリングには影響しません。RenderPattern は、表示フォームのフィールドをレンダリングする標準のレンダリング方法として引き続き使用されます)。 |
FieldTypeClass |
オプションの String。ただし、すべてのユーザー設定フィールド型で必要とされます。フィールド型クラス ライブラリの厳密な名前を表します。"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 での [サイト内の新しい列] ページの [列の追加設定] セクションに表示されるコントロールを定義する、フィールド型FieldEditor.ascx ファイルへの相対パスを表します。このコントロールにより、特定の列に対して、列クリエーターはフィールド型の変数プロパティを設定できます。たとえば、"/_controltemplates/RegularExpressionFieldEditor.ascx" です。<Field Name="FieldEditorUserControl"> 要素がない場合、フィールド型の特別なプロパティが PropertySchema 要素 (フィールド型) 要素によってレンダリングされます。 FieldEditorUserControl は、ローカライズによっても値が変わらない、固定文字列である必要があります。 |
Filterable |
必須の Boolean。このフィールド型をベースとする列が含まれるリストが、この型を使用する列の値に従ってフィルタ処理できるかどうかを表します。TRUE であれば、列のヘッダーは、ユーザーがリストをフィルタ処理するのに使用できるコントロールになります。 |
InternalType |
オプションの String。内部の基本型を表します。ユーザー設定フィールド型の定義に <Field Name="InternalType"> 要素を使用しないでください。 |
ParentType |
必須の String (空の文字列にすることもできます)。フィールド クラスが派生する型の名前を表します。設定可能な値は、Field 要素 (リスト) 要素の Type 属性と完全に同じです。フィールド型が別の型からの派生ではない場合、値は空の文字列です。 <Field Name="ParentType"></Field>。ユーザー設定フィールド型では、空にしないでください。すべてのユーザー設定型が別の型から継承されます。 SharePoint Foundation オブジェクト モデルでは、ParentType は BaseRenderingTypeName と呼ばれます。 |
ShowOnListAuthoringPages |
オプションの Boolean。既定は TRUE です。このフィールド型をリストに追加できるよう、画面に表示するかどうかを表します。TRUE であれば、SharePoint Foundation はこのフィールド型をリスト作成ページに表示して、ユーザーが自分で作ったリストに追加できるようにします。 SharePoint Foundation オブジェクト モデルでは、ShowOnListAuthoringPages は ShowOnListCreate と呼ばれます。 |
ShowOnDocumentLibraryAuthoringPages |
オプションの Boolean。既定は TRUE です。このフィールド型をドキュメント ライブラリに追加できるよう、画面に表示するかどうかを表します。TRUE であれば、SharePoint Foundation はこのフィールド型をドキュメント ライブラリ作成ページに表示して、ユーザーが自分で作ったドキュメント ライブラリに追加できるようにします。 SharePoint Foundation オブジェクト モデルでは、ShowOnDocumentLibraryAuthoringPages は ShowOnDocumentLibraryCreate と呼ばれます。 |
ShowOnSurveyAuthoringPages |
オプションの Boolean。既定は TRUE です。このフィールド型をアンケートに追加できるよう、画面に表示するかどうかを表します。TRUE であれば、SharePoint Foundation はこのフィールド型をアンケート作成ページに表示して、ユーザーが自分で作ったアンケートに追加できるようにします。 SharePoint Foundation オブジェクト モデルでは、ShowOnSurveyAuthoringPages は ShowOnSurveyCreate と呼ばれます。 |
ShowOnColumnTemplateAuthoringPages |
オプションの Boolean。既定は TRUE です。このフィールド型を、列テンプレート フィールド型として表示するかどうかを表します。TRUE であれば、SharePoint Foundation はこのフィールド型を列テンプレート作成ページに表示して、ユーザーがこのフィールド型の列テンプレートを作成できるようにします。 SharePoint Foundation オブジェクト モデルでは、ShowOnColumnTemplateAuthoringPages は ShowOnColumnTemplateCreate と呼ばれます。 |
SQLType |
オプションの String。コンテンツ データベースにデータを格納するときに使用される SQL データ型を表します。ユーザー設定フィールド型の定義に <Field Name="SQLType"> 要素を使用しないでください。 |
Sortable |
必須の Boolean。このフィールド型をベースとする列が含まれるリストが、この型を使用する列で並べ替えることができるかどうかを表します。TRUE であれば、列のヘッダーは、ユーザーがリストを並べ替えするのに使用できるコントロールになります。 |
TypeDisplayName |
必須の String。ユーザー インターフェイス (UI) のフィールド型の表示名を表します。SharePoint Foundation では、[カスタマイズ] [リスト] ページ (listedit.aspx) の [種類] 列に表示されます。"TypeShortDescription" の代わりにも使用されます (後者が存在しない場合)。 "TypeDisplayName" はローカライズが可能な文字列でなければなりません。 |
TypeName |
必須の String。フィールド型の名前を表します。これは、SharePoint サーバー ファームのすべてのフィールド型の名前で一意である必要があります。 "TypeName" は、ローカライズによっても値が変わらない、固定文字列である必要があります。 |
TypeShortDescription |
オプションの String。UI に表示される、フィールド型の簡単な説明です。SharePoint Foundation では、[サイト内の新しい列] ページおよび [列の作成] ページの [名前と種類 ] セクションと [サイト内の列ギャラリー] の [種類] 列のラジオ ボタンと共に表示されます。<Field Name="TypeShortDescription"> 要素が存在しない場合、"TypeDisplayName" を使用します。 "TypeShortDescription" はローカライズが可能な文字列でなければなりません。 |
UserCreatable |
オプションの Boolean。既定は TRUE であり、ユーザーがこのフィールド型のフィールドをリストに追加できます。値を FALSE に設定すると、リスト スキーマでフィールド型を使用できますが、[サイト内の新しい列] ページと [列の作成] ページの [名前と種類] セクションでは、ユーザーにはフィールド型が非表示になります。 |
例
ユーザー設定フィールド型を定義する例を示します。
.gif "重要") 重要 |
|---|
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>