Field 元素 (字段)

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

定义网站栏。

定义

<Field
  Aggregation="sum" | "count" | "average" | "min" | "max" | "merge" | "plaintext" | "first" | "last"
  AllowDeletion="TRUE" | "FALSE"
  AllowDuplicateValues="TRUE" | "FALSE"
  AllowHyperlink="TRUE" | "FALSE"
  AllowMultiVote="TRUE" | "FALSE"
  AppendOnly="TRUE" | "FALSE"
  AuthoringInfo="Text"
  BaseType="Integer" | "Text"
  CalType="Integer"
  CanToggleHidden="TRUE" | "FALSE"
  ClassInfo="Text"
  ColName="Text"
  Commas="TRUE" | "FALSE"
  Customization=Text
  Decimals="Integer"
  DefaultListField="TRUE" | "FALSE"
  Description="Text"
  Dir="Text"
  DisplaceOnUpgrade="TRUE" | "FALSE"
  DisplayImage="Text"
  DisplayName="Text"
  DisplayNameSrcField="Text"
  DisplaySize=Integer
  Div="Number"
  EnableLookup="TRUE" | "FALSE"
  ExceptionImage="Text"
  FieldRef="Text"
  FillInChoice="TRUE" | "FALSE"
  Filterable="TRUE" | "FALSE"
  FilterableNoRecurrence="TRUE" | "FALSE"
  ForcedDisplay="Text"
  Format="DateOnly | DateTime | TimeOnly | EventList | ISO8601 | MonthDayOnly | MonthYearOnly | ISO8601Basic | ISO8601Gregorian | ISO8601BasicDateOnly | DropDown | RadioButtons | HyperLink | Image | TRUE | FALSE"
  FromBaseType="TRUE" | "FALSE"
  Group="Text"
  HeaderImage="Text"
  Height="Integer"
  Hidden="TRUE" | "FALSE"
  HTMLEncode="TRUE" | "FALSE"
  ID="Text"
  IMEMode="active | inactive"
  Indexed="TRUE" | "FALSE"
  IsolateStyles="TRUE" | "FALSE"
  IsRelationship="TRUE" | "FALSE"
  JoinColName="Text"
  JoinRowOrdinal="Integer"
  JoinType="INNER" | "LEFT OUTER" | "RIGHT OUTER"
  LCID="Integer"
  LinkToItem="TRUE" | "FALSE"
  List="Text"
  Max="Number"
  MaxLength="Integer"
  Min="Number" 
  Mult="TRUE" | "FALSE"
  Name="Text"
  NegativeFormat="MinusSign" | "Parens"
  Node="Text"
  NoEditFormBreak="TRUE" | "FALSE"
  NumLines="Integer"
  Overwrite="TRUE" | "FALSE"
  OverwriteInChildScopes="TRUE" | "FALSE"
  Percentage="TRUE" | "FALSE"
  PIAttribute="Text"
  PITarget="Text"
  PrependId="TRUE" | "FALSE"
  Presence="TRUE" | "FALSE"
  PrimaryKey="TRUE" | "FALSE"
  PrimaryPIAttribute="Text"
  PrimaryPITarget="Text"
  ReadOnly="TRUE" | "FALSE"
  ReadOnlyEnforced="TRUE" | "FALSE"
  RelationshipDeleteBehavior="Restrict | Cascade | None"
  RenderXMLUsingPattern="TRUE" | "FALSE"
  Required="TRUE" | "FALSE"
  RestrictedMode="TRUE" | "FALSE"
  ResultType="Text"
  RichText="TRUE" | "FALSE"
  RichTextMode="Text"
  RowOrdinal="Integer"
  Sealed="TRUE" | "FALSE"
  SeperateLine="TRUE" | "FALSE"
  SetAs="Text"
  ShowAddressBookButton="TRUE" | "FALSE"
  ShowField="Text" | "Choice" | "Counter"
  ShowInDisplayForm="TRUE" | "FALSE"
  ShowInEditForm="TRUE" | "FALSE"
  ShowInFileDlg="TRUE" | "FALSE"
  ShowInListSettings="TRUE" | "FALSE"
  ShowInNewForm="TRUE" | "FALSE"
  ShowInVersionHistory="TRUE" | "FALSE"
  ShowInViewForms="TRUE" | "FALSE"
  Sortable="TRUE" | "FALSE"
  SourceID="Text"
  StaticName="Text"
  StorageTZ="UTC" | "Abstract"
  StripWS="TRUE" | "FALSE"
  SuppressNameDisplay="TRUE" | "FALSE"
  TextOnly="TRUE" | "FALSE"
  Title="Text" 
  Type="Data_Type"
  UniqueId="Text"
  UnlimitedLengthInDocumentLibrary="TRUE" | "FALSE"
  URLEncode="TRUE" | "FALSE"
  URLEncodeAsUrl="TRUE" | "FALSE"
  UserSelectionMode="Text"
  UserSelectionScope="Integer"
  Viewable="TRUE" | "FALSE"
  Width="Integer"
  WikiLinking="TRUE" | "FALSE"
  XName="Text">
