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

SmartPlant Foundation Web Client Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10

The CorrelateListEditContextMenu client API is used to open a list edit control for managing auto-correlation rules.

Argument

Description

Parameter 1

List title

Parameter 1 default

None

Parameter 1 description

The title that will appear at the top of the list edit window.

Parameter 1 type

String

Parameter 2

Class definition for new rows

Parameter 2 default

None

Parameter 2 description

The class definition to use when creating new objects in rows in the list edit view.

Parameter 2 type

String

Parameter 3

Delete action

Parameter 3 default

Terminate

Parameter 3 description

Indicate what should happen when items are deleted from the list edit view. The options are Delete to have the object deleted from the database or Terminate to have the object terminated but not deleted from the database.

Parameter 3 type

String

Parameter 4

Column set name

Parameter 4 default

None

Parameter 4 description

Column set to be used to display the selected items in the list edit window.

Parameter 4 type

String

Parameter 5

List Management relationship definition

Parameter 5 default

None

Parameter 5 description

The relationship definition (prefixed with a + or -) to relate list items to a new or existing list management object. This is needed for list management functionality.

Parameter 5 type

String

Parameter 6

List Management query method

Parameter 6 default

None

Parameter 6 description

The UID of the query method to be used to query for an existing list management object. This is needed for list management functionality.

Parameter 6 type

String

Parameter 7

List Management create method

Parameter 7 default

None

Parameter 7 description

The UID of the create method to be used to create a new list management object. This is needed for list management functionality.

Parameter 7 type

String

Parameter 8

List Management button caption

Parameter 8 default

None

Parameter 8 description

The text that wiil be appended to the caption of the Save As buttons enabled by parameters 6 and 7. This is needed for list management functionality.

Parameter 8 type

String

The AutoCorrelateRulesListEdit method uses the CorrelateListEditContextMenu client API to open a list edit control where you can manage the auto-correlation rules.