SPField 成员
代表SharePoint Foundation Web 网站上的列表中的字段。
SPField 类型公开以下成员。
构造函数
名称 | 说明 | |
---|---|---|
SPField(SPFieldCollection, String) | 初始化基于指定的字段集合对象和字段名称的SPField类的新实例。 | |
SPField(SPFieldCollection, String, String) | 初始化基于指定的字段集合对象、 字段类型和字段名称的SPField类的新实例。 |
页首
属性
名称 | 说明 | |
---|---|---|
AggregationFunction | 获取或设置字段的聚合函数。 | |
AllowDeletion | 获取或设置一个 Boolean 值,指定是否可以删除该字段。 | |
AuthoringInfo | 获取用于在页面中编辑字段来确定该字段和其用途的描述性字符串。 | |
CalloutMenu | 获取或设置相对值的指示字段是否显示标注菜单上的链接。 | |
CalloutMenuAllowed | 获取或设置相对值的指示是否显示标注菜单上,在字段中允许,禁止,或者是可选的由CalloutMenu属性。 | |
CanBeDeleted | 获取一个 Boolean 值,该值指示是否可以删除该字段。 | |
CanBeDisplayedInEditForm | 只读属性,指示可以编辑表单中显示该字段。 | |
CanToggleHidden | 获取一个布尔值,指示是否可以通过用户界面隐藏列。 | |
CompositeIndexable | 指示字段是否及参与容量可以参与复合索引。 | |
DefaultFormula | 获取或设置一个计算字段的默认公式。 | |
DefaultListField | 获取一个值,指示是否在上载到文档库时显示文件的属性窗体。 | |
DefaultValue | 获取或设置字段的默认值。 | |
DefaultValueTyped | 获取基于字段类型的默认值对象。 | |
Description | 获取或设置字段的说明。 | |
DescriptionResource | 获取一个代表的字段的说明翻译的SPUserResource对象。 | |
Direction | 获取或设置字段的阅读次序的方向。 | |
DisplaySize | 获取或设置字段的显示大小。 | |
EnforceUniqueValues | 获取或设置一个 Boolean 值,它指定是否在列值中强制唯一性。默认值为false。 | |
EntityPropertyName | 获取使用此字段的列表项实体的实体属性的名称。 | |
FieldReferences | 获取包含在计算字段引用的字段的内部名称的字符串数组。 | |
FieldRenderingControl | 获取用于呈现显示、 编辑和新建表单中的字段,以及在数据表单 Web 部件的字段类型控件或使用字段控件的页面。 | |
FieldRenderingMobileControl | 已过时。不建议使用。请改用FieldRenderingMobileWebControl属性。获取用于呈现显示、 编辑和新建表单数据表单 Web 部件或在移动应用程序中使用字段控件的任何页面中的字段的移动字段类型控件。 | |
FieldRenderingMobileWebControl | 派生类中实现时,用于呈现的字段中显示,编辑的获取移动字段类型控件和新的表单、 数据表单 Web 部件或使用字段控件的任何页面。 | |
FieldTypeDefinition | 获取一个代表该字段的字段类型定义的SPFieldTypeDefinition对象。 | |
FieldValueType | 获取字段的值类型时字段类型都有其自己的值类型。 | |
Filterable | 获取一个布尔值,该值指示是否可以筛选字段。 | |
FilterableNoRecurrence | 获取一个 Boolean 值,该值指示是否可以在不会展开定期事件的视图中的字段上创建一个筛选器。 | |
FromBaseType | 获取一个 Boolean 值,该值指示字段是否派生自基字段类型。 | |
Group | 获取或设置字段所属列组。 | |
Hidden | 获取或设置一个 Boolean 值,指定是否在列表中显示该字段。 | |
Id | 获取字段的 GUID。 | |
IMEMode | 获取或设置要用于该字段输入法编辑器 (IME) 模式斜线。输入法允许转换的键击语言当一个书写系统具有比可为给定的键盘编码的多个字符之间。 | |
Indexable | 指示字段可以或不进行索引的只读属性。 | |
Indexed | 获取或设置一个布尔值,该值指定字段是否编入索引。 | |
InternalName | 获取用于表示的字段的内部名称。 | |
JSLink | 派生类中实现时,获取或设置外部JavaScript文件的名称 (或一组由分隔的文件"|"字符),其中包含派生类型的字段的任何客户端呈现逻辑。 | |
JumpToField | 获取一个代表下一个问题到用户执行的调查,具体取决于他们授予当前问题的答案字段的名称。 | |
LinkToItem | 获取或设置相对值的指示字段是否应显示列表项的显示表单时显示在列表视图的链接。 | |
LinkToItemAllowed | 获取或设置相对值的指示是否字段中,在列表视图中,可以显示列表项的显示表单的链接。 | |
ListItemMenu | 获取或设置相对值的指示字段是否应显示列表项的下拉列表菜单时显示在列表视图的链接。 | |
ListItemMenuAllowed | 获取或设置相对值的指示是否字段中,在列表视图中,可以显示列表项的下拉菜单的链接。 | |
NoCrawl | 获取或设置一个 Boolean 值,指定该字段是否可由搜索引擎爬网。 | |
ParentList | 获取包含字段的父列表。 | |
PIAttribute | 获取或设置该属性在文档处理指令 ( PITarget属性指定) 用作进行属性升级和降级 XML 文档中的列的值。 | |
PITarget | 获取或设置处理的指令中的列的值存储在用于属性升级和降级 XML 文档中的指定内容类型的文档中的文档。 | |
PreviewValueTyped | 没有与字段关联的列表项数据时,显示和编辑模式中的字段控件的设计时间视图获取字段数据的预览值。 | |
PrimaryPIAttribute | 获取或设置处理指令, PrimaryPITarget属性,用作列值中属性升级和降级 XML 文档中的指定文档中的备用属性。 | |
PrimaryPITarget | 获取或设置替代文档处理的指令中的列的值存储的指定内容类型的文档。 | |
PushChangesToLists | 获取或设置一个 Boolean 值,它指定是否将传播到实现该字段的列表中的字段模板进行的更改。 | |
ReadOnlyField | 获取或设置一个 Boolean 值,指定是否可以修改字段中的值。 | |
RelatedField | 获取或设置与相关的当前字段的字段的内部名称。 | |
Reorderable | 获取一个 Boolean 值,该值指示是否可以重新排序字段中的值。 | |
Required | 获取或设置一个 Boolean 值,确定用户是否必须输入一个值的字段在New和Edit表单上。 | |
SchemaXml | 获取或设置字段定义架构。 | |
SchemaXmlWithResourceTokens | 当响应来自服务器时初始化作用域属性。 | |
Scope | 获取在其中使用的字段集合的列表的相对于网站的路径。 | |
Sealed | 获取一个值,指示Microsoft SharePoint Foundation (按照Type属性中指定) 的字段类型是否可以为派生的自定义字段类型的父对象。 | |
ShowInDisplayForm | 获取或设置一个 Boolean 值,指定是否显示列表项的表单中显示该字段。 | |
ShowInEditForm | 获取或设置一个 Boolean 值,指定是否用于编辑列表项的窗体中显示该字段。 | |
ShowInListSettings | 获取或设置一个 Boolean 值,指定该字段是否显示在自定义列表设置页。 | |
ShowInNewForm | 获取或设置一个 Boolean 值,指定是否用来创建列表项的窗体中显示该字段。 | |
ShowInVersionHistory | 获取或设置一个 Boolean 值,指定该字段是否显示在查看列表项版本页。 | |
ShowInViewForms | 获取或设置一个 Boolean 值,指定是否用于查看列表数据的页面中显示该字段。 | |
Sortable | 获取一个 Boolean 值,确定是否可按字段进行排序。 | |
SourceId | 获取定义的内置字段的任一的命名空间或其自定义字段中,标识的列表或创建它的网站的 GUID。 | |
StaticName | 获取或设置字段的静态名称。 | |
Title | 获取或设置字段的显示名称。 | |
TitleResource | 获取与该字段的显示名称相关联的资源对象。 | |
TranslationXml | 已存储在多语言数据库中为显示为 XML 文档的文档内容。 | |
Type | 获取或设置字段的类型。 | |
TypeAsString | 获取一个 string 值形式的字段的类型。 | |
TypeDisplayName | 获取字段类型的显示名称。 | |
TypeShortDescription | 获取字段的说明。 | |
UsedInWebContentTypes | 获取一个布尔值,该值指示是否在网站集中使用的任何内容类型中实现该字段。 | |
ValidationEcmaScript | 获取对应于该字段的验证公式ECMAScript函数。 | |
ValidationFormula | 指示字段引用的公式,并添加或更新列表项时进行求值。 | |
ValidationMessage | 获取或设置要对此字段验证失败时向用户显示的消息。 | |
Version | 获取字段的版本。 | |
XPath | 获取或设置到的字段的 XPath 表达式。 |
页首
方法
名称 | 说明 | |
---|---|---|
AnnotateField | 当在某个派生类中重写,将属性添加到指定的 XML 节点,并将其分配此SPField对象的属性的值。 | |
Delete | 删除字段。 | |
Equals | (从 Object 继承。) | |
Finalize | (从 Object 继承。) | |
GetCustomProperty | 获取具有指定名称的自定义属性的值。 | |
GetFieldValue | 将指定的值转换为字段类型值。 | |
GetFieldValueAsHtml | 获取字段值以 HTML 格式,以便呈现直接在页面上的字段值。 | |
GetFieldValueAsText | 获取为纯文本的字段值。 | |
GetFieldValueForClientRender | 当在某个派生类中重写,将字段类型值转换为在客户端显示、 编辑和新项表单中使用的对象。 | |
GetFieldValueForEdit | 获取呈现处于编辑模式编辑和新建表单中的字段值。 | |
GetHashCode | (从 Object 继承。) | |
GetJsonClientFormFieldSchema | 当在某个派生类中重写,获取一个对象,该对象包含可用于客户端的字段的架构中的信息呈现表单中的字段。 | |
GetProperty | 获取指定的属性的值。 | |
GetType | (从 Object 继承。) | |
GetValidatedString | 验证并将该字段值转换为序列化的窗体。 | |
HasValue | 用于验证对象是否为 null 的内部函数。 | |
ListsFieldUsedIn | 返回有关当前字段在其中使用网站和列表的信息。 | |
MemberwiseClone | (从 Object 继承。) | |
OnAdded | 处理添加域之后,发生此事件的事件。 | |
OnAddingToContentType | 处理字段添加到指定的内容类型时,发生此事件的事件。 | |
OnDeleting | 处理正在删除字段时发生的事件。 | |
OnDeletingFromContentType | 处理从指定的内容类型中删除字段时发生的事件。 | |
OnInitFieldNode | 此成员仅供内部使用,不能直接在您的代码中使用。 | |
OnUpdated | 处理对字段进行更改之后,发生此事件的事件。 | |
ParseAndSetValue | 当在某个派生类中重写,设置的指定的字段项为指定的值。 | |
ParseValue | 当在某个派生类中重写,分析字段的潜在值并返回一个 object,可以指定为字段的值。 | |
RenderFieldValueAsJson | 当在某个派生类中重写,以 JSON 格式返回指定的value 。 | |
RevertCustomizations | 恢复对字段架构所做的自定义项。 | |
SetCustomProperty | 设置指定的属性的值。 | |
ToString | 返回字段的标题。 (覆盖 Object.ToString()。) | |
Update() | 对字段进行的更改更新数据库。 | |
Update(Boolean) | 对字段进行的更改更新数据库和 (可选) 将更改传播到实现该字段的列表。 | |
ValidateAndParseValue | 当在某个派生类中重写,验证并分析输入的value并返回一个有效的对象,它可以是字段的值。 | |
ValidateParseAndSetValue | 调用ValidateAndParseValue(SPListItem, String)并将返回的对象分配作为字段的值。 |
页首