IHoldsHandler Interface

Provides an interface that a custom hold handler can implement to provide custom hold processing.

Namespace:  Microsoft.Office.RecordsManagement.Holds
Assembly:  Microsoft.Office.Policy (in Microsoft.Office.Policy.dll)


Public Interface IHoldsHandler
Dim instance As IHoldsHandler
public interface IHoldsHandler


When a list item is put on hold or removed from hold, a custom processing handler can be added by implementing the OnSetHold(SPListItem, SPListItem) and OnRemoveHold(SPListItem, List<SPListItem>) methods in the IHoldsHandler interface. After the handler has processed the list item, it can choose to cancel, continue, or skip default processing by returning the corresponiding HoldHandlerResult object.

See Also


IHoldsHandler Members

Microsoft.Office.RecordsManagement.Holds Namespace