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

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

The DocVersionCompare client API is used to compare two versions of a published document or two versions of a publishable document, such as snapshots.

Argument

Description

Parameter 1

Exclude identical objects

Parameter 1 default

True

Parameter 1 description

If set to True, the Hide identical objects option in the Compare window opened using this method is selected and disabled. As a result, any objects that have completely identical property values in the two versions of the document are not displayed in the window. If set to False, the Hide identical objects option is cleared by default in the window, but is available to be selected, if necessary.

Parameter 1 type

Boolean

Parameter 2

Exclude Specified ClassDefs

Parameter 2 default

None

Parameter 2 description

A list of all the class definitions to be excluded from the comparison results. Use commas to separate the class definitions in the list.

Parameter 2 type

String

The DocVersionCompare method uses the DocVersionCompare client API to compare two versions of a document.