SPFieldCollection.Delete - Méthode

Supprime le nom de champ à l'interne, affichage ou statique à partir de la collection.

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

Syntaxe

'Déclaration
Public Sub Delete ( _
    strName As String _
)
'Utilisation
Dim instance As SPFieldCollection
Dim strName As String

instance.Delete(strName)
public void Delete(
    string strName
)

Paramètres

  • strName
    Type : System.String

    Une chaîne qui spécifie le texte interne, affichage, ou staticname ou titre du champ. SharePoint Foundation vérifie d'abord la valeur spécifiée par le nom interne, puis par titre.

Exceptions

Exception Condition
SPException

Le champ est en lecture seule.

ArgumentException

Aucun champ portant ce nom n'existe dans la collection.

InvalidOperationException

La valeur retournée par la propriété du champ CanBeDeleted est false.

Remarques

Cette méthode obtient le nom du champ à partir d'une propriété de champ dans l'ordre suivant : InternalName, Title, StaticName.

Si le champ est de type SPFieldLookup , et il s'agit d'un champ de recherche principal, toutes les recherches secondaires sont également supprimés. Pour plus d'informations, consultez la propriété IsDependentLookup .

Exemples

L'exemple de code suivant supprime le champ portant le nom spécifié à partir de la liste d'événements dans tous les sous-sites d'un site spécifié.

Dim siteCollection As SPSite = SPContext.Current.Site
Try
    Dim webSites As SPWebCollection = siteCollection.AllWebs("MySite").Webs

    Dim webSite As SPWeb
    For Each webSite In  webSites
        Dim fields As SPFieldCollection = 
            webSite.Lists("Announcements").Fields

        fields.Delete(fields("MyField").InternalName)
    Next webSite
Finally
    siteCollection.Dispose()
End Try
SPSite oSiteCollection = SPContext.Current.Site;
SPWebCollection collWebsites = oSiteCollection.AllWebs["MySite"].Webs;
foreach (SPWeb oWebsite in collWebsites)
{
    SPFieldCollection collFields = oWebsite.Lists["Announcements"].Fields;
    collFields.Delete(collFields["MyField"].InternalName);
}

Notes

Certains objets implémentent l'interface IDisposable , et vous devez éviter de conserver ces objets dans la mémoire après que qu'ils ne sont plus nécessaires. Pour plus d'informations sur les bonnes pratiques de codage, consultez Disposing Objects.

Voir aussi

Référence

SPFieldCollection classe

SPFieldCollection - Membres

Microsoft.SharePoint - Espace de noms