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

Append Front Panel Image to Report VI

LabVIEW 2013 Help

Edition Date: June 2013

Part Number: 371361K-01

»View Product Info

Owning Palette: Report Generation VIs

Requires: Base Development System

Creates an image of the front panel of the VI you specify in VI and appends it to a report. Wire data to the VI input to determine the polymorphic instance to use or manually select the instance.

The VI also includes an instance whose connector pane is compatible with versions of the VI in LabVIEW 6.1 and earlier.

Details  

Use the pull-down menu to select an instance of this VI.

Append Front Panel Image to Report (path)

image format sets the format in which to save the image.

0PNG
1JPEG (default)
2GIF
alignment sets the alignment of the image in a report. The VI ignores this input for standard reports. (Report Generation Toolkit) For Microsoft Word reports, you can use only the LEFT, RIGHT, and MIDDLE options.

0(default)—The VI does not add an ALIGN attribute to the <IMG> tag.
1LEFT
2RIGHT
3TOP
4TEXTTOP
5MIDDLE
6ABSMIDDLE
7BASELINE
8BOTTOM
9ABSBOTTOM
report in is a reference to the report whose appearance, data, and printing you want to control. Use the New Report VI to generate this LabVIEW class object.
VI is the path to the VI whose image you want to append to the report. The default is the path to the VI that contains this VI as a subVI.
description is the description of the graphic to display if you open the HTML report in a Web browser set to display text only.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
If visible area only? is TRUE, the VI creates an image of only the currently visible portion of the front panel. The default is FALSE.
MS Office parameters (Report Generation Toolkit) specifies the point in a Microsoft Word or Excel report where you want an insertion to occur. The VI ignores this input for HTML and standard reports. You can specify a bookmark in Word or a named range or cell coordinates in Excel. If you set the report type to Word but do not specify a bookmark, the insertion occurs at the end of the document.
position contains the row and column coordinates of the point in an Excel worksheet from which the insertion occurs. Row and column values in Excel are zero-based, so the row and column coordinates of (0,0) correspond to cell A1.
rows specifies the row index.
columns specifies the column index.
name contains the name of the cell in a Microsoft Excel worksheet from which the insertion occurs.
bookmark contains the name of the bookmark in a Word document from which the insertion occurs.
report out is a reference to the report whose appearance, data, and printing you want to control. You can wire this output to other Report Generation VIs.
VI path out returns VI unchanged.
start out (Report Generation Toolkit) represents the index of the character at the beginning of the text inserted in the Microsoft Word document. The VI ignores this input for HTML and standard reports.
end out (Report Generation Toolkit) represents the index of the character at the end of the text inserted in the Microsoft Word document. The VI ignores this input for HTML and standard reports.
error out contains error information. This output provides standard error out functionality.

Append Front Panel Image to Report (refnum)

image format sets the format in which to save the image.

0PNG
1JPEG (default)
2GIF
alignment sets the alignment of the image in a report. The VI ignores this input for standard reports. (Report Generation Toolkit) For Microsoft Word reports, you can use only the LEFT, RIGHT, and MIDDLE options.

