VI class/Print.VI To RTF method

From LabVIEW Wiki
Jump to: navigation, search
VI Server Method Information
Method ID 3EF
Scope Basic Development Environment
Data Name Print.VI To RTF
Short Name* Print.VI To RTF
Long Name* Print:VI To RTF
* Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE.
Owning Class ID 2
Owning Class Name VI Class
Return Data Type No return value
Invoke Node Print:VI To RTF
Available in Real-Time Operating SystemYes
Available in Run-Time EngineNo
Available with control VIsYes
Available with global VIsYes
Available with polymorphic VIsYes
Available with strict type definitionsNo
Loads the block diagram into memoryNo
Loads the front panel into memoryYes
Must wait until user interface is idleYes
Need to authenticate before useNo
Remote access allowedYes
Settable when the VI is runningYes

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.


Data type Name Required Description
Path 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.
Boolean Append? No Specifies whether LabVIEW appends the new information to an existing file. The default is FALSE.
Enum U32 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.
I32 Image Format No Format of the graphics file.
I32 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.
Path 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.
Boolean 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.



Version Change(s)
LabVIEW 2018 More info to come.

See Also

External Links