SPAlertCollection - Classe

Article
05/12/2015

Représente une collection d'objets SPAlert .

Hiérarchie d’héritage

System.Object
  Microsoft.SharePoint.Administration.SPAutoSerializingObject
    Microsoft.SharePoint.SPBaseCollection
      Microsoft.SharePoint.SPAlertCollection

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

Syntaxe

'Déclaration
Public Class SPAlertCollection _
    Inherits SPBaseCollection
'Utilisation
Dim instance As SPAlertCollection

public class SPAlertCollection : SPBaseCollection

Remarques

L'objet SPAlertCollection est disponible en tant que propriété du SPWeb ou SPUser.

Utilisez la propriété Alerts de la classe SPUser ou SPWeb pour renvoyer la collection d'alertes pour le site Web ou l'utilisateur. Pour créer une alerte, utilisez une des méthodes de la classe SPAlertCollectionAdd .

Un indexeur permet de renvoyer un champ unique de la collection. Par exemple, en supposant que la collection est assignée à une variable nommée collAlerts, utilisez collAlerts[index] dans C# ou collAlerts(index) dans Visual Basic, où index est le numéro d'index de l'alerte dans la collection ou le nom d'affichage de l'alerte.

Exemples

L'exemple de code suivant itère toutes les alertes au sein d'une collection de sites pour afficher le titre de chaque site, le nom d'affichage de la liste et un élément pour chaque alerte s'applique et le nom de l'utilisateur qui reçoit chaque alerte.

L'exemple suivant suppose l'existence d'une page .aspx qui contient un contrôle Label.

Dim siteCollection As SPSite = SPControl.GetContextSite(Context)
Dim sites As SPWebCollection = siteCollection.AllWebs
Dim site As SPWeb

For Each site In  sites

    Dim alerts As SPAlertCollection = site.Alerts
    Dim alert As SPAlert

    For Each alert In  alerts

        Label1.Text += SPEncode.HtmlEncode(site.Title) & " :: " _
            & SPEncode.HtmlEncode(alert.Title) & " :: " _
            & alert.User.LoginName & "<BR>"

    Next alert

Next site

SPSite oSiteCollection = SPContext.Current.Site;
SPWebCollection collWebsites = oSite.AllWebs;
foreach (SPWeb oWebsite in collWebsites)
{
    SPAlertCollection collAlerts = oWebsite.Alerts;

    foreach (SPAlert oAlert in collAlerts)
    {
        Label1.Text = SPEncode.HtmlEncode(oWebsite.Title) + " :: " +
            SPEncode.HtmlEncode(oAlert.Title) + " :: " +
            oAlert.User.LoginName + "<BR>";
        writer.Write(strLabelText);
    }
    oWebsite.Dispose();
}

Notes

Certains objets implémentent l'interface IDisposable , et vous devez éviter de conserver ces objets dans la mémoire après que qu'ils ne sont plus nécessaires. Pour plus d'informations sur les bonnes pratiques de codage, consultez Disposing Objects.

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

SPAlertCollection - Membres

Microsoft.SharePoint - Espace de noms

Partager via