Base wizard overrides - 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

These methods are available for overriding; the training assembly exposes some of these.

When you want to add a button to the bottom of the wizard use this method (AddButton).

Public Overridable Function AddButton(ByVal pstrName As String, ByVal pstrDisplayAs As String, ByVal pintWidth As Integer) As SPFFooterButton

The following method (IsButtonDisplayed) will return a button if it is being displayed; this is useful when you are moving between pages adding and removing buttons.

Public Overridable Function IsButtonDisplayed(ByVal pstrName As String) As Button

OnGetContainer is called when you hit Apply or Finish and will call the form page control to get a list of objects to add into the container that will eventually be sent to the server.

Public Overridable Function OnGetContainer() As IobjectDictionary

OnInitializeGeneral is called when the form is displayed

Public Overridable Sub OnInitializeGeneral()

OnRefreshButtonPanel refreshes the button panel; this is called when the form is initialized and pages turned.

Public Overridable Sub OnRefreshButtonPanel()

Called before any request is sent to the server, OnBuildAndSubmitServerRequest calls the WizardProcessor Sserver API, internally calls OnAddCreatingContainer

Public Overridable Function OnBuildAndSubmitServerRequest(ByVal pobjContainer As IObjectDictionary) As ServerRequest

OnAddCreatingContainer calls the GetNode method on the container passed in and allows you to change what is in the container sent to the server.

Public Overridable Sub OnAddCreatingContainer(ByVal pobjServerReq As ServerRequest, ByVal pobjContainer As IObjectDictionary)