SPItemEventProperties - Classe

Contient des informations sur les événements d'élément de liste.

Hiérarchie d’héritage

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

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

Syntaxe

'Déclaration
<SerializableAttribute> _
Public NotInheritable Class SPItemEventProperties _
    Inherits SPEventPropertiesBase _
    Implements IDisposable
'Utilisation
Dim instance As SPItemEventProperties

[SerializableAttribute]
public sealed class SPItemEventProperties : SPEventPropertiesBase, 
    IDisposable

Remarques

La classe SPItemEventProperties conserve des informations sur un événement d'élément, y compris les propriétés de l'événement comme type d'événement, nom d'utilisateur et URL ; Il comprend également les propriétés Before et After de l'élément de liste pour lequel l'événement est déclenché lorsque les propriétés sont disponibles. Pour les événements After , les définitions des propriétés Before et After sont simples : Before propriétés font référence aux paramètres qui existaient avant que l'événement s'est produit et After propriétés font référence aux paramètres qui existent après l'événement s'est produit. Pour les événements Before , toutefois, Before propriétés font référence aux paramètres d'article en cours avant que l'événement se produit, les propriétés de After font référence aux paramètres de que l'élément aura une fois que l'événement se produit.

Exemples

L'exemple de code suivant utilise la classe SPItemEventProperties pour limiter le nombre d'éléments qui peuvent être ajoutés à une liste.

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

Cohérence de thread

Tous les membres statique (Partagé dans Visual Basic)s publics de ce type sont thread-safe. Cela n’est pas garanti pour les membres d’instance.

Voir aussi

Référence

SPItemEventProperties - Membres

Microsoft.SharePoint - Espace de noms