0(default)—The VI does not add an ALIGN attribute to the <IMG> tag.
1LEFT
2RIGHT
3TOP
4TEXTTOP
5MIDDLE
6ABSMIDDLE
7BASELINE
8BOTTOM
9ABSBOTTOM
report in is a reference to the report whose appearance, data, and printing you want to control. Use the New Report VI to generate this LabVIEW class object.
VI is a reference to the VI whose data you want to append to the report. The default is a reference to the VI that contains this VI as a subVI.
description is the description of the graphic to display if you open the HTML report in a Web browser set to display text only.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
If visible area only? is TRUE, the VI creates an image of only the currently visible portion of the front panel. The default is FALSE.
MS Office parameters (Report Generation Toolkit) specifies the point in a Microsoft Word or Excel report where you want an insertion to occur. The VI ignores this input for HTML and standard reports. You can specify a bookmark in Word or a named range or cell coordinates in Excel. If you set the report type to Word but do not specify a bookmark, the insertion occurs at the end of the document.
position contains the row and column coordinates of the point in an Excel worksheet from which the insertion occurs. Row and column values in Excel are zero-based, so the row and column coordinates of (0,0) correspond to cell A1.
rows specifies the row index.
columns specifies the column index.
name contains the name of the cell in a Microsoft Excel worksheet from which the insertion occurs.
bookmark contains the name of the bookmark in a Word document from which the insertion occurs.
report out is a reference to the report whose appearance, data, and printing you want to control. You can wire this output to other Report Generation VIs.
VI out returns VI unchanged.
start out (Report Generation Toolkit) represents the index of the character at the beginning of the text inserted in the Microsoft Word document. The VI ignores this input for HTML and standard reports.
end out (Report Generation Toolkit) represents the index of the character at the end of the text inserted in the Microsoft Word document. The VI ignores this input for HTML and standard reports.
error out contains error information. This output provides standard error out functionality.

Append Front Panel Image to Report (string)

image format sets the format in which to save the image.

0PNG
1JPEG (default)
2GIF
alignment sets the alignment of the image in a report. The VI ignores this input for standard reports. (Report Generation Toolkit) For Microsoft Word reports, you can use only the LEFT, RIGHT, and MIDDLE options.

0(default)—The VI does not add an ALIGN attribute to the <IMG> tag.
1LEFT
2RIGHT
3TOP
4TEXTTOP
5MIDDLE
6ABSMIDDLE
7BASELINE
8BOTTOM
9ABSBOTTOM
report in is a reference to the report whose appearance, data, and printing you want to control. Use the New Report VI to generate this LabVIEW class object.
VI is the name of the VI whose data you want to append to the report. The default is the name of the VI that contains this VI as a subVI. The VI must be in memory.
description is the description of the graphic to display if you open the HTML report in a Web browser set to display text only.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
If visible area only? is TRUE, the VI creates an image of only the currently visible portion of the front panel. The default is FALSE.
MS Office parameters (Report Generation Toolkit) specifies the point in a Microsoft Word or Excel report where you want an insertion to occur. The VI ignores this input for HTML and standard reports. You can specify a bookmark in Word or a named range or cell coordinates in Excel. If you set the report type to Word but do not specify a bookmark, the insertion occurs at the end of the document.
position contains the row and column coordinates of the point in an Excel worksheet from which the insertion occurs. Row and column values in Excel are zero-based, so the row and column coordinates of (0,0) correspond to cell A1.
rows specifies the row index.
columns specifies the column index.
name contains the name of the cell in a Microsoft Excel worksheet from which the insertion occurs.
bookmark contains the name of the bookmark in a Word document from which the insertion occurs.
report out is a reference to the report whose appearance, data, and printing you want to control. You can wire this output to other Report Generation VIs.
VI name out returns VI unchanged.
start out (Report Generation Toolkit) represents the index of the character at the beginning of the text inserted in the Microsoft Word document. The VI ignores this input for HTML and standard reports.
end out (Report Generation Toolkit) represents the index of the character at the end of the text inserted in the Microsoft Word document. The VI ignores this input for HTML and standard reports.
error out contains error information. This output provides standard error out functionality.

Append Front Panel Image to Report Details

For an HTML report, the VI saves the image file to the temporary directory and adds a link to the image file in the report. (Windows) For a standard report, the VI appends the image to the report.

If a front panel is not visible, LabVIEW does not update the values in the objects on the front panel. If you call a VI whose front panel is not visible and you use the Append Front Panel Image to Report VI to create an image of the front panel, the image does not reflect any value changes that occurred when you ran the VI.

If you want the image to reflect value changes, make sure the front panel is open before any values change. If you do not want to display the front panel but want the image to reflect value changes, create a Property Node from any front panel terminal on the block diagram of the VI for which you want to create a front panel image.

Note  If you set Image Format to GIF, the VI does not work when you include it in a stand-alone application.

You also can use the following methods to return a front panel image programmatically:


 

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