Compartir a través de


Clase SPAlertCollection

Representa una colección de objetos SPAlert .

Jerarquía de la herencia

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

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

Sintaxis

'Declaración
Public Class SPAlertCollection _
    Inherits SPBaseCollection
'Uso
Dim instance As SPAlertCollection
public class SPAlertCollection : SPBaseCollection

Comentarios

El objeto SPAlertCollection está disponible como una propiedad de SPWeb o SPUser.

Utilice la propiedad Alerts de la clase SPUser o SPWeb para devolver la colección de alertas para el sitio Web o un usuario. Para crear una alerta, utilice uno de los métodos de Add de la clase SPAlertCollection .

Utilice un indizador para devolver un solo campo de la colección. Por ejemplo, suponiendo que la colección se asigna a una variable denominada collAlerts, use collAlerts[index] en C# o collAlerts(index) en Visual Basic, donde index es el número de índice de la alerta de la colección o el nombre para mostrar de la alerta.

Ejemplos

En el ejemplo de código siguiente se recorre en iteración todas las alertas dentro de una colección de sitios para mostrar el título de cada sitio, el nombre para mostrar de la lista y el elemento al que cada alerta se aplica y el nombre del usuario que recibe cada alerta.

En el ejemplo se presupone la existencia de una página .aspx que contiene un control de etiqueta.

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();
}

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 SPAlertCollection

Espacio de nombres Microsoft.SharePoint