ViewInDocument client API - HxGN SDx - Update 63 - Administration & Configuration

Administration and Configuration of HxGN SDx

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

The ViewInDocument client API allows you to view a selected object in context in a document.

Argument

Description

Parameter 1

EdgeDef or GraphDef to Versions

Parameter 1 default

None

Parameter 1 description

The edge or graph definition used to find the document versions that the selected object can be found in.

Parameter 1 type

String

Parameter 2

Graph Objects EdgeDef

Parameter 2 default

None

Parameter 2 description

The edge definition used to find the graph objects.

Parameter 2 type

String

Parameter 3

Document Interface List

Parameter 3 default

None

Parameter 3 description

A comma-separated list of the interface definitions used to filter the document versions found.

Parameter 3 type

String

Parameter 4

Use Creation Date Filter?

Parameter 4 default

False

Parameter 4 description

When set to True, document will not be returned unless they were created before the selected object. When set to False, the documents are not filtered by the creation date and can be returned regardless of if they were create before or after the selected object.

Parameter 4 type

Boolean

Parameter 5

Document View Markup method

Parameter 5 default

None

Parameter 5 description

Method used to view and markup document

Parameter 5 type

String

Parameter 6

File picker column set

Parameter 6 default

None

Parameter 6 description

The column set to use within the File Picker dialog box.

Parameter 6 type

String

The following methods use the ViewInDocument client API to view a selected object within its related document.

  • CDWViewContinuationDrawing

  • ViewContinuationDrawing

  • ViewItemInDrawing

  • ViewItemInGDS

  • ViewItemInModel

  • ViewItemInSmartReview

  • ViewLoopInDrawing

  • ViewLoopInModel

  • ViewPipeRunInModel

  • ViewPipelineInDrawing

  • ViewPipelineInModel

  • SPFNSDAViewItemInDrawing