Clase SPItemEventProperties

Contiene información acerca de los eventos de elemento de lista.

Jerarquía de la herencia

System.Object
  Microsoft.SharePoint.SPEventPropertiesBase
    Microsoft.SharePoint.SPItemEventProperties

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

Sintaxis

'Declaración
<SerializableAttribute> _
Public NotInheritable Class SPItemEventProperties _
    Inherits SPEventPropertiesBase _
    Implements IDisposable
'Uso
Dim instance As SPItemEventProperties
[SerializableAttribute]
public sealed class SPItemEventProperties : SPEventPropertiesBase, 
    IDisposable

Comentarios

La clase SPItemEventProperties contiene información acerca de un evento de elemento, incluidas las propiedades fijas del evento como tipo de evento, el nombre de usuario y la dirección URL; También incluye las propiedades Before y After del elemento de lista para el que el evento se desencadena cuando las propiedades están disponibles. Para los eventos de After , las definiciones de propiedades Before y After son sencillas: propiedades de Before hacen referencia a la configuración que existía antes de que se produjo el evento y After propiedades hacen referencia a la configuración que existe una vez que haya ocurrido el evento. Para los eventos de Before , sin embargo, Before propiedades hacen referencia a la configuración actual de elemento antes de que se produce el evento, mientras After propiedades hacen referencia a la configuración que tendrá el elemento después de que se produce el evento.

Ejemplos

En el ejemplo de código siguiente se usa la clase SPItemEventProperties para limitar el número de elementos que se pueden agregar a una lista.

using System;
using Microsoft.SharePoint;

namespace Example_Namespace
{
    public class Class_Name : SPItemEventReceiver
    {
        public override void ItemAdding(SPItemEventProperties properties)
        {
            using(SPWeb oWebsite = new SPSite(properties.SiteId).OpenWeb(properties.RelativeWebUrl))
            { 
                SPListItemCollection collItems = oWebsite.Lists[properties.ListTitle].Items;

                if (collItems.Count > 150)
                {
                    properties.Cancel = true;
                    properties.ErrorMessage = "Adding items to this list is not supported because it already contains " + 
                        colItems.Count.ToString() + " items.";
                }
            }
        }
    }
}
Imports System
Imports Microsoft.SharePoint

Namespace Example_Namespace
    Public Class Class_Name
        Inherits SPItemEventReceiver
        Public Overrides Sub ItemAdding(ByVal properties As SPItemEventProperties)
            Using oWebsite As SPWeb = New SPSite(properties.SiteId).OpenWeb(properties.RelativeWebUrl)
                Dim collItems As SPListItemCollection = oWebsite.Lists(properties.ListTitle).Items

                If collItems.Count > 150 Then
                    properties.Cancel = True
                    properties.ErrorMessage = "Adding items to this list is not supported because it already contains " & colItems.Count.ToString() & " items."
                End If
            End Using
        End Sub
    End Class
End Namespace

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.

Seguridad para subprocesos

Los miembros static (Shared en Visual Basic) públicos de este tipo son seguros para subprocesos. No se garantiza que los miembros de instancias sean seguros para los subprocesos.

Vea también

Referencia

Miembros SPItemEventProperties

Espacio de nombres Microsoft.SharePoint