</Field>

元素和属性

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

Attributes

属性 说明
聚集 可选属性,类型为 Text。在 XML 表单上的聚合字段中使用,以指定应用于由 XPath 表达式返回的值或元素集合的函数。如果使用 Node 属性指定返回值集合的 XPath 表达式,则还可以包含一个 Aggregation 属性,该属性指定要对返回的值集合执行的操作。此操作可以是一个聚合函数,也可以是集合中特定元素的指示。

可能的值包括:

  • sum:添加值。
  • count:计数值数。
  • average:查找值的平均值。
  • min:查找最小值。
  • max:查找最大值。
  • 合并:合并值。
  • 纯文本:将节点文本内容转换为纯文本。
  • 第一:将属性提升和降级应用到集合中的第一个元素。
  • last:将属性提升和降级应用到集合中的最后一个元素。

有关如何将 NodePIAttributePITargetPrimaryPIAttributePrimaryPITarget 属性用于 XML 文档中的属性提升和降级的详细信息,请参阅 使用内容类型指定 XML 文档属性

AllowDeletion 可选属性,类型为 Boolean。 如果可以删除字段,则为 TRUE
AllowDuplicateValues 可选属性,类型为 Boolean。指定是否允许在给定的列表字段中使用重复值。将该值设置为 false(不允许输入重复值)能使此字段的行为类似于主键。如果允许在字段中使用重复值,则为 True;否则为 false。默认值为 true
AllowHyperlink 可选属性,类型为 Boolean。 如果可以在字段中使用超链接,则为 TRUE
AllowMultiVote 可选属性,类型为 Boolean。 如果在调查中允许有多个响应,则为 TRUE
AppendOnly 可选属性,类型为 Boolean。 在列表中启用版本控制时,如果文本只能附加到 Note 字段中的现有文本,则为 TRUE
AuthoringInfo 可选属性,类型为 Text。在字段编辑页中显示的描述性字符串,用于标识字段及其用途;例如,LinkTitle 字段具有创作信息“(链接到项目)”。如果存在用于其他用途的同名字段,则通常会使用此属性。
BaseType 可选属性。BaseType 属性可设置为 Integer,这会将值存储为整数;也可设置为 Text(默认值),这会将值存储为文本。不能创建整数基类型选项字段。
CalType 可选属性,类型为 Integer。 指定日历类型。 可能的值包括:
  • 16: 萨卡时代
  • 15:中国月球
  • 14:韩国和日本的月球
  • 12:公历被音译的法语
  • 11:公历音译英语
  • 10:公历阿拉伯语
  • 9:公历中东法语
  • 8:希伯来语 (月)
  • 7:泰语
  • 6:Hijri (阿拉伯文月球)
  • 5:韩国唐云时代
  • 4:台湾时代
  • 3:日本天皇时代
  • 1:公历
  • 0:未指定类型
CanToggleHidden 可选属性,类型为 Boolean。 如果可以通过用户界面隐藏字段,则为 TRUE
ClassInfo 可选属性,类型为 Text。指定用于标准表视图中的字段的级联样式表 (CSS) 类。如果进行了设置,则将会使用指定的类,而不使用标准的 ms-vb2 类。
ColName 可选属性,类型为 Text。一个内部属性,定义字段与此字段的物理存储名称之间的映射。这必须是基础数据库中的有效名称,并且必须与数据库表中使用的名称相同。如果未指定,则服务器将生成一个列名称,此列名称不会与任何现有列名称发生冲突并只包含 Microsoft SQL Server 允许的字符。
逗号 可选属性,类型为 Boolean。 如果使用逗号来分隔千位,则为 TRUE
自定义选项 可选属性,类型为 Text。 提供向自定义字段类型添加自定义属性的功能。
小数 可选属性,类型为 Integer。确定要显示的小数位数。将根据显示精度对显示的值进行四舍五入;例如,若四舍五入到一位小数,则 1.05 将显示为 1.1。
DefaultListField 可选属性,类型为 Boolean。 获取一个值,指定将某个文件上载到文档库时,是否显示该文件的“编辑属性”表单。 如此 如果要添加到库中的字段没有可见 的“编辑属性 ”窗体;否则为 false。 默认值为 false
说明 可选属性,类型为 Text。 提供列表的编辑表单中显示的说明(如果已指定字段说明)。 默认情况下,Microsoft SharePoint Foundation 中的字段没有说明。
Dir 可选属性,类型为 Text。指定支持双向阅读顺序的字段的文本方向。可能的值为 LTR(从左到右)、RTL(从右到左)和 none
DisplaceOnUpgrade 可选属性,类型为 Boolean。如果字段已存在字段定义,则为 TRUE,以强制使用字段定义中指定的值更新字段属性。
DisplayImage 可选属性,类型为 Text。 指定为列显示的图标的名称。
DisplayName 可选属性,类型为 Text。 字段的显示名称。 没有空格使用限制。 最大长度为 255 个字符。 该值可以是格式为 $Resources:String 的资源引用。 有关详细信息,请参阅 本地化 SharePoint 解决方案

