通过

Field 元素（字段类型）

  • 项目

上次修改时间： 2015年3月9日

适用范围： SharePoint Foundation 2010

本文内容
属性
子元素
父元素

表示字段类型的特征。

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

属性

属性

说明

Name

必需属性，类型为 Text。一个字符串，表示字段类型（由 Field 元素表示）的特定方面的名称。此值必须是下表中列出的字符串之一。

子元素

无

父元素

FieldType 元素（字段类型）

备注

将在位于 %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE\XML 中的 fldtypes*.xml 文件中配置 FieldType 元素的 Field 元素子级。

每个 FieldType 元素都具有几个必需的和可选的 Field 元素，这些元素将按照 Name 属性来区分。下表说明了这些元素。在 对象模型中，字段类型由 SPFieldTypeDefinition 类表示。该类具有与表中除两个行之外的所有行对应的只读属性。（这两个例外的行是 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。表示 field_typeFieldEditor.ascx 文件的相对路径，此文件可定义在 SharePoint Foundation 中的"新建网站栏"页上的"其他栏设置"部分中出现的控件。利用此控件，栏创建者可以为特定栏设置字段类型的变量属性。例如，"/_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。表示在用户界面中显示的字段类型的简短描述。在 SharePoint Foundation 中，它显示在"新建网站栏"和"创建栏"页面的"名称和类型"部分中以及"网站栏库"的"类型"栏中，并带有一个单选按钮。如果不存在 <Field Name="TypeShortDescription"> 元素，则使用 "TypeDisplayName"。

"TypeShortDescription" 应为可本地化的字符串。

UserCreatable

可选属性，类型为 Boolean。默认值为 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>

请参阅

任务

演练：创建自定义字段类型

概念

自定义字段类型

如何：创建自定义字段类

自定义字段类型属性呈现

如何：创建自定义字段类型定义