Field 要素 (フィールド型)Field element (Field Types)

に適用されます: SharePoint 2016 |SharePoint Foundation 2013 |SharePoint オンライン |SharePoint Server 2013Applies to: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

フィールド型の特性を表します。Represents a characteristic of the field type.

<Field
  Name="Text">
</Field>

要素と属性Elements and attributes

以下のセクションで、属性、子要素、親要素について説明します。The following sections describe attributes, child elements, and parent elements.

属性Attributes

属性Attribute 説明Description
NameName
テキストが必要です。Required Text. Field要素が表すフィールドの種類の特定の側面の名前を表す文字列。A string that represents the name of the specific aspect of the field type that the Field element represents. 値は、 「備考」表に示す文字列のいずれかである必要があります。The value must be one of the strings listed in the table under Remarks.

子要素Child elements

なしNone

親要素Parent elements

注釈Remarks

FieldType要素の子要素をフィールドは、fldtypes で構成されている*%ProgramFiles%\Common ファイルにサーバーの extensions\15\TEMPLATE\XML 内の .xml ファイルです。Field element children of FieldType elements are configured in fldtypes*.xml files in %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\XML.

FieldTypeの各要素のName属性によって識別いくつかの必須および省略可能なフィールド要素があります。Each FieldType element has several required and optional Field elements distinguished by their Name attribute. 次の表では、これらの要素について説明します。The following table describes these elements. オブジェクト モデルでは、フィールドの型は、 SPFieldTypeDefinitionクラスによって表されます。In the object model, a field type is represented by the SPFieldTypeDefinition class. 後者のクラスには、(例外は、 InternalTypeおよびSQLType) テーブルの行の 2 つ以外のすべてに対応する読み取り専用プロパティがあります。The latter class has a read-only property corresponding to all but two of the rows of the table (the exceptions are InternalType and SQLType). を除きそれ以外の場合、プロパティ名は、対応する Name 属性の値と一致します。Except where noted otherwise, the property names match the value of the corresponding Name attribute.


フィールド要素の Name 属性の値Value of Field Element's Name Attribute 説明Description
AllowBaseTypeRenderingAllowBaseTypeRendering
省略可能なブール値です。Optional Boolean. 既定ではFALSE ですThe default is FALSE. クライアント アプリケーションは、カスタム フィールドの種類を正しくレンダリングする方法を決定できない場合、クライアント アプリケーションが基本型 ( ParentTypeとも呼ばれます)、フィールドを描画するかを指定します。Specifies whether a client application renders the field as its base type (also called the ParentType), if the client application cannot determine how to properly render the custom field type. 場合にTRUEを設定し、クライアント アプリケーションことはできません正しくレンダリング、ユーザー設定フィールドの種類のクライアント アプリケーションのレンダリングから継承する既定の SharePoint Foundation 親フィールドとしてフィールドを入力します。If set to TRUE, and the client application cannot properly render the custom field type, the client application renders the field as the default SharePoint Foundation parent field type from which it inherits.
CAMLRenderingCAMLRendering
省略可能なブール値です。Optional Boolean. 既定ではFALSE ですThe default is FALSE. FieldTypeの親要素内でRenderPattern要素の CAML マークアップを使用してリスト ビューでフィールドをレンダリングするかどうかを指定します。Specifies whether the field is rendered on list views using the CAML markup in a RenderPattern element elsewhere within the parent FieldType element. FALSEの既定では、フィールドを fldtypes で XSL 変換でリスト ビューでレンダリングすることを意味*.xsl ファイルは、リスト ビューでフィールドのレンダリングの標準的なシステムであります。The default FALSE means that the field is rendered on list views by an XSL transform in a fldtypes*.xsl file, which is the standard system for field rendering on list views. (ただし、この要素には影響しませんフィールドをレンダリングするの表示、新規作成、およびフォームを編集します。(However, this element has no effect on field rendering on Display, New, and Edit forms. RenderPatternもよい標準的な表示フォームのフィールドをレンダリングします。)A RenderPattern would still be the standard way of rendering the field on a Display form.)
FieldTypeClassFieldTypeClass
省略可能な文字列がユーザー設定フィールドのすべての種類に必要ですOptional String, but required for all your custom field types. フィールド型クラス ライブラリの厳密な名前を表します。Represents the strong name of the field type class library. FieldTypeClassには、バージョンカルチャ、およびのアセンブリ名、クラス名が含まれています。例えば:FieldTypeClass includes the class name and assembly name with Version, Culture, and PublicKeyToken; for example:
<Field Name="FieldTypeClass">CustomFieldTypes.RegularExpression.RegularExpressionField, CustomFieldTypes.RegularExpression, Version=1.0.0.0, Culture=neutral, PublicKeyToken=57e55365ec0ce80a</Field>