该显示名称可由用户编辑并且可在初始字段创建后更改。该名称在字段显示在表视图中时用作栏标题,在字段显示在表单中时用作表单标签。

DisplayNameSrcField 可选属性,类型为 Text。通常用于需要与另一个字段具有相同名称的计算字段。如果用户已修改源字段并更改显示名称,则此字段的显示名称也将发生更改。该字符串引用其他字段的名称。
DisplaySize 可选属性,类型为 Integer
Div 可选属性,类型为 Number。在显示数目之前,除法中使用的比例因子。显示数目为 N * Mult / Div(四舍五入到 Decimals 指定的数目)。
EnableLookup 可选属性,类型为 Boolean。 若要启用字段中的查找值,则为 TRUE
ExceptionImage 可选 文本。 在 Recurrence 字段类型中使用,以指定要用于例外情况的图像文件的名称。
FieldRef 可选属性,类型为 Text。对于次查阅字段,指定其所依赖的主查阅字段的 ID。该值应为没有括号的 GUID 字符串表示。
FillInChoice 可选属性,类型为 Boolean。 如果字段允许用户填写列值,则为 TRUE
Filterable 可选属性,类型为 Boolean。 如果可以对字段进行筛选,则为 TRUE
FilterableNoRecurrence 可选属性,类型为 Boolean。如果可以对未扩展定期事件的视图中的字段创建筛选器,则为 TRUE。如果 Filterable 包含 TRUE,则可以在所有视图中对字段进行筛选,而与如何设置 FilterableNoRecurrence 无关。
ForcedDisplay 可选属性,类型为 Text。指定要显示的文本,此文本将代替实际字段值。在调查中使用此属性可阻止显示用户名。
Format 可选属性,类型为 Text。 指定用于数值的格式。

对于日期/时间字段,可能是下面的值:

  • DateOnly:显示 (并允许编辑仅) 时间部分设置为凌晨 12:00 的日期部分 (。 对于所有已编辑的值) 。
  • DateTime:显示和编辑一天中的日期和时间 (默认) 。
  • ISO8601:以 ISO8601 时间格式显示日期和时间,转换为协调世界时 (UTC) 格式:YYYY-MM-DDTHH:MM:SSZ。 这是用于 2007 年 Microsoft Office 系统中的文档属性的格式,以及 表单和 编辑 表单与服务器之间 SharePoint Foundation 中使用的标准交换格式。
  • ISO8601Basic:使用 8601 日期/时间格式的缩写形式:YYYYMMDDTHHMMSSZ。 这是用于 vCard/iCal 的格式。

对于“选择”字段,此属性可以设置为 下拉 列表 (默认) ,它通过下拉列表选择或 RadioButtons 提供编辑选项,后者通过一组单选按钮提供选项。

对于 URL 字段,此属性可以设置为 Hyperlink (默认) ,将 URL 显示为普通<a>标记,或 设置为图像,后者显示 URL。<img src="url" alt="Description" />

FromBaseType 可选属性,类型为 Boolean。 不建议使用此属性,而应使用 Sealed 属性。
Group 可选属性,类型为 Text。 指定字段所属的列组。
HeaderImage 可选属性,类型为 Text。 指定要用作字段中的标题的图像文件的名称。
Height 可选属性,类型为 Integer。 指定为用户信息列表中的用户显示的图像的高度(以像素为单位)。
Hidden 可选属性,类型为 Boolean。若为 TRUE,则会在用户界面上完全隐藏字段。若将 ReadOnly 设置为 TRUE,则表示字段在新建表单或编辑表单中不显示,但仍可以包含在视图中。
HTMLEncode 可选属性,类型为 Boolean。如果为 TRUE,则转换嵌入的字符,以便这些字符作为文本显示在浏览器中;将可能与 HTML 标记相混淆的字符转换为实体
ID 必需属性,类型为 Text。 唯一标识字段。 该值应是大括号 () {} 中包含的 GUID 的字符串表示形式。
IMEMode 可选属性,类型为 Text。指定用于字段的输入法编辑器 (IME) 模式偏量。当一个编写系统具有的字符多于可为给定键盘编码的字符时,IME 允许语言之间的键击转换。

可能的值包括:

  • auto:未使用。 若要指定此 IME 模式,请将 IMEMode 属性值设置为空字符串 (“) 。
  • 活动:所有字符都通过 IME 键入,但用户仍然可以停用 IME。
  • 非活动:在不使用 IME 的情况下键入字符,尽管用户仍然可以激活 IME。
Indexed 可选属性,类型为 Boolean。 如果编制列索引以用于视图筛选器,则为 TRUE

注意:尽管可以为查阅列编制索引以提高性能,但使用索引查找列防止超出列表视图阈值不起作用。 若要避免超过列表视图阈值,请使用另一种类型的列作为主要索引或辅助索引。

