hwIReportTemplate Apply
Applies the report template settings and draws the report.
Syntax
hwIReportTemplate_handle Apply mode, autofit, autocolor, autoposition, (instance)
Application
HyperWorks Tcl Modify
Description
This command applies the report template settings input and draws the report.
Inputs
- mode
- A string representing the mode that the report should be in. Options for the mode variable include: overlay, replace, or append.
- autofit
- A true or false value. If you want the plot of the report (if there is a plot) to be autofit to its curves, true must be input. Otherwise, input false.
- autocolor
- A true or false value. If you want to use the colors preset by the report, input true. Otherwise, input false.
- autoposition
- A true or false value. If you want to place notes in a preset position made by the report, input true. If you do not want notes autopositioned, input false.
- (instance) (Optional)
- This only affects the report if there is more than one appended report, followed by an overlay. The input is a number which determines which appended report the overlay report is applied to.
Example
hwi GetSessionHandle sess;
sess GetClientManagerHandle mgr TextEditor;
mgr Apply overlay true true false 2;Error
Success (0) or an error message is returned.
Keywords
HyperWorks
Tcl
Report Template
Template
Modify