rpti::frwk
rpti::frwk addconverter
Add converter class, used for version management.
- Syntax
rpti::frwk addconverter
- Parameters
-
- class
- Value: Class Name that implements conversion process.
rpti::frwk addcustompackage
Registers .tcl package to load containing custom module.
- Syntax
rpti::frwk addcustompackage
- Parameters
-
- -directory
- Value: Directory that contains .tcl package.
- -packagename
- Value: Name of .tcl package.
- Returns
- 1 for OK; .tcl-error in case of error.
rpti::frwk addcustompath
Registers additional search path(s) to locate custom modules.
- Syntax
rpti::frwk addcustompath
- Parameters
-
- -directory
- Value: One or a list of paths separated by blank.
- Returns
- 1 for OK, .tcl-error in case of error.
rpti::frwk addview
Add/Register a view for update callbacks.
- Syntax
rpti::frwk addview
- Parameters
-
- view
- Value: View/widget that implements update callbacks.
rpti::frwk appendtemplate
Appends the specified report template to existing report template.
- Syntax
rpti::frwk appendtemplate
- Parameters
-
- -file
- Value: File name of report template.
- Returns
- 1 for OK, .tcl-error in case of error.
rpti::frwk execute
Executes the current report template.
- Syntax
rpti::frwk execute
- Parameters
-
- -id
- Value: ID of the items to be executed.
- Returns
- 1 for OK
rpti::frwk export
Exports the Ms-office report based on current report template.
- Syntax
rpti::frwk export
- Parameters
-
- -file
- Value: File name of Ms-office report including extension.
- Returns
- 1 for OK, .tcl-error in case of error.
rpti::frwk geterrorcount
Get number of errors.
- Syntax
rpti::frwk geterrorcount
- Parameters
- None
rpti::frwk getexportitems
Get number of items marked for export.
- Syntax
rpti::frwk getexportitems
- Parameters
- None
rpti::frwk getinterface
Get Frwk Interface.
- Syntax
rpti::frwk getinterface
- Parameters
-
- -name
- Value: Report session name.
- Returns
- Framework Interface Object
rpti::frwk getmasterdocument
Queries the current Ms-office master template file based on current report format (document, presentation).
- Syntax
rpti::frwk getmasterdocument
- Returns
- The current Ms-office master template file.
rpti::frwk getreporttype
Queries the Ms-office report type.
- Syntax
rpti::frwk getreporttype
- Returns
- The current Ms-office report type (word, ppt).
rpti::frwk getunexecuteditems
Get number of non-executable items.
- Syntax
rpti::frwk getunexecuteditems
- Parameters
- None
rpti::frwk getworkdir
Queries the current work directory.
- Syntax
rpti::frwk getworkdir
- Returns
- The current work directory.
rpti::frwk ispaused
Check if report execution is paused.
- Syntax
rpti::frwk ispaused
rpti::frwk::isrunning
Check if report is running.
- Syntax
rpti::frwk isrunning
rpti::frwk isstarted
Check if report execution started.
- Syntax
rpti::frwk isstarted
rpti::frwk loadtemplate
Loads the specified report template.
- Syntax
rpti::frwk loadtemplate
- Parameters
-
- -file
- Value: File name of report template.
- -filelist
- Value (optional): List of file names as seen in the Report Template dialog or as passed or as used in the order of running HyperWorks in batch mode. See HyperWorks documentation "barchmode" parameter "-tplParams".
- Returns
- 1 for OK, .tcl-error in case of error.
rpti::frwk newreport
Creates new report template.
- Syntax
rpti::frwk newreport
- Parameters
-
- -type
- Value: Type of report (word, ppt).
- Returns
- 1 for OK, .tcl-error in case of error.
rpti::frwk pause
Flags pause execution.
- Syntax
rpti::frwk pause
rpti::frwk quit
Quits Report.
- Syntax
rpti::frwk quit
- Parameters
- None
- Returns
- 1 for OK, .tcl-error in case of error.
rpti::frwk redraw
Notifies all registered views to redraw itself.
- Syntax
rpti::frwk redraw
rpti::frwk registertype
Register a new type relating to an editor.
- Syntax
rpti::frwk registertype
- Parameters
-
- -type
- Value: Unique one-word, all lowercase identifier for the new type. This is the identifier you will need to specify in the module's .xml file.
- -class
- Value: ITcl class that contains the editor code. Make sure to use proper name space for your custom editor to avoid naming clashes.
- Returns
- 1 for OK, .tcl-error in case of error.
rpti::frwk removeview
Remove already registered views.
- Syntax
rpti::frwk removeview
- Parameters
-
- view
- Value: View/widget registered.
rpti::frwk reset
Resets the execution flags.
- Syntax
rpti::frwk reset
rpti::frwk resume
Resets the execution flags.
- Syntax
rpti::frwk resume
rpti::frwk savetemplate
Saves the current report template.
- Syntax
rpti::frwk savetemplate
- Parameters
-
- -file
- Value: File name of report template.
- Returns
- 1 for OK, .tcl-error in case of error.
rpti::frwk setmasterdocument
Sets the Ms-office master template based on current report format (document, presentation).
- Syntax
rpti::frwk setmasterdocument
- Parameters
-
- -file
- Value: Ms-office master template file.
- Returns
- 1 for OK; .tcl-error in case of error.
rpti::frwk setworkdir
Sets the work directory to specified path.
- Syntax
rpti::frwk setworkdir
- Parameters
-
- -directory
- Value: Path of work directory.
- Returns
- 1 for OK; .tcl-error in case of error.
rpti::frwk start
Starts ARD in desired mode.
- Syntax
rpti::frwk start
- Parameters
-
- -mode
- Values: Interactive (interactive with GUI) mute (engine only, no GUI).
- Returns
- 1 for OK, .tcl-error in case of error.
rpti::frwk startexec
Flags execution start.
- Syntax
rpti::frwk startexec
rpti::frwk stop
Flags stop execution.
- Syntax
rpti::frwk stop
rpti::frwk templateloadpostcommand
Specify the callback to be called after a new report template got loaded.
- Syntax
rpti::frwk templateloadpostcommand
- Parameters
-
- -command
- Value: Command, .tcl procedure or ITcl method to be called.
- Returns
- 1 for OK, .tcl-error in case of error.
rpti::frwk templateloadprecommand
Specify the callback to be called before a new report template is being loaded.
- Syntax
rpti::frwk templateloadprecommand
- Parameters
-
- -command
- Value: Command, .tcl procedure or ITcl method to be called.
- Returns
- 1 for OK, .tcl-error in case of error.
rpti::frwk validate
Validate an item.
- Syntax
rpti::frwk validate
- Parameters
-
- -id
- Value: Specify item ID to validate.