Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
pr_methods:geteditcommand [2023/04/04 07:33] – removed - external edit (Unknown date) 127.0.0.1pr_methods:geteditcommand [2023/05/03 04:23] (current) – sean
Line 1: Line 1:
 +{{tag>Programmers_Reference Methods IDOCEngineClient_Interface geteditcommand Index}}
  
 +====getEditCommand ()====
 +<code java>public FileToEdit getEditCommand (String filePath)</code>
 +
 +This method must return the operating system specific command that should be invoked to edit a document template of the new type. This command is invoked when the user presses the Edit button in the Document Template Property Editor of the Configuration Tool.
 +
 +===Parameters===
 +
 +|''filePath''|the full path of the document template to be edited.|
 +
 +===Returns===
 +A structure that contains the command line and file identifier. The resulting command is formed by concatenating the command line with the file identifier (separated by the space symbol). If method returns ''null'', the document template is not editable. If the command line returned as part of the ''FileToEdit'' structure is empty, the document template is editable but it is up to the user to select the editor for the document template (the Configuration Tool in this case will offer a dialog to select the program to edit the document template).