SPItemEventProperties class

Artigo
05/12/2015

Contém informações sobre eventos de item de lista.

Inheritance hierarchy

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

Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaração
<SerializableAttribute> _
Public NotInheritable Class SPItemEventProperties _
    Inherits SPEventPropertiesBase _
    Implements IDisposable
'Uso
Dim instance As SPItemEventProperties

[SerializableAttribute]
public sealed class SPItemEventProperties : SPEventPropertiesBase, 
    IDisposable

Comentários

A classe SPItemEventProperties contém informações sobre um evento de item, incluindo propriedades fixas de evento, como tipo de evento, nome de usuário e URL; Ele também inclui as propriedades Before e After do item de lista para o qual o evento é acionado quando as propriedades estão disponíveis. Para eventos de After , as definições das propriedades Before e After são simples: propriedades de Before consultem configurações que existiam antes que o evento ocorreu, e propriedades de After as configurações existentes depois que o evento ocorreu. Para eventos Before , no entanto, Before propriedades se referem às configurações de item atual antes que o evento ocorra, enquanto After propriedades se referem às configurações que o item terá depois que o evento ocorre.

Examples

O exemplo de código a seguir usa a classe SPItemEventProperties para limitar o número de itens que podem ser adicionados a uma 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

Dica

Determinados objetos implementam a interface IDisposable , e você deve evitar reter esses objetos na memória depois que eles não são mais necessários. Para obter informações sobre boas práticas de codificação, consulte Disposing Objects.

Thread safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Ver também

Referência

SPItemEventProperties members

Microsoft.SharePoint namespace

Compartilhar via