IsolateStyles 可选属性,类型为 Boolean。对于其 RichText 属性为 TRUERichTextMode 属性为 FullHtmlText 字段,此属性指定服务器将重写此字段的 HTML 以确保它不会干扰周围页面的呈现。
IsRelationship 可选属性,类型为 Boolean如果 此字段由另一个列表 中的 GetRelatedFields () 方法返回,则为 TRUE。
JoinColName 可选属性,类型为 Text。仅为查阅字段定义此属性。除了指示在本地和外部列表之间的 SQLJOIN 中使用的列的名称之外,此属性与 ColName 非常类似。通常不应自定义此值。当前仅在某些内置和基类型字段的字段架构中使用此值,以指示在与 UrlID 列联接的 URL (DocMd) 表中进行查找。
JoinRowOrdinal 可选属性,类型为 Integer。 不应从代码中直接使用。
JoinType 可选属性,类型为 Text。 指定字段上使用的 JOIN 类型。 可能的值包括 INNERLEFTOUTERRIGHTOUTER
LCID 可选属性,类型为 IntegerLCID 属性可用于指定采用所使用的货币格式的国家/地区(例如,1033 代表美国)。

有两种涉及欧元符号格式的特殊情况。如果 LCID=-1 (0xFFFFFFF),则会作为数值的前缀添加欧元符号。如果 LCID=-2 (0xFFFFFFE),则会作为数值的后缀添加欧元符号。小数位数是 2,但是可由该字段的 Decimals 属性替代。在 UCS-2 中,欧元货币符号等于 0x20AC。

列表 可选 文本。 用于标识查阅字段 (Type="Lookup") 的目标列表。

如果目标列表已存在,List 属性的值应是标识目标列表的 GUID 的字符串表示(包括括号)。如果目标列表与该字段所属的列表相同,则可以指定“自身”。

如果目标列表不存在,List 属性的值可以是相对于网站的 URL(例如“Lists/My List”),但只有在创建目标列表与创建查阅字段所用的功能相同时才适用。在这种情况下,Field 元素上 List 属性的值必须等于创建目标列表的 ListInstance 元素上的 Url 属性的值。

Max 可选属性,类型为 Number。 指定字段允许的最大值。
MaxLength 可选属性,类型为 Integer。指定字段值中允许的字符的最大数目。调整编辑表单以强制使用此值(将在客户端上验证此值)。如果用户尝试输入的字符的数目多于 MaxLength 设置的字符的数目,将出现一条错误消息。
Min 可选属性,类型为 Number。 指定字段允许的最小值。
Mult 可选属性,类型为 Boolean。 选择 TRUE 可允许查阅字段包含多个值。 默认值为 FALSE
名称 必需属性,类型为 Text。 字段的内部名称。 对于列表或网站中的字段集,该名称必须是唯一的。 SharePoint Foundation 将根据需要修改该值,以保证其唯一性;否则,字段定义的生存期内不会更改。
NegativeFormat 可选属性,类型为 Text。 指定如何指示负值。 可以设置为下列值之一:
  • 减号:使用减号作为前缀。
  • Parens:括在括号上。
Node 可选属性,类型为 Text。在 XML 表单中使用,除了处理指令 (PI) 链接之外,此属性是所有字段必需的,它为提升的节点指定 XPath 表达式。
NoEditFormBreak 可选属性,类型为 Boolean。若为 TRUE,则阻止在新项目表单或编辑项目表单中的字段之间添加换行符。某些字段类型(如格式文本字段)默认情况下会提供间距,此属性可用来控制由此产生的额外间距。
NumLines 可选属性,类型为 Integer。建议编辑过程中在 TEXTAREA 块中显示的行数。这只是客户端用户界面提示,对于可以编辑的文本行数量没有任何强制性限制。
Overwrite 可选属性,类型为 Boolean。指定当新字段与现有字段具有相同的字段 ID 时,是否使用在网站 (SPWeb) 上激活的新字段的字段定义来覆盖现有字段的字段定义。如果新字段覆盖具有相同字段 ID 的现有字段,则为 True;否则为 false。默认值为 false

注意:如果现有字段是只读的,或者是密封的,则即使此属性设置为 true,也不会被激活的字段覆盖。

OverwriteInChildScopes 可选属性,类型为 Boolean。指示在设置网站集中的字段时,如果指定的字段定义已存在于该网站集的子网站中,是否要覆盖该字段定义。如果应覆盖该网站定义,则为 True;否则为 false。默认值为 false
Percentage 可选属性,类型为 Boolean。 如果值显示为百分比,则为 TRUE;即,将数字乘以 100%。
PIAttribute 可选属性,类型为 Text。指定文档处理指令(由 PITarget 属性指定)中要用作列值的属性。用于在 XML 文档中进行属性升级和降级。如果指定 PIAttribute 属性,则还必须指定 PITarget 属性。

有关如何在 XML 文档中使用 NodePIAttributePITargetPrimary PIAttributePrimaryPITarget 属性进行属性升级和降级的详细信息,请参阅 Using Content Types to Specify XML Document Properties

