WaitForDocumentUnlockActivity.IActivityEventListener<QueueEventArgs>.OnEvent method

Called when the event to which this WaitForDocumentUnlockActivity instance is subscribed occurs.

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

Syntax

'Declaration
Private Sub OnEvent ( _
    sender As Object, _
    e As QueueEventArgs _
) Implements IActivityEventListener(Of QueueEventArgs).OnEvent
'Usage
Dim instance As WaitForDocumentUnlockActivity
Dim sender As Object
Dim e As QueueEventArgs

CType(instance, IActivityEventListener(Of QueueEventArgs)).OnEvent(sender, _
    e)

void IActivityEventListener<QueueEventArgs>.OnEvent(
    Object sender,
    QueueEventArgs e
)

Parameters

• sender
  Type: System.Object

  The source of the event.

• e
  Type: System.Workflow.ComponentModel.QueueEventArgs

  The data for the event.

Implements

IActivityEventListener<T>.OnEvent(Object, T)

Remarks

This member is an explicit interface member implementation. It can be used only when the WaitForDocumentUnlockActivity instance is cast to an IActivityEventListener interface.

This method handles the subscribe-to events, including the timer and events registered in the Execute(ActivityExecutionContext) method.

If the document is unlocked after the event, it deletes all subscriptions and calls the DoUpdate(ActivityExecutionContext) method.

If this method is called because the specified time has elapsed and the document is still locked, this method registers a new timer with a new waiting interval that is twice the previous interval, up to a maximum of 256 minutes.

For the events, if the document is still locked, this activity continues waiting until the document is unlocked.

See also

Reference

WaitForDocumentUnlockActivity class

WaitForDocumentUnlockActivity members

Microsoft.SharePoint.WorkflowActions namespace