ScheduledItem.Schedule - Méthode (String)

Planifie un objet SPListItem pour être automatiquement approuvée (start) et être non publiés (fin) sur les dates spécifiées.

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

Syntaxe

'Déclaration
Public Sub Schedule ( _
    approvalComment As String _
)
'Utilisation
Dim instance As ScheduledItem
Dim approvalComment As String

instance.Schedule(approvalComment)

public void Schedule(
    string approvalComment
)

Paramètres

• approvalComment
  Type : System.String

  Commentaires à définir lorsque la SPListItem est acceptée si la StartDate est dans le futur.

Exceptions

Exception	Condition
[Microsoft.SharePoint.SPException]	Vous pouvez planifier des documents que dans une liste secondaire de version activée.
[Microsoft.SharePoint.SPException]	Vous pouvez planifier des documents que dans une liste avec l'approbation de contenu activée.
[Microsoft.SharePoint.SPException]	L'utilisateur actuel ne dispose pas des autorisations suffisantes pour effectuer cette action.
[Microsoft.SharePoint.SPException]	Planification d'une date de début pour un élément approuvé n'est pas pris en charge. Articles doivent figurer dans l'état de version secondaire.
[Microsoft.SharePoint.SPException]	La planification n'est pas pris en charge dans cette base de données de contenu. Utilisez approuver ou retirer la publication.

Remarques

Planification d'une SPListItem indique qu'il a déjà été effectivement approuvé. Les mêmes autorisations requises pour la planification sont nécessaires pour approbation.

Les valeurs StartDate et EndDate sont utilisées pour déterminer la date de publication. Si la date de début est antérieure à aujourd'hui, le SPListItem est publié immédiatement. Dans le cas contraire, il est prévu de publier à une date ultérieure. Si la date de fin est spécifiée, le SPListItem est planifiée à annuler la publication à une date ultérieure.

Exemples

Cet exemple définit une date de début et de fin pour un objet ScheduledItem et planifie l'élément afin qu'il est publié lorsque la date de début est atteinte et qu'il est non publié lorsque la date de fin est atteinte.

Avant de compiler et d'exécuter cet exemple, vérifiez que le SPListItem est un élément de liste dans une bibliothèque de documents qui prend en charge la planification.

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

Voir aussi

Référence

ScheduledItem classe

ScheduledItem - Membres

Schedule - Surcharge

Microsoft.SharePoint.Publishing - Espace de noms

StartDate

EndDate

Approve

Schedule