Example of Publish dialog box customization (SPCustomPublishDialog) - Integration - Update 46 - Help - Hexagon

SmartPlant Integration .NET Help

Language
English
Product
Integration
Search by Category
Help
SmartPlant Foundation / SDx Version
10
Smart P&ID Version
9 (2019)
Smart Engineering Manager Version
10 (2019)

The following examples show two different ways you can customize the Publish dialog box. The first implements one customized version for all tools participating in integration, and the second allows you to have different versions for each authoring tool.

The example source code for customizing the SmartPlant Common UI Publish dialog box is contained in the <SmartPlant Client.Net installation directory>\SP Test Tool\Source\SPCLTestToolWPF\SPCLTestToolPublishDialogCustom folder.

Registry modifications must be entered correctly. Incorrect entries and values may result in serious damage to your system. You must back up any valued data before making any changes to the registry.

You must have already built the SPCLTestToolPublishDialogCustom.dll. See Build the example source code delivered with SmartPlant Client for more information.

Customizing the SmartPlant Test Tool.Net Publish dialog box

  1. In Registry Editor, locate the HKEY_LOCAL_MACHINE\SOFTWARE\Intergraph\Intergraph SmartPlant Client.NET registry key.

  2. Under Intergraph SmartPlant Client.NET, verify that the SPCustomPublishDialogApplicationBase value is empty.

  3. Locate the string value called SPCustomPublishDialogAssemblyPath, and change the value to ..\<Full path including the filename of SPCLTestToolPublishDialogCustom.dll> (for example, C:\Program Files\SmartPlant\SmartPlant Client.NET\SP Test Tool\SPCLTestToolPublishDialogCustom.dll).

  4. Locate the string value called SPCustomPublishDialogAssemblyTypeName and change the value to Intergraph.SPClient.SPCLTestToolWPF.SPCLTestToolPublishDialogCustom.

  5. Locate the string value called SPCustomPublishDialogPrivateBinPath and verify that the value is empty.

  6. Locate the string value called SPCustomPublishDialogProbeApplicationBase and verify that the value is set to 1.

    SHARED Tip The Registry Editor should look like the following example:

    registry_editor_publishwindow

  7. In SmartPlant Test Tool.Net, click SmartPlant > UI Command > Publish to view the Custom Properties and the Custom Test button on the Publish dialog box.

Creating Custom Publish Dialog Boxes for One or More Different Authoring Tools

  1. In Registry Editor, locate the HKEY_LOCAL_MACHINE\SOFTWARE\Intergraph\Intergraph SmartPlant Client.NET registry key.

  2. Under Intergraph SmartPlant Client.NET, create a new subkey CustomPublishDialog.

  3. Under Intergraph SmartPlant Client.NET, create another subkey for the ToolID of the tool that will be using the custom publish dialog box. In this example, the new subkey is SP Test Tool.

  4. Under the new subkey for your tool, create a new local string value called SPCustomPublishDialogApplicationBase and leave the value empty.

  5. Create a string value called SPCustomPublishDialogAssemblyPath, and change the value to ..\<Full path including the filename of SPCLTestToolPublishDialogCustom.dll> (for example, C:\Program Files\SmartPlant\SmartPlant Client.NET\SP Test Tool\SPCLTestToolPublishDialogCustom.dll).

  6. Create a string value called SPCustomPublishDialogAssemblyTypeName and change the value to Intergraph.SPClient.SPCLTestToolWPF.SPCLTestToolPublishDialogCustom.

  7. Create a string value called SPCustomPublishDialogPrivateBinPath and leave value empty.

  8. Create a string value called SPCustomPublishDialogProbeApplicationBase and set the value to 1.

    SHARED Tip The Registry Editor should look like the following example:

    registry_editor_publishwindow

  9. Under Intergraph SmartPlant Client.NET, verify that the SPCustomPublishDialogApplicationBase value is empty.

  10. Locate the string value called SPCustomPublishDialogAssemblyPath, and change the value to ..\<Full path including the filename of SPCLTestToolPublishDialogCustom.dll> (for example, C:\Program Files\SmartPlant\SmartPlant Client.NET\SP Test Tool\SPCLTestToolPublishDialogCustom.dll).

  11. In SmartPlant Test Tool.Net, click SmartPlant > UI Command > Publish to view the Custom Properties and the Custom Test button on the Publish dialog box.

See Also

SmartPlant Test Tool.Net source code
Build the example source code delivered with SmartPlant Client