Tutorial Toolkit Function Descriptions > Files > FrameMaker Files
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
FrameMaker Files
The following PCL Functions are useful for capturing graphics to be used in generation of on-line help documents. On-line help is based on FrameMaker (tm) and the files resulting from calls to ui_framemaker are MIF format which is recognized by FrameMaker.
 
ui_form_to_frame
(classname, scale)
Description:
Given the string classname as the name of a class which has a form currently displayed, this function will create a framemaker file classname.mif file which contains the form at a scale factor of scale.
Input:
STRING
classname[]
Name of the PCL class containing the form to be used.
REAL
scale
Scale factor for translation. Optional and defaults to 1.0.
Output:
none
Comments:
Creates FrameMaker objects when imported into a FrameMaker document through the import file menu pick.
Example:
Please see ui_form_to_frame (p. 55) in the MSC Acumen Toolkit - Code Examples.
 
ui_framemaker
( option,[scale] )
Description:
Set automatic framemaker generation. If option is 1, whenever ui_form_display() is called, the classname is echoed to the history window. This gives you the classname in order to type a ui_form_to_frame() command. If option is 2, then whenever ui_form_display() is called, the name of the class is echoed, and a call is automatically made to ui_form_to_frame() with the specified scale factor. If option is 0, then ui_form_display() reverts back to normal operation.
Input:
INTEGER
option
Specifies how the function works. See Description above.
REAL
scale
Scale factor for translation. Optional and defaults to 1.0.
Output:
none
Example:
Please see ui_framemaker (p. 56) in the MSC Acumen Toolkit - Code Examples.