PITarget 可选属性,类型为 Text。指定文档处理指令,其中列值存储在此内容类型的文档中。用于在 XML 文档中进行属性升级和降级。如果指定 PIAttribute 属性,则还必须指定 PITarget 属性。

有关如何在 XML 文档中使用 NodePIAttributePITargetPrimary PIAttributePrimaryPITarget 属性进行属性升级和降级的详细信息,请参阅 Using Content Types to Specify XML Document Properties

PrependId 可选属性,类型为 Boolean。由可拥有多个值的查阅字段使用。指定 TRUE 可显示目标项目的项目 ID 以及编辑和新建项目表单中目标字段的值。
状态 可选属性,类型为 Boolean。 如果字段中显示用户信息,则为 TRUE
PrimaryKey 可选属性,类型为 Boolean。 如果字段为一个列表和另一个列表之间的关系中的主键,则为 TRUE
PrimaryPIAttribute 可选属性,类型为 Text。 用于在 XML 文档中进行属性升级和降级。 指定文档处理指令(由 PrimaryPITarget 指定)中要用作列值的替换属性。 如果指定 PrimaryPIAttribute 属性,则还必须指定 PrimaryPITarget 属性。 如果指定,SharePoint Foundation 会在 PITargetPIAttribute 属性中指定的值之前使用这些值。

有关如何在 XML 文档中使用 NodePIAttributePITargetPrimary PIAttributePrimaryPITarget 属性进行属性升级和降级的详细信息,请参阅 Using Content Types to Specify XML Document Properties

PrimaryPITarget 可选属性,类型为 Text。 指定备用文档处理指令,其中将为此内容类型的文档存储列值。 如果指定 PrimaryPIAttribute 属性,则还必须指定 PrimaryPITarget 属性。 如果指定,SharePoint Foundation 会在 PITargetPIAttribute 属性中指定的值之前使用这些值。

有关如何在 XML 文档中使用 NodePIAttributePITargetPrimary PIAttributePrimaryPITarget 属性进行属性升级和降级的详细信息,请参阅 Using Content Types to Specify XML Document Properties

ReadOnly 可选属性,类型为 Boolean。 如果为 TRUE,则字段不会在新建表单或编辑表单中显示,但可以包含在视图中。 此外,将 ReadOnly 设置为 TRUE,可以在用于管理网站栏和内容类型的网站设置页上隐藏字段。 若将 Hidden 属性设置为 TRUE,则会在用户界面上完全隐藏字段。 如果不包括此属性,SharePoint Foundation 会将该列视为此属性设置为 False
ReadOnlyEnforced 可选属性,类型为 Boolean。若要指定用户无法通过任何方式更改字段,只有系统才能更改此字段,则为 TRUE
RelationshipDeleteBehavior 可选属性,类型为 Text。 指定查阅字段的删除约束。 有关详细信息,请参阅 SPRelationshipDeleteBehavior 枚举。

对于网站栏,该值必须为 CascadeRestrict。它可以是 None(默认值),或者可忽略该属性。

如果您指定 None 之外的任何其他值,则还必须为 IndexedMult 属性分别指定 TRUEFALSE

RenderXMLUsingPattern 可选属性,类型为 Boolean。用于计算字段以确定显示格式。如果为 TRUE,则将基于计算字段的显示模式而不是基于计算字段所基于的第一个非计算字段引用的列值来呈现值。例如,在图片库中,图片大小列是由 宽度 x 高度 来表示的,但如果该属性未设置为 TRUE,则仅显示第一个字段引用(宽度)。如果设置为 TRUE,则显示格式 宽度 x 高度
Required 必需 的布尔值。 如果为 TRUE,则不得对字段分配空值。 如果窗体帖子中未给出非空字段值,则标准必填字段文本或显式指定的消息 (即通过 <ErrorText> 标记) 显示在错误窗体中。 此验证仅由客户端处理(数据库始终允许所有用户自定义的字段为 NULL)。
RestrictedMode 可选属性,类型为 Boolean。如果为 TRUE,则不允许 Note 字段包含增强的格式文本格式(例如图片、表或超链接),也不允许将格式化文本粘贴到此字段。
ResultType 可选属性,类型为 Text。 指定从字段返回的值的数据类型。
RichText 可选属性,类型为 Boolean。 如果字段显示格式文本格式,则为 TRUE
RichTextMode 可选 文本RichTextMode 枚举中的选项之一。
RowOrdinal 可选属性,类型为 Integer。 指定字段的数据库位置。
密封 可选属性,类型为 Boolean。 对于将该字段标记为不可删除字段的字段,将此属性设置为 TRUE。 “更改栏”页中没有“删除”按钮。 用户无法删除该字段。
SeparateLine 可选属性,类型为 Boolean。 在内部用于支持呈现字段 (,例如,备注或注释) 在单独的行中。 此属性不是为公共使用而设计的。
SetAs 不应从代码中直接使用。
ShowAddressBookButton 不应从代码中直接使用。
ShowField 可选属性,类型为 Text。当 Type 属性是“查阅”时,ShowField 属性指定要查阅的目标字段的名称。如果未指定值,则将显示来自目标列表中记录的“标题”字段的超链接文本。

