ISPFListEditControl interface - HxGN SDx - Update 64 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

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

The following properties are found on this interface.

Name

Description

How it is set

SPFOriginalMethodUID

Identifies the method that launches the List Edit control for the list.

Set when the document is created from the List Edit control.

SPFOriginalPathDefn

Path definition (prefixed +/-) of the relationship definition to use when relating list items to new or existing item.

Set when the document is created.

See Also

Edit lists of similar objects
Saving lists as documents
List editing