Custom module class properties - 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

When you create a custom module, it inherits the attributes from the SPEModuleBase class, which provides a number of properties that you can set.

IsLoginRequired

When this Boolean property is set, the user must log in to the server and projects you have access to before the Dashboard is loaded. If there are no modules in the Dashboard that require you to log in, then the Log In screen will not appear. If there is one module that does require a login, then the log in screen will always appear; regardless of the settings for any other modules.

DisplayName

This property allows you to set the name of the custom module and what text appears in the Page Title section on the title bar in the main SmartPlant Foundation Dashboard window.

DisplayDescription

This property allows you to set the tool tip that appears when a user pauses the cursor over a custom module on the main SmartPlant Foundation Dashboard homepage.

ImageName

This property sets the name of the image used for your custom module on the SmartPlant Foundation Dashboard homepage. It must be present in the Images folder, which is located below the folder that contains the application executable. You can see some examples and how they are deployed in the Desktop Client solution. An example for the image is the SPFCustomModule.png, which is a place holder image.