SPField class

包:

@microsoft/sp-page-context

字段表示 SharePoint 列表视图中列的数据模型。

注解

这是 SharePoint SPField 类的客户端等效项。 它与包一 @microsoft/sp-listview-extensibility 起使用。

此类的构造函数标记为内部。 第三方代码不应直接调用构造函数或创建扩展类的 SPField 子类。

属性

clientSideComponentId	与字段关联的客户端组件的唯一标识符。
clientSideComponentProperties	仅当指定 时 ClientSideComponentId ，才使用此属性。 它是可选的。
displayName	字段的显示名称。 此名称在 UI 中显示为列名。
fieldType	表示为字符串的字段的类型
id	此字段的 GUID 标识符。
internalName	字段的内部名称。 此名称通常用于查找字段。
isRequired	列表中的每个列表项是否都需要字段

属性详细信息

clientSideComponentId

与字段关联的客户端组件的唯一标识符。

readonly clientSideComponentId: Guid | undefined;

属性值

Guid | undefined

clientSideComponentProperties

仅当指定 时 ClientSideComponentId ，才使用此属性。 它是可选的。

readonly clientSideComponentProperties: string;

属性值

string

注解

如果为非空，则字符串必须包含具有自定义初始化属性的 JSON 对象，其格式和含义由客户端组件定义。

displayName

字段的显示名称。 此名称在 UI 中显示为列名。

readonly displayName: string;

属性值

string

fieldType

表示为字符串的字段的类型

readonly fieldType: string;

属性值

string

id

此字段的 GUID 标识符。

readonly id: Guid;

属性值

Guid

internalName

字段的内部名称。 此名称通常用于查找字段。

readonly internalName: string;

属性值

string

isRequired

列表中的每个列表项是否都需要字段

readonly isRequired: boolean;

属性值

boolean