EditFiles 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 EditFiles client API is used to edit files attached to an object.

Argument

Description

Parameter 1

Show hidden files

Parameter 1 default

False

Parameter 1 description

True allows the selection of hidden (NonViewable) files. False prevents non-viewable files from being shown in the Select Files dialog box.

Parameter 1 type

Boolean

Parameter 2

Use next major revision for revise

Parameter 2 default

True

Parameter 2 description

New revision control for revise. By default, it is set to True, which means the next major revision is honored. If it is set to False, the next minor revision is honored.

Parameter 2 type

Boolean

Parameter 3

RestrictedFileTypeUIDs

Parameter 3 default

None

Parameter 3 description

The file types are restricted from download or copy during edit.

Parameter 3 type

String

Parameter 4

Not used.

Parameter 5

Not used.

Parameter 6

Columnset

Parameter 6 default

CS_RunEditorColumnSet

Parameter 6 description

UID of the column set to use in the Select Files dialog box.

Parameter 6 type

String

Parameter 7

Copy nested references

Parameter 7 default

True

Parameter 7 description

Copy nested references for Edit Files

Parameter 7 type

Boolean

The following methods use the EditFiles client API to allow you to edit attached files.

  • EditWorkingDocFiles

  • EditCurrentDocFiles

  • HiddenEditWorkingDocFiles

  • RunEditor