ScheduledItem.GetScheduledItem-Methode

Ruft eine Instanz der ScheduledItem -Klasse, die die angegebenen SPListItem -Klasse umschließt.

Namespace:  Microsoft.SharePoint.Publishing
Assembly:  Microsoft.SharePoint.Publishing (in Microsoft.SharePoint.Publishing.dll)

Syntax

'Declaration
Public Shared Function GetScheduledItem ( _
    sourceListItem As SPListItem _
) As ScheduledItem
'Usage
Dim sourceListItem As SPListItem
Dim returnValue As ScheduledItem

returnValue = ScheduledItem.GetScheduledItem(sourceListItem)

public static ScheduledItem GetScheduledItem(
    SPListItem sourceListItem
)

Parameter

• sourceListItem
  Typ: Microsoft.SharePoint.SPListItem

  Die SPListItem in einer ScheduledItem -Instanz umbrochen.

Rückgabewert

Typ: Microsoft.SharePoint.Publishing.ScheduledItem
Eine ScheduledItem -Instanz, die die angegebenen SPListItemumschließt.

Ausnahmen

Beispiele

In diesem Beispiel wird ein Datum für Start und Ende für ein ScheduledItem -Objekt und plant das Element, damit es veröffentlicht wird, wenn das Startdatum erreicht und ist nicht veröffentlichten, wenn das Enddatum erreicht ist.

Vor dem Kompilieren und Ausführen dieses Beispiels sicher, dass der SPListItem ein Element in einer Dokumentbibliothek ist unterstützt, die Zeitplanung.

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

Siehe auch

Referenz

ScheduledItem Klasse

ScheduledItem-Member

Microsoft.SharePoint.Publishing-Namespace

IsScheduledItem