Company Events Academic Community Support Solutions Products & Services Contact NI MyNI

Print:VI To RTF Method

LabVIEW 2013 Help

Edition Date: June 2013

Part Number: 371361K-01

»View Product Info

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.

Parameters

Data typeNameRequiredDescription
RTF File PathYesPath 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?NoSpecifies whether LabVIEW appends the new information to an existing file. The default is FALSE.
FormatNoSpecifies 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.

0Custom (default)—Use the Property Node with the Application class printing properties to specify the format
1Standard—Prints the VI description, icon and connector pane, front panel, and block diagram.
2Using 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.
3Using 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.
4Complete—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.
Image FormatNoFormat of the graphics file.

0BMP (default)—BMP is the only format supported.
Image DepthNoSets 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 DirectoryNoPath 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?NoSpecifies 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.

Data typeNo return value
Available in Run-Time EngineNo
Available in Real-Time Operating SystemYes
Settable when the VI is runningYes
Loads the front panel into memoryYes
Need to authenticate before useNo
Loads the block diagram into memoryNo
Remote access allowedYes
Must wait until user interface is idleYes
Available with control VIsYes
Available with global VIsYes
Available with strict type definitionsNo
Available with polymorphic VIsYes

 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit