Hotspotter utilities component reference - SmartPlant Foundation - IM Update 44 - Customization & Programming - Hexagon

SmartPlant Foundation Customization

Language
English
Product
SmartPlant Foundation
Search by Category
Customization & Programming
SmartPlant Foundation / SDx Version
10

Properties

HotspotterINI

This property contains the full path name of the SPFHotspotter.ini file. This file contains all the hotspotting rules.

Methods

HotSpotObject

This method hotspots the specified drawing object.

Format:

Public Function HotSpotObject(ByVal pstrMacroCmdLineArgs As String, _
           ByVal pobjDrawingObject As Object, _
           ByVal pstrText As String, _
           Optional ByVal pstrInterface As String = "IObject") As Boolean

 

Arguments:

Name

Input/Output

Description

PstrMacroCmdLineArgs

Input

The command line arguments passed to the macro

PobjDrawingObject

Input

Any SmartSketch drawing object (for example: circles, groups, text boxes, etc.)

PstrText

Input

The text to look up in the SmartPlant Foundation database when the hotspotted graphic is selected.

PstrInterface

Input

The interface used to search for the text. If this argument is omitted, then IObject is used.

Return Value:

This method returns True if successful, False otherwise.

IsObjectHotSpotted

This method determines if the specified drawing object is hotspotted.

Format:

Public Function IsObjectHotSpotted(ByVal pobjDrawingObject As Object) As Boolean

Arguments:

Name

Input/Output

Description

pobjDrawingObject

Input

Any SmartSketch drawing object (for example: circles, groups, text boxes, etc.)

Return Value:

This method returns True if the object is already hotspotted, False otherwise.