ScheduledItem.StartDate - Propriété
Obtient ou définit le temps universel coordonné (UTC) à laquelle cet objet ScheduledItem devient une partie visible du site Web publié.
Espace de noms : Microsoft.SharePoint.Publishing
Assembly : Microsoft.SharePoint.Publishing (dans Microsoft.SharePoint.Publishing.dll)
Syntaxe
'Déclaration
Public Property StartDate As DateTime
Get
Set
'Utilisation
Dim instance As ScheduledItem
Dim value As DateTime
value = instance.StartDate
instance.StartDate = value
public DateTime StartDate { get; set; }
Valeur de propriété
Type : System.DateTime
Le temps universel coordonné (UTC) à laquelle ce ScheduledItem devient une partie visible du site Web publié.
Exceptions
Exception | Condition |
---|---|
[System.ArgumentNullException] | Le paramètre ne peut pas contenir une valeur de une référence Null (Rien dans Visual Basic) . |
[Microsoft.SharePoint.SPException] | L'utilisateur actuel ne dispose pas des autorisations suffisantes pour effectuer cette action. |
Remarques
La valeur 01 janvier 1900, indique qu'une instance de la classe ScheduledItem a une date de début est définie à une date révolue et doit être publiée immédiatement après son approbation. Si la date de début est le 01 janvier 1900, la propriété est affichée en tant que « Immédiatement » dans les interfaces utilisateur correspondant.
Pour enregistrer les modifications après avoir défini cette propriété, appelez la méthode ScheduledItem.LIstItem.Update .
La date et l'heure sont retournées par cette propriété peuvent être convertis à partir de l'UTC en heure locale dans le code côté serveur à l'aide de 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 récupérer la PublishingPage et de ses valeurs de propriété.
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