Метод ScheduledItem.GetScheduledItem

Извлекает экземпляр класса ScheduledItem , который является оболочкой заданного SPListItem класса.

Пространство имен:  Microsoft.SharePoint.Publishing
Сборка:  Microsoft.SharePoint.Publishing (в Microsoft.SharePoint.Publishing.dll)

Синтаксис

'Декларация
Public Shared Function GetScheduledItem ( _
    sourceListItem As SPListItem _
) As ScheduledItem
'Применение
Dim sourceListItem As SPListItem
Dim returnValue As ScheduledItem

returnValue = ScheduledItem.GetScheduledItem(sourceListItem)

public static ScheduledItem GetScheduledItem(
    SPListItem sourceListItem
)

Параметры

• sourceListItem
  Тип: Microsoft.SharePoint.SPListItem

  SPListItem перенос в экземпляре ScheduledItem .

Возвращаемое значение

Тип: Microsoft.SharePoint.Publishing.ScheduledItem
Экземпляр ScheduledItem , который является оболочкой заданного SPListItem.

Исключения

Исключение	Условие
[System.ArgumentException]	Недопустимый SPListItem. SPListItem предоставлены не совместим с ScheduledItem. Это означает, что SPListItem либо частью библиотеки документов, которая поддерживает планирование или не имеет начала и окончания, которые необходимы для планирования.
[System.ArgumentNullException]	Параметр sourceListItem не может быть пустая ссылка (Nothing в Visual Basic).

Примеры

Этот пример задает начальную и конечную даты для объекта ScheduledItem и назначает элемент таким образом, чтобы при достижении даты начала и неопубликованные, при достижении конечной даты публикации.

Чтобы скомпилировать и запустить этот образец, убедитесь, что SPListItem элемент списка в библиотеке документов, который поддерживает планирование.

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

См. также

Справочные материалы

ScheduledItem класс

Элементы ScheduledItem

Пространство имен Microsoft.SharePoint.Publishing

IsScheduledItem