ManageFiles 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 ManageFiles client API is used to attach files or delete files from documents, technical queries, and responses.

Argument

Description

Parameter 1

Class name

Parameter 1 default

None

Parameter 1 description

The class definition name of the file object that has to be created

Parameter 1 type

Parameter 2

Reference file not found action

Parameter 2 default

PROMPT

Parameter 2 description

The options are ABORT, CONTINUE, and PROMPT

Parameter 2 type

String

Parameter 3

Delete local files configuration (Not Supported in the Web Client)

Parameter 3 default

True~True

Parameter 3 description

2 ~ separated options (IsChecked~IsEnabled) to control the deletion of local files and to expose the option on the forms

Parameter 3 type

String

Parameter 4

ColumnSet

Parameter 4 default

CS_CopyToLocalColumnSet

Parameter 4 description

The name of the column set used to display files to attach or delete.

Parameter 4 type

String

Parameter 5

DeleteExistingFiles

Parameter 5 default

True

Parameter 5 description

Controls whether to show the delete option in the user interface

Parameter 5 type

Boolean

The following methods use the ManageFiles client API to control which files are attached to a document, technical query, or response.

  • DocManageFiles