del método EntityList<TEntity>.DeleteOnSubmit

Artículo
05/13/2015

Marca la entidad especificada para la eliminación en la siguiente llamada de SubmitChanges().

Espacio de nombres: Microsoft.SharePoint.Linq
Ensamblado: Microsoft.SharePoint.Linq (en Microsoft.SharePoint.Linq.dll)

Sintaxis

'Declaración
Public Sub DeleteOnSubmit ( _
    entity As TEntity _
)
'Uso
Dim instance As EntityList
Dim entity As TEntity

instance.DeleteOnSubmit(entity)

public void DeleteOnSubmit(
    TEntity entity
)

Parámetros

entity
Tipo: TEntity

La entidad debe ser marcado para su eliminación.

Excepciones

Excepción	Condición
ArgumentNullException	entity es una referencia null (Nothing en Visual Basic).
InvalidOperationException	Objeto de seguimiento no está habilitado para el objeto DataContext . o bien entity no es del mismo tipo que los elementos de lista.

ArgumentNullException

entity es una referencia null (Nothing en Visual Basic).

InvalidOperationException

Objeto de seguimiento no está habilitado para el objeto DataContext .

o bien

entity no es del mismo tipo que los elementos de lista.

Comentarios

entity suele ser un elemento de lista, pero puede ser una entidad separada del mismo tipo que los elementos de la lista.

Ejemplos

El siguiente es un ejemplo de DeleteOnSubmit(TEntity) en uso:

// Set the item to be deleted.
foreach (TeamMember teamMember in teamSite.TeamMembers)
{
    if (teamMember.Title = "Bob Smith")
    {
        teamSite.TeamMembers.DeleteOnSubmit(teamMember);
    }
}

// Write changes to the content database.
teamSite.SubmitChanges();

// Try-catch block omitted for readability.

' Set the item to be deleted.
For Each teamMember As TeamMember In teamSite.TeamMembers
    If teamMember.Title = "Bob Smith" Then
        teamSite.TeamMembers.DeleteOnSubmit(teamMember)
    End If
Next teamMember

' Write changes to the content database.
teamSite.SubmitChanges()

' Try-catch block omitted for readability.