ISPFClientAPI interface - 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)

This interface controls the behavior of the methods for menu items, quick find items, toolbars, drill down items, and shortcut menu commands.

The client API is defined in the code delivered with SmartPlant Foundation. The methods are defined by the API with configured arguments.

The following properties are found on this interface:

Name

Description

Set on

SPFAPIParam1-10

The label as seen on the New/Update Method form.

New/Update Client API form

SPFAPIParam1-10Description

Tooltip on the New/Update Method form.

New/Update Client API form

SPFAPIParam1-10Type

Provides validation of input on the New/Update Method form (Boolean, Integer, string).

New/Update Client API form

SPFAPIParam1-10Default

The default method argument.

New/Update Client API form

SPFNoOfObjsRestrictedTo

Determines if multi-select is supported

New/Update Client API form

SPFIsACreateConfigurationAPI

API is a create configuration client API.

New/Update Client API form

SPFIsAnObjectConfigurationAPI

When set to True, allows methods created from this API to be available on the shortcut menu of objects, even when your create scope is set to a different configuration than the one where the object is located. When set to False, the method will appear only when the correct create configuration is set.

New/Update Client API form

Functionality configured on ISPFClientAPI

The following commands are configured on this interface: Copy, Terminate, and Update.