以下字段类型允许用作查阅字段的目标字段:CounterDateTimeNumberText。 如果启用了查阅,则 Computed 字段类型可用作目标字段。 有关详细信息,请参阅 SPFieldComputed 类的 EnableLookup 属性。 如果输出是文本,则 Calculated 字段类型可用作目标字段。 有关详细信息,请参阅 SPFieldCalculated** 类的 OutputType 属性。

ShowInDisplayForm 可选属性,类型为 Boolean。 若要在表单中显示字段以查看项目,则为 TRUE
ShowInEditForm 可选属性,类型为 Boolean。 若要在表单中显示字段以编辑项目,则为 TRUE
ShowInFileDlg 可选属性,类型为 Boolean。此属性仅对于文档库架构中的字段有效。如果为 FALSE,则字段不会在用于保存表单的属性对话框(从客户端应用程序保存表单时出现)中显示。例如,由于此属性是直接在要保存到文档库的文档中设置的,因此 Title 字段具有此属性。
ShowInListSettings 可选属性,类型为 Boolean。 若要页上显示列以用于自定义列表设置,则为 TRUE
ShowInNewForm 可选属性,类型为 Boolean。如果为 FALSE,则当显示模式设置为 New 时,字段不会出现在 Fields 枚举中。具有此设置的字段不会出现在给定列表的默认“新建项目”页中。具体而言,可以在用于将文档上载到文档库的页上隐藏字段。
ShowInVersionHistory 可选属性,类型为 Boolean。 若要在页上显示列以查看列表项版本,则为 TRUE
ShowInViewForms 可选属性,类型为 Boolean。 选择 TRUE 可指定字段显示在用于查看列表数据的页面中。
可排序 可选属性,类型为 Boolean。 如果可以对字段中的值进行排序,则为 TRUE
SourceID 可选 文本。 包含定义字段的命名空间,例如 http://schemas.microsoft.com/sharepoint/v3 创建自定义字段的列表的 GUID。
StaticName 可选属性,类型为 Text。 包含可能在字段集中不是唯一的字段内部名称。 但是,与可能会被修改以确保其唯一性的 Name 属性不同,StaticName 属性的值会按照您的定义准确分配到该字段。 稍后可以通过调用 TryGetFieldByStaticName 方法在代码中使用此值来获取对字段的引用。
StorageTZ 指定如何存储日期/时间值。当 StorageTZ 设置为 UTC 时,将日期/时间作为协调世界时 (UTC) 处理。若要指示一个引用“抽象”时间的日期/时间值,也就是说在用户输入日期/时间时将其存储到数据库中,而不进行本地时区转换或存储,请忽略 StorageTZ 属性。
StripWS 可选属性,类型为 Boolean。 如果从字段值的开头和结尾移除空白,则为 TRUE
SuppressNameDisplay 可选属性,类型为 Boolean。 若要在 User 字段中不显示用户名,则为 TRUE
TextOnly 可选属性,类型为 Boolean。 如果为 TRUE,则字段仅可以包含 Text 值。
标题 可选属性,类型为 Text。 包含用户界面中显示的字段的标题。
类型 必需 文本。 字段的数据类型(除非 Field 元素是 ProjectedFields 的子集)。

注意:在 Microsoft SharePoint Foundation 2010 的 Technical Preview 版本中,Type 属性具有不同的含义,只有一个可能的值 (“Lookup”) 当它是 ProjectedFields 的子级时。 有关此 类型 使用的详细信息,请参阅 ProjectedFields 元素 (视图)

