del método ScheduledItem.Schedule

Artículo
03/15/2016

Programaciones de una instancia de la clase SPListItem automáticamente aprobado (inicio) y que no publicados (end) en las fechas especificadas.

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

Sintaxis

'Declaración
Public Sub Schedule
'Uso
Dim instance As ScheduledItem

instance.Schedule()

public void Schedule()

Excepciones

Excepción	Condición
[Microsoft.SharePoint.SPException]	Puede programar documentos en una lista habilitada de versión secundaria.
[Microsoft.SharePoint.SPException]	Puede programar documentos en una lista que tiene habilitada la aprobación de contenido.
[Microsoft.SharePoint.SPException]	El usuario actual no tiene permisos suficientes para realizar esta acción.
[Microsoft.SharePoint.SPException]	No se admite la programación de una fecha de inicio para un elemento actualmente aprobado. Artículos deben estar en estado secundario/borrador.
[Microsoft.SharePoint.SPException]	No se admite la programación en esta base de datos de contenido. Use aprobar o no publicar en su lugar.

Comentarios

Programación de un SPListItem indica que ya se ha aprobado. Los mismos permisos son necesarios para la aprobación y la programación.

Los valores de propiedad de StartDate y EndDate se utilizan para determinar la programación de publicación. Si la fecha de inicio es anterior a la fecha actual, el SPListItem se publica inmediatamente. Si no es así, está programada para publicar en una fecha futura. Si se especifica la fecha de finalización, el SPListItem se programa para anular la publicación en una fecha futura.

Ejemplos

En este ejemplo se establece una fecha inicial y final de un objeto ScheduledItem y programa el elemento, por lo que se publica cuando se alcanza la fecha de inicio y es no publicado cuando se alcanza la fecha de finalización.

Antes de compilar y ejecutar este ejemplo, compruebe que la SPListItem es un elemento de lista en una biblioteca de documentos es compatible con la programación.

using ScheduledItem = Microsoft.SharePoint.Publishing.ScheduledItem;
using SPModerationStatusType = Microsoft.SharePoint.SPModerationStatusType;
using SPListItem = Microsoft.SharePoint.SPListItem;
using DateTime = System.DateTime;

namespace Microsoft.SDK.SharePointServer.Samples
{
    public static class ScheduledItemCodeSamples
    {
        public static void SetDatesAndSchedule(SPListItem listItem, 
          DateTime startDate, DateTime endDate)
        {
            // Set the input parameter values with
            // your own values.
            
            //
            // validate the input parameters
            if (null == listItem)
            {
                throw new System.ArgumentNullException("listItem");
            }

            // Get the ScheduledItem wrapper for the SPListItem
            // that was passed in.
            //
            ScheduledItem scheduledItem = null;
            if (ScheduledItem.IsScheduledItem(listItem))
            {
                scheduledItem = ScheduledItem.GetScheduledItem(listItem);
            }
            else
            {
                throw new System.ArgumentException
                  ("The document library containing this SPListItem must support scheduling", 
                  "listItem");
            }

            // Set and save the date values.
            scheduledItem.StartDate = startDate;
            scheduledItem.EndDate = endDate;
            scheduledItem.ListItem.Update();

            // Schedule the item so that the StartDate and EndDate
            // take effect.
            scheduledItem.Schedule();
        }        
    }
}

Imports ScheduledItem = Microsoft.SharePoint.Publishing.ScheduledItem
Imports SPModerationStatusType = Microsoft.SharePoint.SPModerationStatusType
Imports SPListItem = Microsoft.SharePoint.SPListItem

Namespace Microsoft.SDK.SharePointServer.Samples
    Public NotInheritable Class ScheduledItemCodeSamples
        Private Sub New()
        End Sub
        Public Shared Sub SetDatesAndSchedule(ByVal listItem As SPListItem, ByVal startDate As Date, ByVal endDate As Date)
            ' Set the input parameter values with
            ' your own values.

            '
            ' validate the input parameters
            If Nothing Is listItem Then
                Throw New System.ArgumentNullException("listItem")
            End If

            ' Get the ScheduledItem wrapper for the SPListItem
            ' that was passed in.
            '
            Dim scheduledItem As ScheduledItem = Nothing
            If ScheduledItem.IsScheduledItem(listItem) Then
                scheduledItem = ScheduledItem.GetScheduledItem(listItem)
            Else
                Throw New System.ArgumentException ("The document library containing this SPListItem must support scheduling", "listItem")
            End If

            ' Set and save the date values.
            scheduledItem.StartDate = startDate
            scheduledItem.EndDate = endDate
            scheduledItem.ListItem.Update()

            ' Schedule the item so that the StartDate and EndDate
            ' take effect.
            scheduledItem.Schedule()
        End Sub
    End Class
End Namespace