完全修飾クラス名だけでは、SharePoint の基盤に組み込まれているフィールドの種類に含まれています。Only the fully qualified class name is included for field types built into SharePoint Foundation.
FieldEditorUserControlFieldEditorUserControl
省略可能な文字列です。Optional String. 列の追加設定] セクションで、新しいサイト列] ページの SharePoint Foundation で表示されるコントロールを定義するfield_typeの FieldEditor.ascx ファイルへの相対パスを表します。Represents the relative path to a field_type FieldEditor.ascx file that defines a control that appears in SharePoint Foundation in the Additional Column Settings section on the New Site Column page. コントロールは、列の作成者を設定すると、特定の列のフィールドの型の変数のプロパティを有効にします。The control enables column creators to set, for a particular column, the variable properties of the field type.

次に例を示します。For example:
"/_controltemplates/RegularExpressionFieldEditor.ascx".

ある場合ない<Field Name="FieldEditorUserControl">要素は、フィールド型の特別なプロパティは、 PropertySchema要素 (フィールド型) によって表示されました。If there is no <Field Name="FieldEditorUserControl"> element, the special properties of the field type are rendered by the PropertySchema element (Field Types) element.

FieldEditorUserControlは、固定、ローカライズできない文字列である必要があります。FieldEditorUserControl should be a fixed, nonlocalizable string.
フィルター処理可能Filterable
ブール値が必要です。Required Boolean. このタイプを使用する列の値に応じて、このフィールドの型に基づく列を持つリストをフィルター処理することであるかどうかを表します。Represents whether a list with a column that is based on this field type can be filtered according to the value of the column that uses this type. 場合はTRUE列のヘッダーに設定されているユーザーは、一覧をフィルター処理に使用できるコントロールです。If set to TRUE, the header of the column is a control that users can use to filter the list.
InternalTypeInternalType
省略可能な文字列です。Optional String. 内部の基本型を表します。Represents an internal base type. 使用しないで、 <Field Name="InternalType"> 、カスタム フィールド型の定義内の要素。Do not use a <Field Name="InternalType"> element in your custom field type definitions.
ParentTypeParentType
文字列が必要です (ただし、空の文字列にすることができます)。Required String (but can be an empty string). フィールド クラスの派生元の型の名前を表します。Represents the name of the type from which the field class is derived. 使用可能な値は、正確にField 要素 (リスト)の要素のType属性の値と同じです。The possible values are exactly the same as the possible values for the Type attribute of the Field element (List) element. フィールドの型が別の型から派生していない場合は、値が空の文字列です。If the field type is not derived from another type, the value is an empty string:
<Field Name="ParentType"> </Field>. 空のカスタム フィールド型でする必要がありますはできません。It must never be empty in your custom field types. すべてのカスタム型は、別の型から継承します。All custom types inherit from another type.

SharePoint Foundation オブジェクト モデルでは、 ParentTypeBaseRenderingTypeNameと呼びます。In the SharePoint Foundation object model, ParentType is called BaseRenderingTypeName.
ShowOnListAuthoringPagesShowOnListAuthoringPages
省略可能なブール値です。Optional Boolean. 既定ではTRUE ですThe default is TRUE. リストに掲載するこの種類のフィールドが表示されるかどうかを表します。Represents whether this field type is displayed for inclusion on lists. 場合に設定する場合は TRUE、SharePoint Foundation では、ユーザーは、リストのフィールドの種類を含めることができますように、ページの作成] ボックスの一覧でこの種類のフィールドが表示されます。If set to TRUE, SharePoint Foundation displays this field type on list authoring pages so that users can include the field type on their lists.

SharePoint Foundation オブジェクト モデルでは、 ShowOnListAuthoringPagesShowOnListCreateと呼びます。In the SharePoint Foundation object model, ShowOnListAuthoringPages is called ShowOnListCreate.
ShowOnDocumentLibraryAuthoringPagesShowOnDocumentLibraryAuthoringPages
省略可能なブール値です。Optional Boolean. 既定ではTRUE ですThe default is TRUE. ドキュメント ライブラリに含めるこの種類のフィールドが表示されるかどうかを表します。Represents whether this field type is displayed for inclusion in document libraries. 場合に設定する場合は TRUE、SharePoint Foundation では、ユーザーがそのドキュメント ライブラリのフィールドの種類を含めることができますようにページを作成するドキュメント ライブラリにこの種類のフィールドが表示されます。If set to TRUE, SharePoint Foundation displays this field type on document library authoring pages so that users can include the field type in their document libraries.

