通过

FieldRef 元素 (ContentType)

  • 项目

适用于：SharePoint 2016 |SharePoint Foundation 2013 |SharePoint Online |SharePoint Server 2013

指定要在此内容类型中引用的列。

定义

<FieldRef
  Aggregation="sum" | "count" | "average" | "min" | "max" | "merge" | "plaintext" | "first" | "last"
  Customization="Text"
  DefaultValue="Text"
  Description="Text"
  DisplayName="Text"
  Format="Text"
  Filterable="TRUE" | "FALSE"
  FilterableNoRecurrence="TRUE" | "FALSE"
  FromBaseType="TRUE" | "FALSE"
  Hidden="TRUE" | "FALSE" | "orResource"
  ID="Text"
  Locked="TRUE" | "FALSE"
  Name="Text"
  Node="Text"
  NumLines="Integer"
  PIAttribute="Text"
  PITarget="Text"
  PrimaryPIAttribute="Text"
  PrimaryPITarge="Text"
  ReadOnly="TRUE" | "FALSE"
  ReadOnlyClient="TRUE" | "FALSE"
  Required="TRUE" | "FALSE"
  Sealed="TRUE" | "FALSE"
  ShowInDisplayForm="TRUE" | "FALSE"
  ShowInEditForm="TRUE" | "FALSE"
  ShowInFileDlg="TRUE" | "FALSE"
  ShowInListSettings="TRUE" | "FALSE"
  ShowInNewForm="TRUE" | "FALSE"
  Sortable="TRUE" | "FALSE">
</FieldRef>

元素和属性

下面各部分介绍了属性、子元素和父元素。

Attributes

属性 说明
聚集

如果使用 Node 属性指定返回值集合的 XPath 表达式，则还可以包含一个 Aggregation 属性，该属性指定要对返回的值集合执行的操作。

此操作可以是一个聚合函数，也可以指定集合中的特定元素。

可能的值包括：

  • 和

  • count

  • 平均

  • min

  • 麦克斯

  • 合并

  • plaintext 将节点文本内容转换为纯文本。

  • first 将属性提升和降级应用于集合中的第一个元素。

  • last 将属性提升和降级应用于集合中的最后一个元素。

有关如何在 XML 文档中将 Node、 PIAttribute、 PITarget、 PrimaryPIAttribute 和 PrimaryPITarget 属性用于属性升级和降级的详细信息，请参阅 使用内容类型指定 XML 文档属性。
自定义选项

可选 文本。 协作应用程序标记语言中的字符串 (CAML) ，用于定义自定义字段属性。
DefaultValue

已过时。
说明

可选属性，类型为 Text。 如果已指定列说明，则提供在列表的编辑表单中显示的说明。 默认情况下，SharePoint Foundation 中的列没有说明。
DisplayName

必需属性，类型为 Text。 列的显示名称。 最大长度为 255 个字符。

当字段在表视图中显示时，此属性的值将用作列标题；当字段在表单中显示时，此属性的值将用作表单标签。 可以使用 DisplayName 属性将显示名称更改为不同于在字段本身上定义的名称的值。
Format

可选属性，类型为 Text。 指定要用于数值的格式。

对于日期/时间列，可能为下面的值：

  • DateOnly 仅显示 (并允许编辑) 日期部分， (时间部分设置为中午 12：00，) 。

  • DateTime (默认) 显示和编辑日期和时间。

  • ISO8601 以转换为 UTC 的 ISO8601 时间格式显示日期和时间：YYYY-MM-DDTHH：MM：SSZ。

    这是用于 Microsoft Office 系统中的文档属性的格式，以及用于 Microsoft SharePoint Foundation 中新窗体和编辑窗体与服务器之间的标准交换格式。

  • ISO8601基本使用 8601 日期/时间格式的缩写形式：YYYYMMDDTHHMMSSZ。

    这是用于 vCard/iCal 的格式。

对于 Choice 字段，此属性可设置为 Dropdown（默认值），这将通过下拉选项提供编辑选项；也可以设置为 RadioButtons，这将通过一组单选按钮提供选项。

对于 URL 字段，此属性可以设置为 “超链接 ” (默认) （将 URL 显示为普通 <A> 标记）或“ 图像”（将 URL 显示为 <IMG SRC="URL" ALT="Description">）。
Filterable

可选属性，类型为 Boolean。 若要将列定义为可筛选，则为 TRUE。
FilterableNoRecurrence

可选属性，类型为 Boolean。 若要将列定义为可筛选且无重复值，则为 TRUE。
FromBaseType

可选属性，类型为 Boolean。 反对此属性，而支持 Sealed 属性。
Hidden

可选属性，类型为 Boolean。 若为 TRUE，则会在用户界面上完全隐藏字段。 将 ReadOnly 设置为 TRUE 意味着字段不显示在“新建”或“编辑”窗体中，但仍可包含在视图中。

如果未包含此属性，SharePoint Foundation 会将列视为属性设置为 FALSE。
ID

必需 文本。 指定此 FieldRef 元素引用的列的字段 ID。 字段 ID 是 GUID 的字符串表示形式，包括大括号。 值区分大小写。

可以在位于以下路径的 文件中 fieldswss.xml 找到内置字段的 ID：
%ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\FEATURES\fields
Locked 已过时。
名称

必需属性，类型为 Text。 列的名称。 这是列的内部名称，并且保证在字段定义的生存期内绝不会更改此名称。 它相对于列表中的字段集必须是唯一的。
Node

可选属性，类型为 Text。 在包含列值的文档中指定 XML 节点。 用于在 XML 文档中进行属性升级和降级。