默认情况下,SharePoint Foundation 包括以下数据类型:

  • AllDayEvent:指定全天事件。 对应于 SQL 数据类型。
  • 附件:存储附件的 URL。 对应于 SQL 数据类型。
  • 布尔值:用于将存储在数据库中的 TRUE/FALSE 值 (存储为 0 或 1) 。 此字段可排序且可分组。 对应于 BIT SQL 数据类型,由 SPFieldBoolean 类表示。
  • 计算:指定根据其他列计算其值的字段。 对应于 SQL_VARIANT SQL 数据类型,由 SPFieldCalculated** 类表示。
  • 选择:允许用户指定一组预先确定的值,这些值可用于将数据输入到字段中。 “选择”和 “查找”类型是排序和分组最重要的字段。 BaseTypeFormat 属性可用于选择字段。 此字段可排序且可分组。 为选择选项提供值时,该值将用作字段选择的提交值。 如果未给出任何值,则会将该选择作为所选的文本值提交。 在所有情况下,所选的文本值都是 UI (下拉列表或单选按钮文本) 中显示的内容。 在编辑 UI 中显示选项的顺序始终是 在 CHOICES 元素中指定项的顺序。 使用 MultiChoice 类型指定实现复选框并允许用户选择多个值 的“选择 ”字段。 对应于 nvarchar SQL 数据类型并表示 SPFieldChoice 类。
  • 计算:指定依赖于另一个字段的内容的字段。 例如, LinkTitleNoMenu 字段等于使用超链接围绕标题字段值。 由 SPFieldComputed 类表示
  • ContentTypeId:包含内容类型 ID。 有关内容类型 ID 的格式的信息,请参阅Content Type IDs。 对应于 varbinary SQL 数据类型。
  • 计数器:通常仅用于内部 ID 字段。 对于当前列表中的所有其他项,其整数值自动设置为唯一。 计数器 类型始终是只读的,不能通过窗体帖子进行设置。 此字段是可排序的,但不可分组。 对应于 int SQL 数据类型。
  • CrossProjectLink:用于将 SharePoint 列表中的事件与会议工作区网站连接;具体是指“新建”和“编辑项目”窗体中用于为项目创建会议工作区网站的复选框的字段类型。 对应于 BIT SQL 数据类型,由 SPFieldCrossProjectLink 类表示。
  • 货币:允许输入货币值。 每个货币字段都与特定区域设置的货币相关。 在所有其他方面,它被视为 数字 字段类型。 使用 LCID 属性指示特定区域设置的货币。 小 最大 值和 最小 值属性可用于货币类型。 此字段可排序且可分组。 对应于 浮点 SQL 数据类型,由 SPFieldCurrency 类表示。
  • DateTime:允许存储完全限定的日期或一天中的时间。 使用 Format 属性指定日期格式,并使用 StorageTZ 属性确定日期/时间值的存储方式。 此字段可排序且可分组。 对于显示模式,日期格式的顺序派生自区域设置 (“M/D/Y”或“D/M/Y”) 。 在“编辑”模式 (或 默认 元素值) 的新模式下,日期/时间以通用格式呈现:M/D/Y hh:mm am/pm。 对应于 日期时间 SQL 数据类型并表示 SPFieldDateTime 类。
  • 文件:包含文件。 对应于 uniqueidentifier SQL 数据类型。
  • GridChoice:包含调查分级比例。 对应于 ntext SQL 数据类型,并由 SPFieldRatingScale 类表示。
  • Guid:允许全局唯一标识符 (GUID) 。 对应于 uniqueidentifier SQL 数据类型。
  • 整数:允许正整数或负整数值。 逗号NegativeFormat 属性用于指定整数格式。 对应于 int SQL 数据类型。
  • 查阅:行为与 “选择 ”字段非常相似,只是可用选项来自另一个列表,而不是硬编码的值选择。 ListShowField 属性可用于查阅字段。 此字段可排序且可分组。 对于排序和分组,默认情况下,使用 DisplayField 值 (Title,而不是存储在列表中的外键) 。 对应于 INt SQL 数据类型,由 SPFieldLookup 类表示。
  • LookupMulti:一个可包含多个值 的查阅 字段。 父类型: 查找
  • ModStat:包含内容审批状态。 可能的值包括已 批准 的 (默认) 、 已拒绝挂起 (分别存储在数据库中的 0、1 或 2,) 。 对应于 int SQL 数据类型。
  • MultiChoice:指定实现复选框并允许用户选择多个值 的“选择 ”字段。 对应于由 SPFieldMultiChoice 类表示的 ntext SQL 数据类型。
  • MultiColumn:一个 注释 字段,用于模拟包含多个值的字段。 有关多列字段类型的示例,请参阅 自定义字段类型定义。 有关多列字段的信息,请参阅 自定义多列字段类。 父类型: 注意
  • 注意:允许用户输入多行文本。 此字段不可排序或可分组。 所有文本都定义为不带 HTML 标记的直 ASCII 字符。 任何类似于 HTML 标记或 URL 的内容都只是引用 (例如,Server.HTMLEncode) 类似于直文本。 用于编辑此格式的控件是一个简单的 TEXTAREA 块。 使用 NumLines 属性指定要显示的行数。 对应于 ntext SQL 数据类型,由 SPFieldMultiLineText 类表示。
  • 数字:允许输入浮点数。 此字段可排序且可分组。 输入的数字根据小数点和千分隔符的当前区域设置进行分析。 可以通过将负数包装在括号中或使用负号来指示负数。 以下属性可与 Number 属性结合使用,以指定数字格式: DecimalsDivMaxMinMultPercentage。 对应于 浮点 SQL 数据类型,并由 SPFieldNumber 类表示
  • PageSeparator:在调查列表中插入分页符。 由 SPFieldPageSeparator 类表示。
  • 重复性:用于编辑和定义事件列表中项的重复模式。 对应于 SQL 数据类型。
  • 文本:在编辑框中输入的单行文本。 此字段可排序且可分组。 使用 MaxLength 属性设置允许的最大字符数。 对应于 nvarchar SQL 数据类型,并由 SPFieldText 类表示。
  • ThreadIndex:包含指示会话线程中消息相对位置的 ID。 对应于 varbinary SQL 数据类型。
  • 线程线程字 段类型用于创建和显示线程式讨论式视图。 任何列表都可以包含线程列,但使用时会生成特殊 UI。 (它永远不会显示为窗体中的标准可编辑字段或视图中的普通列。) 如果对线程字段执行排序,则返回父子关系中所有记录的预购遍历。 这是通过保存特定记录的所有父记录的创建日期和 ID 号的串联来实现的。 对应于 varchar SQL 数据类型。
  • URL:用于创建自由格式超链接。 URL 字段显示为 “说明”。 如果未给出说明,则显示为 URL。 URL 文本本身存储在 URL (DocMd) 表中,该表将 SharePoint 数据库中的所有 URL 存储在服务器上。 这样做是为了在目标移动时通过链接修复更新服务器上本地的任何 URL。 删除包含 URL 字段的记录时,也会删除 URL 表中的相应引用记录。 此字段可排序且可分组。 (排序是根据文本说明而不是 URL 的内容定义的;如果未给出说明,则其排序方式与 blank.) 当 类型URL 时, LinkType 属性可用于指定链接的类型。 对应于 nvarchar SQL 数据类型,并由 SPFieldUrl 类表示。
  • 用户:引用 UserInfo 数据库表的 查阅 字段。 对应于 int SQL 数据类型,由 SPFieldUser 类表示。
  • UserMulti:一个可以包含多个值的 用户 字段。 父类型: LookupMulti
  • WorkflowEventType:指定 由 SPWorkflowHistoryEventType 枚举表示的工作流事件类型。 父类型: 整数
  • WorkflowStatus:指定 由 SPWorkflowStatus 枚举表示的工作流状态。 对应于 nvarchar SQL 数据类型。