SharePoint Foundation オブジェクト モデルでは、 ShowOnDocumentLibraryAuthoringPagesShowOnDocumentLibraryCreateと呼びます。In the SharePoint Foundation object model, ShowOnDocumentLibraryAuthoringPages is called ShowOnDocumentLibraryCreate.
ShowOnSurveyAuthoringPagesShowOnSurveyAuthoringPages
省略可能なブール値です。Optional Boolean. 既定ではTRUE ですThe default is TRUE. アンケートに掲載するこの種類のフィールドが表示されるかどうかを表します。Represents whether this field type is displayed for inclusion on surveys. 場合に設定する場合は TRUE、SharePoint Foundation では、アンケートのページを作成できるように、ユーザーが、アンケートのフィールドの種類を含めることができます [この種類のフィールドが表示されます。If set to TRUE, SharePoint Foundation displays this field type on survey authoring pages so that users can include the field type in their surveys.

SharePoint Foundation オブジェクト モデルでは、 ShowOnSurveyAuthoringPagesShowOnSurveyCreateと呼びます。In the SharePoint Foundation object model, ShowOnSurveyAuthoringPages is called ShowOnSurveyCreate.
ShowOnColumnTemplateAuthoringPagesShowOnColumnTemplateAuthoringPages
省略可能なブール値です。Optional Boolean. 既定ではTRUE ですThe default is TRUE. 列テンプレートのフィールドの種類として、このフィールドの種類を表示するかどうかを表します。Represents whether this field type should be displayed as a column template field type. 場合に設定する場合は TRUE、SharePoint Foundation では、このフィールドの種類の列テンプレートを作成するユーザーが選択できるようにページを作成する列テンプレートをこの種類のフィールドが表示されます。If set to TRUE, SharePoint Foundation displays this field type on column template authoring pages so that users can select to create a column template of this field type.

SharePoint Foundation オブジェクト モデルでは、 ShowOnColumnTemplateAuthoringPagesShowOnColumnTemplateCreateと呼びます。In the SharePoint Foundation object model, ShowOnColumnTemplateAuthoringPages is called ShowOnColumnTemplateCreate.
SQLTypeSQLType
省略可能な文字列です。Optional String. コンテンツ データベースにデータを格納するために使用される SQL データ型を表します。Represents the SQL data type that is used to store the data in the content database. 使用しないで、 <Field Name="SQLType"> 、カスタム フィールド型の定義内の要素。Do not use a <Field Name="SQLType"> element in your custom field type definitions.
並べ替え可能ですSortable
ブール値が必要です。Required Boolean. このタイプを使用する列には、このフィールドの種類に基づいて列を持つリストを並べ替えることができるかどうかを表します。Represents whether a list with a column that is based on this field type can be sorted on the column that uses this type. 場合はTRUE列のヘッダーに設定されているユーザーは、一覧を並べ替えるに使用できるコントロール。If set to TRUE, the header of the column is a control that users can use to sort the list.
TypeDisplayNameTypeDisplayName
文字列 が必要です。Required String. ユーザー インターフェイス (UI) 内のフィールド型の表示名を表します。Represents the display name of the field type in the user interface (UI). SharePoint の基盤では、(listedit.aspx) のユーザー設定ダイアログ ボックスの [リスト] ページの [種類] 列に表示されます。In SharePoint Foundation, it appears in the Type column on the Customize [list] page (listedit.aspx). 後者が存在しない場合もTypeShortDescriptionの代わりに使用します。It is also used in place of TypeShortDescription if the latter is not present.

TypeDisplayNameは、ローカライズ可能な文字列である必要があります。TypeDisplayName should be a localizable string.
TypeNameTypeName
文字列 が必要です。Required String. フィールドの型の名前を表します。Represents the name of the field type. これは SharePoint サーバー ファーム上のすべてのフィールドの種類名の間で一意である必要があります。This must be unique among all field type names on the SharePoint server farm.

型名は固定、ローカライズできない文字列である必要があります。TypeName should be a fixed, nonlocalizable string.
TypeShortDescriptionTypeShortDescription
省略可能な文字列です。Optional String. UI に表示されるフィールドの種類の簡単な説明を表します。Represents the short description of the field type that is displayed in the UI. SharePoint の基盤では、およびサイト列ギャラリーの [種類] 列で、名前と種類] で、新しいサイト内の列列の作成ページのオプション ボタンで表示されます。In SharePoint Foundation, it appears with a radio button in the Name and Type section of the New Site Column and Create Column pages and in the Type column of the Site Column Gallery. ある場合ない<Field Name="TypeShortDescription"> TypeDisplayNameの要素を使用します。If there is no <Field Name="TypeShortDescription"> element, TypeDisplayName is used.

TypeShortDescriptionは、ローカライズ可能な文字列である必要があります。TypeShortDescription should be a localizable string.
UserCreatableUserCreatable
省略可能なブール値です。Optional Boolean. 既定値はTRUEフィールド型のフィールドをリストに追加するユーザーを有効にします。The default is TRUE, which enables users to add fields of this field type to lists. 値をFALSEに設定するリスト スキーマのフィールドの種類の使用を可能にですが、新しいサイト内の列列の作成ページのユーザーの名前と種類] セクションからフィールドの種類を非表示にします。Setting the value to FALSE allows use of the field type in list schemas, but hides the field type from users on the Name and Type section of the New Site Column and Create Column pages.

Example

ユーザー設定フィールド型を定義する例を示します。The following example defines a custom field type.

重要

RenderPatternは廃止されています。The RenderPattern is obsolete. SharePoint Foundation の以前のバージョンを最初に開発されたカスタム フィールドのデバッグに使用することだけは、ここで表示されます。It is shown here solely to assist in the debugging of custom fields that were originally developed against earlier versions of 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>

関連項目See also