ScheduledItem.EndDate - Propriété

Article
03/15/2016

Obtient ou définit le temps universel coordonné (UTC) à laquelle cette classe ScheduledItem se termine et n'est plus visible sur le site publié.

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

Syntaxe

'Déclaration
Public Property EndDate As DateTime
    Get
    Set
'Utilisation
Dim instance As ScheduledItem
Dim value As DateTime

value = instance.EndDate

instance.EndDate = value

public DateTime EndDate { get; set; }

Valeur de propriété

Type : System.DateTime
Le temps universel coordonné (UTC) à laquelle cette classe ScheduledItem se termine et n'est plus visible sur le site publié.

Exceptions

Exception	Condition
[System.ArgumentNullException]	Cette valeur ne peut pas être définie à une référence Null (Rien dans Visual Basic).
[System.UnauthorizedAccessException]	L'utilisateur actuel ne dispose pas des autorisations suffisantes pour effectuer cette action.

Remarques

La valeur 01 janvier 2050, indique qu'une instance de la classe ScheduledItem n'est plus visible sur le site publié. Si la date de fin est définie à cette valeur, la propriété est affichée à l'aide de la chaîne « Jamais » dans les interfaces utilisateur correspondant.

Pour enregistrer les modifications apportées après la définition de cette propriété, appelez la méthode ScheduledItem.ListItem.Update .

La date et l'heure retournée par cette propriété peuvent être convertis à partir de l'UTC en heure locale dans le code côté serveur en utilisant la méthode SPRegionalSettings.TimeZone.UTCToLocalTime(DateTime) .

L'utilisateur doit disposer des autorisations de modification sur les PublishingPage pour définir cette valeur. L'utilisateur doit disposer des autorisations d'affichage sur la PublishingPage initialement le récupérer et obtenir des valeurs de ses propriétés.

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