Methods (ISPToolDocs2) - Integration - Update 46 - Help - Hexagon

SmartPlant Integration .NET Help

Language
English
Product
Integration
Search by Category
Help
SmartPlant Foundation / SDx Version
10
Smart P&ID Version
9 (2019)
Smart Engineering Manager Version
10 (2019)

GetUserSelectionForCompare

This method is defined on the ISPToolDocs2 interface. Tools that support the Compare with Published Version command implement this method to select a document in the tool database to compare with a published version.

The ISPCLCommonUIApplicationUI’s code behind the Engineering Tool button has a call to the GetUserSelectionForCompare method.

The implementation code for this method is similar to the GetUserSelections method on the ISPToolDocs interface, however only one document selection is allowed in the GetUserSelectionForCompare method.

The ISPToolDocs2 interface must be implemented in the same DLL in which the ISPToolDocs interface is implemented.

Description

This method is called when you click the Engineering Tool button on the Compare with Published Version dialog box.

The tool code uses the arguments passed (sSPFURL, sSPFPlant, and so forth) to establish the right tool plant context. The code displays a dialog box in which you select one document. Then, a Document object is created in the oDocContainer. (For details on how to create the Document object in IContainer, see GetUserSelections in Methods (ISPToolDocs).)

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 to which the tool is currently connected.

oDocIContainer

IContainer

Input/Output

Reference to Schema Component IContainer object in which the tool will add a document object for the document selected in the tool UI.

Return Value

None.

Comments

None.