有关如何在 XML 文档中使用 Node、PIAttribute、PITarget、Primary PIAttribute 和 PrimaryPITarget 属性进行属性升级和降级的详细信息，请参阅Using Content Types to Specify XML Document Properties。
NumLines

可选属性，类型为 Integer。 建议编辑过程中在 TEXTAREA 块中显示的行数。 这只是客户端用户界面提示，对于可以编辑的文本行数量没有任何强制性限制。
PIAttribute 可选 文本。 指定文档处理指令（由 PITarget 属性指定）中要用作列值的属性。 用于在 XML 文档中进行属性升级和降级。

如果指定 PIAttribute 属性，则还必须指定 PITarget 属性。

有关如何在 XML 文档中使用 Node、PIAttribute、PITarget、Primary PIAttribute 和 PrimaryPITarget 属性进行属性升级和降级的详细信息，请参阅Using Content Types to Specify XML Document Properties。
PITarget

可选属性，类型为 Text。 指定文档处理指令，其中列值存储在此内容类型的文档中。 用于在 XML 文档中进行属性升级和降级。

如果指定 PIAttribute 属性，则还必须指定 PITarget 属性。

有关如何在 XML 文档中使用 Node、PIAttribute、PITarget、Primary PIAttribute 和 PrimaryPITarget 属性进行属性升级和降级的详细信息，请参阅Using Content Types to Specify XML Document Properties。
PrimaryPIAttribute

可选 文本。 指定文档处理指令（由 PrimaryPITarget 指定）中要用作列值的替换属性。

如果指定 PrimaryPIAttribute 属性，则还必须指定 PrimaryPITarget 属性。 如果指定，SharePoint Foundation 将使用这些值，然后再使用 PITarget 和 PIAttribute 属性中指定的值。

用于在 XML 文档中进行属性升级和降级。

有关如何在 XML 文档中使用 Node、PIAttribute、PITarget、Primary PIAttribute 和 PrimaryPITarget 属性进行属性升级和降级的详细信息，请参阅Using Content Types to Specify XML Document Properties。
PrimaryPITarget

可选属性，类型为 Text。 指定备用文档处理指令，其中将为此内容类型的文档存储列值。

如果指定 PrimaryPIAttribute 属性，则还必须指定 PrimaryPITarget 属性。 如果指定，SharePoint Foundation 将使用这些值，然后再使用 PITarget 和 PIAttribute 属性中指定的值。

有关如何在 XML 文档中使用 Node、PIAttribute、PITarget、Primary PIAttribute 和 PrimaryPITarget 属性进行属性升级和降级的详细信息，请参阅Using Content Types to Specify XML Document Properties。
ReadOnly

可选属性，类型为 Boolean。 如果 为 TRUE，则字段不显示在 “新建 ”或 “编辑” 窗体中，但可以包含在视图中。 若将 Hidden 属性设置为 TRUE，则会在用户界面上完全隐藏字段。

如果未包含此属性，SharePoint Foundation 会将列视为属性设置为 FALSE。
必需

必需 布尔值。 如果为 TRUE，则必须首先为该字段分配值，然后才能保存使用此内容类型创建的项目。

如果在表单帖子中提供了空字段值，则标准必填字段文本或显式指定的消息 (即通过 <ErrorText> 标记) 显示在错误表单中。 此验证仅由客户端处理（数据库始终允许所有用户自定义的字段为 NULL）。
密封

可选属性，类型为 Boolean。 若要将列定义为密封，则为 TRUE。 不能通过 SharePoint Foundation 用户界面或对象模型编辑密封列。如果未包含此属性，SharePoint Foundation 会将列视为属性设置为 FALSE。
ShowInDisplayForm

可选属性，类型为 Boolean。 若要在显示表单上显示此内容类型的项目的列，则为 TRUE。
ShowInEditForm

可选属性，类型为 Boolean。 若要在“编辑项目”页上显示字段，则为 TRUE。
ShowinFileDlg

可选属性，类型为 Boolean。 若要在文件对话框中显示此内容类型的项目的列，则为 TRUE。
ShowInListSettings

可选属性，类型为 Boolean。 如果为 FALSE，则当显示模式设置为 New 时，字段不会出现在 Fields 枚举中。 具有此设置的字段不会出现在给定列表的默认“新建项目”页中。
ShowInNewForm

可选属性，类型为 Boolean。 若要在新建表单上显示此内容类型的项目的列，则为 TRUE。
可排序

可选属性，类型为 Boolean。 如果可以对字段中的值进行排序，则为 TRUE。

子元素

无

父元素

Occurrence

  • 最小值：0
  • 最大值：无限制

备注

FieldRef 元素是对在其他位置（网站或列表级别）上定义的列的引用。 在字段引用中，可以重写列属性的子集，如下所示：

  • 显示名称
  • XML 升级和降级属性
  • 字段为只读、必需还是隐藏

若在字段引用中更改这些属性，则这些属性只会在其应用于包含该字段引用的特定内容类型时发生更改。

重要

ID、Name、DisplayName 和 Required 属性始终是必需的，即使 FieldRef 元素引用的字段在同一元素清单中定义也是如此。

示例

下面的示例演示两个 FieldRef 元素，这些元素指定要在内容类型中包含的列。

<FieldRefs>
  <!--  Built-in Title field -->
  <FieldRef ID="{fa564e0f-0c70-4ab9-b863-0177e6ddd247}" Name="Title" DisplayName="Item" Required="TRUE" Sealed="TRUE"/>
  <!--  Custom CostCenter field -->
  <FieldRef ID="{943E7530-5E2B-4C02-8259-CCD93A9ECB18}" Name="CostCenter" DisplayName="Department" Required="TRUE"/>
</FieldRefs>

另请参阅