del método SPFieldCollection.Delete
Elimina el campo con los valores especificados interno, mostrar o nombre estático de la colección.
Espacio de nombres: Microsoft.SharePoint
Ensamblado: Microsoft.SharePoint (en Microsoft.SharePoint.dll)
Sintaxis
'Declaración
Public Sub Delete ( _
strName As String _
)
'Uso
Dim instance As SPFieldCollection
Dim strName As String
instance.Delete(strName)
public void Delete(
string strName
)
Parámetros
strName
Tipo: System.StringUna cadena que especifica la interna, mostrar, o staticname o título del campo. SharePoint Foundation primero comprueba el valor especificado por su nombre interno y a continuación, por título.
Excepciones
Excepción | Condición |
---|---|
SPException | El campo es de solo lectura. |
ArgumentException | No existe ningún campo con ese nombre en la colección. |
InvalidOperationException | El valor devuelto por la propiedad del campo CanBeDeleted es false. |
Comentarios
Este método obtiene el nombre del campo de una propiedad de campo en el orden siguiente: InternalName, Title, StaticName.
Si el campo es del tipo SPFieldLookup y es un campo de búsqueda principal, también se eliminan todas las búsquedas secundarias. Para obtener más información, vea la propiedad IsDependentLookup .
Ejemplos
En el ejemplo de código siguiente se elimina el campo con el nombre especificado de la lista de eventos en todos los subsitios en un sitio especificado.
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);
}
Nota
Determinados objetos implementan la interfaz de IDisposable y, a continuación, se debe evitar la conservación de estos objetos en la memoria que ya no se necesitan. Para obtener información acerca de buenas prácticas de codificación, vea Disposing Objects.