ardi::frwk

ardi::frwk::addcustompackage args

Registers Tcl package to load containing custom module.
Parameters
-directory
directory that contains Tcl package.
default value: ""
-packagename
name of Tcl pacage.
k
default value: ""
Returns
1 for ok
tcl-error in case of error public method addcustompackage { args }

ardi::frwk::addcustompath args

Registers additional search path(s) to locate custom modules.
Parameters
-directory
one or a list of paths separated by blank.
default value: ""
Returns
1 for ok
tcl-error in case of error

ardi::frwk::appendtemplate args

Appends the specified report template to existing report template.
Parameters
-file
filename of report template.
default value: ""
Returns
1 for ok
tcl-error in case of error

ardi::frwk::execute args

Executes the current report template.
Parameters
-id
id of the items to be executed.
default value: "root" all items in the report will be executed
Returns
1 for ok

ardi::frwk::export args

Exports the MS-Office report based on current report template.
Parameters
-file
filename of MS-Office report including extension.
default value: ""
Returns
1 for ok
tcl-error in case of error

ardi::frwk::getmasterdocument

Queries the current MS-office master template file based on current report format (Word, ppt).
Returns
the current MS-Office master template file.

ardi::frwk::getreporttype

Queries the MS-office report type.
Returns
the current MS-Office report type (Word, ppt).

ardi::frwk::getworkdir

Queries the current work directory.
Returns
the current work directory.

ardi::frwk::loadtemplate args

Loads the specified report template.
Parameters
-file
filename of report template.
default value: ""
-filelist
Optional. List of filenames as seen on "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

ardi::frwk::newreport args

Creates new report template.
Parameters
-type
type of report (Word, ppt).
default value: ""
Returns
1 for ok
tcl-error in case of error

ardi::frwk::quit

Quits ARD.
Parameters
-mode
values: interactive (interactive with GUI), mute (engine only, no GUI).
default value: ""
Returns
1 for ok
tcl-error in case of error

ardi::frwk::registertype

Register a new type relating to an editor.
Parameters
-type
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
ITcl class that contains the editor code. Make sure to use proper namespace for your custom editor to avoid naming clashes.
Returns
1 for ok
tcl-error in case of error

ardi::frwk::savetemplate args

Saves the current report template.
Parameters
-file
filename of report template.
default value: ""
Returns
1 for ok
tcl-error in case of error

ardi::frwk::setmasterdocument args

Sets the MS-Office master template based on current report format (Word, ppt).
Parameters
-file
MS-Office master template file.
default value: ""
Returns
1 for ok
tcl-error in case of error

ardi::frwk::setworkdir args

Sets the work direcgtory to specified path.
Parameters
-directory
path of work directory.
default value: ""
Returns
1 for ok
tcl-error in case of error

ardi::frwk::start args

Starts ARD in desired mode.
Parameters
-mode
values: interactive (interactive with GUI), mute (engine only, no GUI).
default: ""
Returns
1 for ok
tcl-error in case of error

ardi::frwk::templateloadpostcommand args

Specify the callback to be called after a new report template got loaded.
Parameters
-command
command, Tcl procedure or ITcl method to be called.
default value: ""
Returns
1 for ok
tcl-error in case of error

ardi::frwk::templateloadprecommand args

Specify the callback to be called before a new report template is being loaded.
Parameters
-command
command, Tcl procedure or ITcl method to be called.
default value: ""
Returns
1 for ok
tcl-error in case of error