SPField class

Paquet:

@microsoft/sp-page-context

Un champ représente le modèle de données d’une colonne en mode liste SharePoint.

Remarques

Il s’agit de l’équivalent côté client pour la classe SharePoint SPField . Il est utilisé avec le @microsoft/sp-listview-extensibility package.

Le constructeur de cette classe est marqué comme interne. Le code tiers ne doit pas appeler directement le constructeur ou créer des sous-classes qui étendent la SPField classe.

Propriétés

clientSideComponentId	Identificateur unique du composant côté client associé au champ.
clientSideComponentProperties	Cette propriété est utilisée uniquement quand un ClientSideComponentId est spécifié. Elle est facultative.
displayName	Nom complet du champ. Ce nom est affiché sous forme de nom de colonne dans l’interface utilisateur.
fieldType	Type du champ représenté sous forme de chaîne
id	Identificateur GUID de ce champ.
internalName	Nom interne du champ. Ce nom est généralement utilisé pour rechercher le champ.
isRequired	Indique si le champ est requis pour chaque élément de liste de la liste

Détails de la propriété

clientSideComponentId

Identificateur unique du composant côté client associé au champ.

readonly clientSideComponentId: Guid | undefined;

Valeur de propriété

Guid | undefined

clientSideComponentProperties

Cette propriété est utilisée uniquement quand un ClientSideComponentId est spécifié. Elle est facultative.

readonly clientSideComponentProperties: string;

Valeur de propriété

string

Remarques

Si elle n’est pas vide, la chaîne doit contenir un objet JSON avec des propriétés d’initialisation personnalisées dont le format et la signification sont définis par le composant côté client.

displayName

Nom complet du champ. Ce nom est affiché sous forme de nom de colonne dans l’interface utilisateur.

readonly displayName: string;

Valeur de propriété

string

fieldType

Type du champ représenté sous forme de chaîne

readonly fieldType: string;

Valeur de propriété

string

id

Identificateur GUID de ce champ.

readonly id: Guid;

Valeur de propriété

Guid

internalName

Nom interne du champ. Ce nom est généralement utilisé pour rechercher le champ.

readonly internalName: string;

Valeur de propriété

string

isRequired

Indique si le champ est requis pour chaque élément de liste de la liste

readonly isRequired: boolean;

Valeur de propriété

boolean