Field, élément (types de champs)

Windows SharePoint Services 3

Représente une caractéristique du type de champ.


<Field
  Name="Text">
</Field>

Attribut Description

Name

Valeur de type Text 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 correspondre à l'une des chaînes répertoriées dans le tableau ci-après.

Les enfants de l'élément Field des éléments FieldType sont configurés dans les fichiers fldtypes*.xml situés dans C:\Program Files\Common Files\Microsoft Shared\web server extensions\12\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 Windows SharePoint Services 3.0, un type de champ est représenté par la classe SPFieldTypeDefinition. Cette classe possède une propriété en lecture seule qui correspond à toutes les lignes du tableau, à l'exception de deux. (Ces 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 Name de l'élément Field Description

AllowBaseTypeRendering

Valeur de type Boolean facultative. La valeur par défaut est FALSE. Indique si une application cliente rend le champ sous la forme de son type de base (appelé également ParentType), si l'application cliente ne peut pas déterminer comment rendre correctement le type de champ personnalisé. Si la valeur est TRUE, et que l'application cliente ne peut pas rendre correctement le type de champ personnalisé, l'application cliente rend le champ en tant que type de champ parent Windows SharePoint Services par défaut à partir duquel elle hérite.

FieldTypeClass

Valeur de type String facultative, mais obligatoire pour tous les types de champs personnalisés. Représente le nom fort de la bibliothèque de classes de type de champ. "FieldTypeClass" comprend le nom de la classe et celui 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 de classe complet est inclus pour les types de champs intégrés dans Windows SharePoint Services 3.0.)

FieldEditorUserControl

Valeur de type String facultative. Représente le chemin d'accès relatif à un fichier type_champFieldEditor.ascx qui définit un contrôle affiché dans Windows SharePoint Services 3.0, dans la section Paramètres de colonne supplémentaires de la page Nouvelle colonne de site. Ce contrôle permet aux créateurs de colonnes de définir les propriétés variables du type de champ pour une colonne particulière (par exemple, "/_controltemplates/RegularExpressionFieldEditor.ascx"). S'il n'existe aucun élément <Field Name="FieldEditorUserControl">, les propriétés spéciales du type de champ sont rendues par l'élément PropertySchema, élément (Types de champs).

FieldEditorUserControl doit être une chaîne fixe, non localisable.

Filterable

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

Valeur de type String facultative. Représente un type de base interne. N'utilisez pas uné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 celles de l'attribut Type de l'élément Field, élément (List - Definition). 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>. 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 Windows SharePoint Services 3.0, ParentType est appelé BaseRenderingTypeName.

ShowOnListAuthoringPages

Valeur de type Boolean facultative. 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, Windows SharePoint Services affiche ce type de champ sur les pages de création de listes afin que les utilisateurs puissent inclure le type de champ dans leurs listes.

Dans le modèle objet Windows SharePoint Services 3.0, ShowOnListAuthoringPages est appelé ShowOnListCreate.

ShowOnDocumentLibraryAuthoringPages

Valeur de type Boolean facultative. 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, Windows SharePoint Services affiche ce type de champ dans 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 Windows SharePoint Services 3.0, ShowOnDocumentLibraryAuthoringPages est appelé ShowOnDocumentLibraryCreate.

ShowOnSurveyAuthoringPages

Valeur de type Boolean facultative. 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, Windows SharePoint Services affiche ce type de champ dans 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 Windows SharePoint Services 3.0, ShowOnSurveyAuthoringPages est appelé ShowOnSurveyCreate.

ShowOnColumnTemplateAuthoringPages

Valeur de type Boolean facultative. 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, Windows SharePoint Services affiche ce type de champ sur les pages de création de modèles de colonne afin que les utilisateurs puissent sélectionner et créer un modèle de colonne de ce type de champ.

Dans le modèle objet Windows SharePoint Services 3.0, ShowOnColumnTemplateAuthoringPages est appelé ShowOnColumnTemplateCreate.

SQLType

Valeur de type String facultative. Représente le type de données SQL qui sera utilisé pour stocker les données dans la base de données de contenu. N'utilisez pas un élément <Field Name="SQLType"> dans vos définitions de type de champ personnalisé.

Sortable

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

Valeur de type String obligatoire. Représente le nom complet du type de champ dans l'interface utilisateur (IU). Dans Windows SharePoint Services 3.0, il apparaît dans la colonne Type de la page Personnaliser [la liste] (listedit.aspx). Il est également utilisé à la place de "TypeShortDescription", si cette chaîne n'est pas présente.

" TypeDisplayName " doit être une chaîne localisable.

TypeName

Valeur 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, non localisable.

TypeShortDescription

Valeur de type String facultative. Représente la description succincte du type de champ affichée dans l'interface utilisateur. Dans Windows SharePoint Services 3.0, elle figure avec une case d'option dans la section Nom et type des pages Nouvelle colonne de site et Créer une colonne, ainsi que dans la colonne Type de la Galerie des colonnes de sites. S'il n'existe aucun élément <Field Name="TypeShortDescription">, "TypeDisplayName" est utilisé.

" TypeShortDescription " doit être une chaîne localisable.

UserCreatable

Valeur de type Boolean facultative. La valeur par défaut est TRUE, ce qui permet aux utilisateurs d'ajouter des champs de ce type aux listes. Attribuer la valeur FALSE permet l'utilisation du 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.

Le code exemple suivant définit un type de champ personnalisé.

  <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>
Afficher: