Short Name: Print.VI To RTF
Requires: Base Development System
Class: VI Methods
To Use: Create a method.
Saves the VI information to an RTF file.
This method is similar to the Rich Text Format (RTF) file option on the Destination page of the Print dialog box.
|RTF File Path||Yes||Path to the RTF file in which you want to save the VI information. The directory in which you want to save the file must already exist, and you must wire a full path including the RTF filename.|
|Append?||No||Specifies whether LabVIEW appends the new information to an existing file. The default is FALSE.|
|Format||No||Specifies which VI information to print and the format of the printout. You can select from Custom, Standard, Using Panel, Using SubVI, and Complete.
If this input is not Custom, LabVIEW ignores all custom format properties in the Application printing property class.
|Image Format||No||Format of the graphics file.
|Image Depth||No||Sets the color depth, or number of supported colors, of the image: 1 (1-bit, black and white), 4 (4-bit, 16 colors), 8 (8-bit, 256 colors), or 24 (24-bit, true color). The default is 8.|
|Image Directory||No||Path to the directory in which you want to save the graphic files. The directory in which you want to save the files must already exist. If not specified, LabVIEW saves the image files in the same directory as the HTML or RTF file.|
|Help Format?||No||Specifies whether to save the graphics externally and place references in the RTF file. Set this parameter to TRUE if you are creating a help file. The default is FALSE. If TRUE, LabVIEW does not embed the graphics in the RTF file. Instead, LabVIEW saves the graphics as external bitmap files in the directory you wire to the Image Directory parameter, and creates a reference to each bitmap in the RTF file so you can compile the RTF file into a help file. The RTF file also includes footnotes that the RTF-based help compiler uses to identify each topic in a help file. If FALSE, LabVIEW embeds each graphic in the RTF file, and does not add footnotes to the RTF file.|
The following table lists the characteristics of this method.
|Data type||No return value|
|Available in Run-Time Engine||No|
|Available in Real-Time Operating System||Yes|
|Settable when the VI is running||Yes|
|Loads the front panel into memory||Yes|
|Need to authenticate before use||No|
|Loads the block diagram into memory||No|
|Remote access allowed||Yes|
|Must wait until user interface is idle||Yes|
|Available with control VIs||Yes|
|Available with global VIs||Yes|
|Available with strict type definitions||No|
|Available with polymorphic VIs||Yes|