UniqueId 可选属性,类型为 Text。 不应从代码中直接使用。
UnlimitedLengthInDocumentLibrary 可选属性,类型为 Boolean。 若要允许文档库中的字段长度不受限制,则为 TRUE
URLEncode 可选属性,类型为 Boolean。 如果为 TRUE,则将特殊字符(如空格)转换为引用的 UTF-8 格式(例如,%c3%ab 表示字符 ë)。
URLEncodeAsURL 可选属性,类型为 Boolean。与 URLEncode 类似,但如果为 TRUE,则指定要编码的字符串为 URL 的路径部分,以便不对左斜线(“/”)进行编码。
UserSelectionMode 可选属性,类型为 Text。指定是只能在项目表单上的用户字段中选择单个用户的名称,还是可以同时选择个人和组的名称。可能的值包括:
  • 0:只能选择个人的姓名。
  • 1:可以选择个人和组的名称。
UserSelectionScope 可选属性,类型为 Integer。指定一个范围,以便在项目表单上的用户字段中选择用户名。如果值为 0,则对 SharePoint 组没有限制。如果值大于 0,则用户选择仅限于其 ID 等于指定值的 SharePoint 组的成员。
可见 可选属性,类型为 Boolean。 若要指定将字段添加到默认视图中,则为 TRUE。 默认值为 TRUE
Width 可选属性,类型为 Integer。 指定为用户信息列表中的用户显示的图像的宽度(以像素为单位)。
WikiLinking 可选属性,类型为 Boolean如果 要指定 wiki 链接(以双括号的形式显示 ([[...]]) ,则为 TRUE,将其转换为使用标记的 <a> HTML 链接。
XName 可选属性,类型为 Text。在 XML 表单内部使用以标识已添加、删除或修改的字段。此属性不是公共属性。

子元素

父元素

备注

重要

定义自定义字段时,必须指定该字段的 ID、类型、名称、DisplayName 和组属性才能在 Microsoft SharePoint Foundation 中正确显示。 Microsoft Visual Studio 中的语句完成错误表明,实际上需要这五个属性时,只需要前三个属性。

示例

下面的示例演示用于创建三个网站栏的功能对应的元素清单。

<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="http://schemas.microsoft.com/sharepoint/">
  <Field ID="{060E50AC-E9C1-4D3C-B1F9-DE0BCAC300F6}"
          Name="Amount"
          DisplayName="Amount"
          Type="Currency"
          Decimals="2"
          Min="0"
          Required="FALSE"
          Group="Financial Columns" />

  <Field ID="{943E7530-5E2B-4C02-8259-CCD93A9ECB18}"
          Name="CostCenter"
          DisplayName="Cost Center"
          Type="Choice"
          Required="FALSE"
          Group="Financial Columns">
    <CHOICES>
      <CHOICE>Administration</CHOICE>
      <CHOICE>Information</CHOICE>
      <CHOICE>Facilities</CHOICE>
      <CHOICE>Operations</CHOICE>
      <CHOICE>Sales</CHOICE>
      <CHOICE>Marketing</CHOICE>
    </CHOICES>
  </Field>

  <Field ID="{1511BF28-A787-4061-B2E1-71F64CC93FD5}"
          Name="DateOpened"
          DisplayName="Date Opened"
          Type="DateTime"
          Format="DateOnly"
          Required="FALSE"
          Group="Financial Columns">
    <Default>[today]</Default>
  </Field>
</Elements>

另请参阅