SPFieldCollection.Add - Méthode (String, SPFieldType, Boolean)

Crée un champ dans la collection en fonction du nom complet spécifié, un type de champ et une valeur Boolean.

Espace de noms :  Microsoft.SharePoint
Assembly :  Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Public Function Add ( _
    strDisplayName As String, _
    type As SPFieldType, _
    bRequired As Boolean _
) As String
'Utilisation
Dim instance As SPFieldCollection
Dim strDisplayName As String
Dim type As SPFieldType
Dim bRequired As Boolean
Dim returnValue As String

returnValue = instance.Add(strDisplayName, _
    type, bRequired)

public string Add(
    string strDisplayName,
    SPFieldType type,
    bool bRequired
)

Paramètres

• strDisplayName
  Type : System.String

  Chaîne qui spécifie le nom complet du champ.

• type
  Type : Microsoft.SharePoint.SPFieldType

  Une valeur SPFieldType qui spécifie le type du champ à créer.

• bRequired
  Type : System.Boolean

  true si le champ doit contenir une valeur ; dans le cas contraire, false.

Valeur renvoyée

Type : System.String
Chaîne qui contient le nom interne du nouveau champ.

Remarques

La méthode Add ne peut pas être utilisée pour créer un champ de type Lookup, car cela entraîne une SPException d'être levée. Au lieu de cela, utilisez la méthode AddLookup pour ajouter un champ de ce type.

Exemples

L'exemple de code suivant ajoute un champ de texte obligatoire à la liste spécifiée.

Dim webSite As SPWeb = SPContext.Current.Site.AllWebs("MySite")
Try
    Dim fields As SPFieldCollection = webSite.Lists("MyList").Fields

    fields.Add("MyField", Microsoft.SharePoint.SPFieldType.Text, True)
Finally
    webSite.Dispose()
End Try

using (SPWeb oWebsite = SPContext.Current.Site.AllWebs["MySite"])
{
    SPFieldCollection collFields = oWebsite.Lists["MyList"].Fields;
    collFields.Add("MyField", Microsoft.SharePoint.SPFieldType.Text, 
        true);
}

Voir aussi

Référence

SPFieldCollection classe

SPFieldCollection - Membres

Add - Surcharge

Microsoft.SharePoint - Espace de noms