Field, élément (Types de champs)
S’applique à : | SharePoint 2016 SharePoint Foundation 2013 | | SharePoint Online SharePoint Server 2013
Représente une caractéristique du type de champ.
<Field Name="Text"></Field>
Éléments et attributs
Les sections suivantes décrivent les attributs, les éléments enfants et les éléments parents.
Attributs
| Attribut | Description |
|---|---|
| Name | Texte obligatoire. Chaîne qui représente le nom de l'aspect spécifique du type de champ, représenté par l'élément Field. La valeur doit être l’une des chaînes répertoriées dans le tableau sous Remarques. |
Éléments enfants
Aucun
Éléments parents
Remarques
Les enfants des éléments FieldType sont configurés dans les fichiers fldtypes*.xml dans %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\XML.
Chaque élément FieldType possède plusieurs éléments Field obligatoires et facultatifs, caractérisés par leur attribut Name. Le tableau ci-après décrit ces éléments. Dans le modèle objet, un type de champ est représenté par la classe SPFieldTypeDefinition . Cette dernière classe a une propriété en lecture seule correspondant à toutes les lignes de la table sauf deux (les exceptions sont InternalType et SQLType). Sauf indication contraire, les noms de propriété correspondent à la valeur de l'attribut Name correspondant.
Valeur de l’attribut de l’élément Name Field |
Description |
|---|---|
| AllowBaseTypeRendering | Facultatif Boolean. La valeur par défaut est FALSE. Spécifie si une application cliente affiche le champ en tant que type de base (également appelé ParentType), si l’application cliente ne peut pas déterminer comment afficher correctement le type de champ personnalisé. Si la valeur est TRUE et que l’application cliente ne peut pas afficher correctement le type de champ personnalisé, l’application cliente affiche le champ en tant que type de champ parent SharePoint Foundation par défaut dont elle hérite. |
| CAMLRendering | Facultatif Boolean. La valeur par défaut est FALSE. Spécifie si le champ est rendu sur les affichages de liste à l’aide du balisage CAML dans un élément RenderPattern ailleurs dans l’élément FieldType parent. La valeur par défaut FALSE signifie que le champ est rendu sur les affichages de liste par une transformation XSL dans un fichier fldtypes*.xsl, qui est le système standard pour le rendu des champs sur les affichages de liste. (Toutefois, cet élément n’a aucun effet sur le rendu des champs sur les formulaires Display, New et Edit. Un RenderPattern est toujours la méthode standard de rendu du champ sur un formulaire d’affichage.) |
| FieldTypeClass | Chaîne facultative, mais obligatoire pour tous vos types de champs personnalisés. Représente le nom fort de la bibliothèque de classes de type de champ. FieldTypeClass inclut le nom de la classe et le nom de l’assembly avec Version, Culture et PublicKeyToken; par exemple :<Field Name="FieldTypeClass">CustomFieldTypes.RegularExpression.RegularExpressionField, CustomFieldTypes.RegularExpression, Version=1.0.0.0, Culture=neutral, PublicKeyToken=57e55365ec0ce80a</Field>Seul le nom complet de la classe est inclus pour les types de champs intégrés à SharePoint Foundation. |
| FieldEditorUserControl | Argument de type String facultatif. Représente le chemin d’accès relatif à un fichier FieldEditor.ascx field_type qui définit un contrôle qui apparaît dans SharePoint Foundation dans la section Paramètres de colonne supplémentaires de la page Nouvelle colonne de site . Le contrôle permet aux créateurs de colonne de définir, pour une colonne particulière, les propriétés de variable du type de champ. Par exemple : "/_controltemplates/RegularExpressionFieldEditor.ascx".S’il n’y a pas <Field Name="FieldEditorUserControl"> d’élément, les propriétés spéciales du type de champ sont rendues par l’élément PropertySchema (Types de champs).FieldEditorUserControl doit être une chaîne fixe, non localisable. |
| Filtrables | Valeur de type Boolean obligatoire. Indique si une liste avec une colonne basée sur ce type de champ peut être filtrée selon la valeur de la colonne qui utilise ce type. Si la valeur est TRUE, l'en-tête de la colonne est un contrôle que les utilisateurs peuvent utiliser pour filtrer la liste. |
| InternalType | Argument de type String facultatif. Représente un type de base interne. N’utilisez pas d’élément <Field Name="InternalType"> dans vos définitions de type de champ personnalisé. |
| ParentType | Valeur de type String obligatoire (mais la chaîne peut être vide). Représente le nom du type à partir duquel la classe de champ est dérivée. Les valeurs possibles sont exactement les mêmes que les valeurs possibles pour l’attribut Type de l’élément Field (List). Si le type de champ n’est pas dérivé d’un autre type, la valeur est une chaîne vide :<Field Name="ParentType"> </Field>. Il ne doit jamais être vide dans vos types de champs personnalisés. Tous les types personnalisés héritent d’un autre type.Dans le modèle objet SharePoint Foundation, ParentType est appelé BaseRenderingTypeName. |
| ShowOnListAuthoringPages | Facultatif Boolean. La valeur par défaut est TRUE. Indique si ce type de champ est affiché pour être inclus dans des listes. Si la valeur est TRUE, SharePoint Foundation affiche ce type de champ sur les pages de création de liste afin que les utilisateurs puissent inclure le type de champ dans leurs listes. Dans le modèle objet SharePoint Foundation, ShowOnListAuthoringPages est appelé ShowOnListCreate. |
| ShowOnDocumentLibraryAuthoringPages | Facultatif Boolean. La valeur par défaut est TRUE. Indique si ce type de champ est affiché pour l'inclusion dans des bibliothèques de documents. Si la valeur est TRUE, SharePoint Foundation affiche ce type de champ sur les pages de création de bibliothèques de documents afin que les utilisateurs puissent inclure le type de champ dans leurs bibliothèques de documents. Dans le modèle objet SharePoint Foundation, ShowOnDocumentLibraryAuthoringPages est appelé ShowOnDocumentLibraryCreate. |
| ShowOnSurveyAuthoringPages | Facultatif Boolean. La valeur par défaut est TRUE. Indique si ce type de champ est affiché pour l'inclusion dans les enquêtes. Si la valeur est TRUE, SharePoint Foundation affiche ce type de champ sur les pages de création d’enquêtes afin que les utilisateurs puissent inclure le type de champ dans leurs enquêtes. Dans le modèle objet SharePoint Foundation, ShowOnSurveyAuthoringPages est appelé ShowOnSurveyCreate. |
| ShowOnColumnTemplateAuthoringPages | Facultatif Boolean. La valeur par défaut est TRUE. Indique si ce type de champ doit être affiché comme type de champ de modèle de colonne. Si la valeur est TRUE, SharePoint Foundation affiche ce type de champ sur les pages de création de modèle de colonne afin que les utilisateurs puissent choisir de créer un modèle de colonne de ce type de champ. Dans le modèle objet SharePoint Foundation, ShowOnColumnTemplateAuthoringPages est appelé ShowOnColumnTemplateCreate. |
| SQLType | Argument de type String facultatif. Représente le type de données SQL utilisé pour stocker les données dans la base de données de contenu. N’utilisez pas d’élément <Field Name="SQLType"> dans vos définitions de type de champ personnalisé. |
| Triable | Valeur de type Boolean obligatoire. Indique si une liste avec une colonne basée sur ce type de champ peut être triée sur la colonne qui utilise ce type. Si la valeur est TRUE, l'en-tête de la colonne est un contrôle que les utilisateurs peuvent utiliser pour trier la liste. |
| TypeDisplayName | Argument de type String obligatoire. Représente le nom complet du type de champ dans l'interface utilisateur (IU). Dans SharePoint Foundation, il apparaît dans la colonne Type de la page Personnaliser [liste] (listit.aspx). Il est également utilisé à la place de TypeShortDescription si ce dernier n’est pas présent. TypeDisplayName doit être une chaîne localisable. |
| TypeName | Argument de type String obligatoire. Représente le nom du type de champ. Ce nom doit être unique parmi tous les noms de types de champs dans la batterie de serveurs SharePoint. TypeName doit être une chaîne fixe et non localisable. |
| TypeShortDescription | Argument de type String facultatif. Représente la description succincte du type de champ affichée dans l'interface utilisateur. Dans SharePoint Foundation, il apparaît avec une case d’option dans la section Nom et Type des pages Nouvelle colonne de site et Créer une colonne et dans la colonne Type de la galerie de colonnes de site. S’il n’y a pas <Field Name="TypeShortDescription"> d’élément, TypeDisplayName est utilisé.TypeShortDescription doit être une chaîne localisable. |
| UserCreatable | Facultatif Boolean. La valeur par défaut est TRUE, ce qui permet aux utilisateurs d’ajouter des champs de ce type à des listes. La définition de la valeur false permet d’utiliser le type de champ dans les schémas de liste, mais masque le type de champ aux utilisateurs dans la section Nom et Type des pages Nouvelle colonne de site et Créer une colonne . |
Exemple
Le code exemple suivant définit un type de champ personnalisé.
Importante
RenderPattern est obsolète. Il est présenté ici uniquement pour faciliter le débogage des champs personnalisés qui ont été initialement développés sur des versions antérieures de SharePoint Foundation.
<FieldType>
<Field Name="TypeName">SocialSecurityNumber</Field>
<Field Name="ParentType">Text</Field>
<Field Name="TypeDisplayName">Social Security Number</Field>
<Field Name="TypeShortDescription">Social Security Number (123456789, 123-45-6789)</Field>
<Field Name="AllowBaseTypeRendering">TRUE</Field>
<Field Name="FieldTypeClass">
AdventureWorks.FieldTypes.SPFieldSSN, AdventureWorks.FieldTypes.SPFieldSSN,
Version=1.0.0.0,Culture=neutral,PublicKeyToken=90734cc53324b79c
</Field>
<RenderPattern Name="DisplayPattern">
<Column HTMLEncode="TRUE" />
<Column HTMLEncode="TRUE" UseRelatedField="TRUE"/>
</RenderPattern>
</FieldType>