ScheduledItem.IsScheduledItem método
Confirma um item SPListItem é uma instância da classe ScheduledItem válida.
Namespace: Microsoft.SharePoint.Publishing
Assembly: Microsoft.SharePoint.Publishing (em Microsoft.SharePoint.Publishing.dll)
Sintaxe
'Declaração
Public Shared Function IsScheduledItem ( _
sourceListItem As SPListItem _
) As Boolean
'Uso
Dim sourceListItem As SPListItem
Dim returnValue As Boolean
returnValue = ScheduledItem.IsScheduledItem(sourceListItem)
public static bool IsScheduledItem(
SPListItem sourceListItem
)
Parâmetros
sourceListItem
Tipo: Microsoft.SharePoint.SPListItemSPListItem para verificar se há validade.
Valor retornado
Tipo: System.Boolean
true se o SPListItem é um ScheduledItem; Caso contrário, false.
Exceções
Exceção | Condição |
---|---|
[System.ArgumentNullException] | O parâmetro sourceListItem não pode ser uma referência nula (Nothing no Visual Basic). |
Comentários
Esse método confirma que o SPListItem é um membro de uma biblioteca de documentos que oferece suporte ao agendamento e que tem datas de início e de término, que são necessárias para o agendamento.
Exemplos
Este exemplo define uma data de início e de término para um objeto ScheduledItem e agenda o item para que ele é publicado quando for alcançada a data de início e é cancelada quando for alcançada a data de término.
Antes de compilar e executar esse exemplo, verifique se o SPListItem é um item de lista em uma biblioteca de documentos que oferece suporte ao agendamento.
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