A document or other object can be configured to track the distribution of revisions of object lists, such as equipment lists. Lists are configured using the List Management Console, while lists are created, managed, and saved as documents using the List Edit control. Both the List Management Console and the List Edit control are described in the List editing.
ISPFListEditControl interface
To edit the list of items attached to a document or other object, the document revision object must realize the interface ISPFListEditControl. This is a required realized interface for the document revision object.
This interface exposes the following properties:
-
SPFPathDefnToRelatedItems - The path definition used to navigate to the list of related items.
-
SPFColSetToDisplayRelatedItems - The column set to use in the List Edit control for displaying the list of related items.
-
SPFTitleForDisplayingRelatedItems - The title to display in the List Edit control.
-
SPFClassDefForNewRelatedItems - The class definition to use to create new items in the List Edit control.
-
SPFDeleteActionForRelatedItems - The delete action to use in the List Edit control.
This interface is added onto the revision object when you create a document from the List Edit control.
Alternatively, you can use one of the three following client APIs to create the document:
-
CreateClassObjWithPropertyOverrides
-
CreateClassObjFromClassWithPropertyOverrides
-
CreateClassObjAndRelWithPropertyOverrides
For more information on argument 10 (property overrides), see Data sheet documents configuration.
ListEditRelatedItems method
The ListEditRelatedItems method is exposed on any object that realizes the ISPFListDocRevision interface. From this interface, ListEditRelatedItems obtains the necessary information about the set of objects to send to the List Edit control and the method that specifies the arguments.
Configure this method on the shortcut menu of the document to use the List Edit control to edit the list of objects related to this document.