ShowPublishDialog As Long - HxGN SDx - Update 64 - Customization & Programming - Hexagon

This method should be called in conjunction with GetDocumentListContainerForPublish. Before calling this method, the design tool would identify the selected documents by adding them to IContainer returned by the GetDocumentListContainerForPublish method. When called, the ShowPublishDialog method would display the Publish window with the list of documents in the tree view control passed in the IContainer object. When the user clicks OK in the Publish dialog box, business logic code will call ISPAdapter to generate XML for each document.

The ShowPublishDialog method completes the transaction started by the GetDocumentListContainerForPublish method if the method is successful. The following steps take place in the ShowPublishDialog method.

The Publish dialog box is displayed.

After the user makes selections in the Publish dialog box:

• ServiceManager calls ISPAdapter to generate document XML for each document.

• ServiceManager calls the SPCLClient publish method for each document unless you select Scheduled Publish in the Publish dialog box. If you select Scheduled Publish, ServiceManager sends your selections to the tool adapter using the ISPAdapter4 interface instead of continuing with the normal publish process.

ServiceManager later calls ISPAdapter to let SPAdapter know each document published successfully.

The default hierarchy for documents in the tree on the SPCLCommonUIApplicationUI’s Publish dialog box is DocumentClass> DocumentType1 > DocumentType2. To make documents appear in a custom hierarchy, add objects and relationships to oDocIContainer:

Arguments

Return Value

• 0 if method is successful.

• 1 if user cancels the operation in Publish dialog.

• A negative number if method fails. (Check the LastErrorMessage property for error message)

Comments

The design tool should release all local pointers to IContainer passed in the ShowPublishDialog method after the method is called successfully.