ToolVersionGraphicCompare client API - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Web Client Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10

The ToolVersionGraphicCompare client API is used to compare a tool document to a published document, graphically.

Argument

Description

Parameter 1

Tool data file

Parameter 1 default

None

Parameter 1 description

The path to the tool data file that will be used in the comparison.

Parameter 1 type

String

Parameter 2

Tool view file

Parameter 2 default

None

Parameter 2 description

The path to the tool view file that will be used in the comparison.

Parameter 2 type

String

Parameter 3

Display mode

Parameter 3 default

FRAME

Parameter 3 description

If set to OPEN, the comparison dialog box will open in a separate browser window. If set to FRAME, the comparison dialog box will open in an frame within the Desktop Client.

Parameter 3 type

String

Parameter 4

Include

Parameter 4 default

Include identical properties

Parameter 4 description

TRUE

Parameter 4 type

If set to TRUE, all properties will be included in the comparison, even properties with identical data between the two documents. If set to False, only properties with different values between the two documents will be included in the comparison.

Parameter 5

Boolean

No delivered methods use the ToolVersionGraphicCompare client API.