Print:VI To RTF Method

LabVIEW 8.2 Help
August 2006

NI Part Number:
371361B-01

»View Product Info

Method of VI.

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. Example

Parameters

Name

Description

RTF File Path

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?

Specifies whether the new information will be appended to an existing file. The default is FALSE.

Format

Specifies which VI information to print and the format of the printout. You can select from Custom, Standard, Using Panel, Using SubVI, and Complete.

0	Custom (default)—Use the Property Node with the Application class printing properties to specify the format.
1	Standard—Prints the VI description, icon and connector pane, front panel, and block diagram.
2	Using Panel—Prints the VI description, front panel, and controls and indicators, including data types, names, and descriptions. LabVIEW prints the controls and indicators in tabbing order.
3	Using SubVI—Prints the VI description, icon and connector pane, and connected controls and indicators, including data types, names, and descriptions. LabVIEW prints the controls and indicators in tabbing order. This format is similar to the format of the VI and function reference topics in the LabVIEW Help.
4	Complete—Prints the VI description; icon and connector pane; front panel; controls and indicators, including data types, names, and descriptions; block diagram; a list of subVIs, including icons, names, and paths; revision history information; and the VI hierarchy.

If this input is not Custom, LabVIEW ignores all custom format properties in the Application printing property class.

Image Format

Format of the graphics file. The default is 0, which corresponds to the BMP format. BMP is the only format supported.

Image Depth

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

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?

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.

Remarks

The following table lists the characteristics of this method.

Settable when the VI is running	Yes
Need to authenticate before use	No
Loads the block diagram into memory	No
Remote access disallowed	No
Loads the front panel into memory	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
Available in Run-Time Engine and Real-Time Operating System	No

Example

Refer to the Print LLB to RTF VI in the labview\examples\general\printVIs.llb for an example of using the Print:VI To RTF method.

Print:VI To RTF Method

Parameters

Remarks

Example

Resources