ViewTagFiles 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 ViewTagFiles client API is used to view all files that are related to the selected tags.

Argument

Description

Parameter 1

FRAME

Parameter 1 description

The display mode set to view files related to the tags

  • If set to OPEN, the URL will open the files in a separate browser window

  • If set to FRAME, the URL will open the files in a internal frame within the web client

Parameter 1 type

String

Parameter 1 default

FRAME

Parameter 2

Viewer override

Parameter 2 description

Overrides the display mode to automatically view any markups

  • If set to TRUE, any markups associated with the document are displayed automatically

Parameter 2 type

String

Parameter 2 default

None

Parameter 3

Display markups

Parameter 3 description

Overrides the default display of any markups in the file using the incorporated file viewer (or the 3D View Control if the file is a 3D model)

  • If set to NATIVE, this uses the native file type viewer based on Windows file type association.

  • If set to ALTERNATE, this displays the alternate PDF rendition.

Parameter 3 type

Boolean

Parameter 3 default

False

Parameter 4

Revision status for document tags

Parameter 4 description

The revision status set for any hotspotted document tags

Parameter 4 type

String

Parameter 4 default

ISPFDocumentRevision~SPFRevState~=~e1WORKING|e1CURRENT

Parameter 5

Show nested references dialog

Parameter 5 description

If set to True, then the View and Markup dialog shows the nested structure of any related reference files. Any selected reference files can be viewed along with the master file

Parameter 5 type

Boolean

Parameter 5 default

True

Parameter 6

Alternate rendition file types to be viewed

Parameter 6 description

Specifies the alternate rendition file types that can be viewed.

Each file type UID must be separated by semicolon. For example, FT_pdf;ft_bmp;FT_png

Parameter 6 type

String

Parameter 6 default

None

Parameter 7

ColumnSet

Parameter 7 description

The name of the column set to be used to display items in columns.

  • If none is set, the default CopyToLocalColumnSet is used

  • If parameter 3 is set to ALTERNATE, the CS_CopyToLocalAlternateColumnSet is used

Parameter 7 type

String

Parameter 7 default

None

Parameter 8

EdgeDefUID to navigate

Parameter 8 description

The Edge Definition used to navigate from the tags to the document revision

Parameter 8 type

String

Parameter 8 default

None

The following methods are used by this client API to view all files that are related to the selected tags.

  • ViewChildTagFiles

  • ViewTagFiles