Global::pdsShowCustomHelp Method [AX 2012]
Show custom HTML help for Process enhanced forms when there is application documentation.
Syntax
client public static boolean pdsShowCustomHelp(FormRun _form, int _taskId)
Run On
Client
Parameters
- _form
Type: FormRun Class
Running form or dialog.
- _taskId
Type: int
Task id value passed to task method
Return Value
Type: boolean
true if this method displayed custom help; false otherwise.
Remarks
This method should be used in cases where the standard form ignores the form help properties because there is an Application Documentation node for the class, menu item, or report. Note that help for reports always exist in an Application Documentation node.
To provide the custom help file and topic, this method will look for a special method in the caller: pdsHtmlHelp.
public container pdsHtmlHelp() { #define.PmfHelpFile('PMFHelp') #define.MyFormHelpTopc('PMF.chm://html/myhelptopic.html') ; return [#PmfHelpFile, #MyFormHelpTopic]; } The pdsHtmlHelp method must return a container with two element. Element 1 is the help file, element 2 is the help topic. This method may return a container with a differing number of elements, such as connull(), to signify that there is no applicable custom help.
For reports, you may add the method to the report object. For dialog started from a class (standard dialog forms based on Dialg), add the method to the class.
For other forms, in addition to adding the pdsHtmlForm method to the form, you will need to override the task method and call pdsShowCustomHelp(this, _taskId).
In this case, do not call super() if pdsShowCustomHelp returns true otherwise two different help pages will be shown.