Метод ScheduledItem.Schedule (String)

Статья
03/15/2016

Намечает объект SPListItem для автоматического утверждения (начало) и публикации (окончание) за указанный период.

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

Синтаксис

'Декларация
Public Sub Schedule ( _
    approvalComment As String _
)
'Применение
Dim instance As ScheduledItem
Dim approvalComment As String

instance.Schedule(approvalComment)

public void Schedule(
    string approvalComment
)

Параметры

approvalComment
Тип: System.String

Комментарии устанавливается при утверждении SPListItem , если StartDate в будущем.

Исключения

Исключение	Условие
[Microsoft.SharePoint.SPException]	Можно запланировать документы только в списке дополнительный номер версии включен.
[Microsoft.SharePoint.SPException]	Можно запланировать документы только в списке с включенным утверждением содержимого.
[Microsoft.SharePoint.SPException]	Текущий пользователь не имеет достаточных разрешений для выполнения этого действия.
[Microsoft.SharePoint.SPException]	Планирование начальной даты текущего утвержденного элемента не поддерживается. Элементы должны быть в состоянии дополнительный номер версии.
[Microsoft.SharePoint.SPException]	В этой базе данных контента планирование не поддерживается. Использовать утверждение или отмену публикации вместо.

Замечания

Планирование SPListItem указывает, что она уже фактически утверждена. Для утверждения требуются те же разрешения, необходимые для планирования.

Значения StartDate и EndDate используются, чтобы определить расписание публикации. Если начальная дата меньше, чем сейчас, SPListItem публикуется немедленно. В противном случае она планируется опубликовать в будущем. Если дата окончания, SPListItem планируется отменить публикацию в будущем.

Примеры

Этот пример задает начальную и конечную даты для объекта 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