This method is defined on ‘IEFToolDocs2’ interface (available in SchemaComponent.tlb, delivered with SmartPlant Schema Component). Tools that support Compare with Published Version command will implement this method to select a document in tool database to compare with a published version.
The EFCommonUI’s code behind the Engineering Tool button will have a call to GetUserSelectionForCompare method.
The implementation code for this method would be similar to ‘GetUserSelections’ method on IEFToolDocs interface except only one document selection should be allowed in GetUserSelectionForCompare method.
The IEFToolDocs2 interface must be implemented in the same DLL in which the IEFToolDocs interface is implemented.
Arguments
Name |
Data type |
Input/output |
Description |
---|---|---|---|
sSPFURL |
String |
Input |
The SmartPlant Foundation URL that is currently connected to. |
sSPFPlant |
String |
Input |
Name of SmartPlant Foundation plant that is currently connected to. |
sSPFProjectUID |
String |
Input |
UID of the project (if connected to a project). |
sSPFProjectName |
String |
Input |
Name of the project (if connected to a project). |
oToolParameters |
IEFToolParameters |
Input |
Pointer to tool parameters object that is passed by the tool in the Connect call. Typically, tools will pass a set of tool specific parameters for their internal use. |
oDocContainer |
IContainer |
Input/Output |
Pointer to IContainer Schema Component object in which the tool will add a ‘Document’ object for the document selected in the tool UI. |
Return Value
None.
Description
This method is called when the Engineering Tool button is clicked on the Compare with Published Version dialog box.
The tool code will use the arguments passed (sSPFURL, sSPFPlant, etc.) to establish the right tool plant context. The code will display a dialog for user to select a document (only one document). Then a ‘Document’ object will be created in the oDocContainer. (For details on how to create the ‘Document’ object in IContainer, see GetUserSelections.
Impacts
None.