Table Of Contents

Window Set Background (G Dataflow)

Last Modified: October 24, 2017

Changes the way the background of an image window is displayed.

connector_pane_image
datatype_icon

window number

Number from 0 to 15 that specifies the image window.

Default: 0

datatype_icon

background options in

Cluster that sets the options used to configure the window if Get/Set Status? is TRUE.

This parameter is ignored if Get/Set Status? is False. The following table describes which parameters are valid for each Fill Style option:

Fill Style Hatch Style Fill Color Background Color
Default - - -
Solid - × -
Hatch × × ×
datatype_icon

Fill Color

Color selector that specifies the color used to fill the image window.

datatype_icon

Background Color

Color selector that specifies the background color of the image window.

datatype_icon

Fill Style

Number from 0 to 2 that specifies the fill style for the background color of the image window.

The following are valid values:

Name Value Description
Default 0

uses the default NI Vision background.

Solid 1

specifies a solid background for the window.

Hatch 2

specifies a hatch pattern background for the window.

datatype_icon

Hatch Style

Number from 0 to 5 that specifies the hatch pattern for the background color of the image window.

The following values are valid:

Name Value Description
Horizontal 0

specifies that the background of the display window will be horizontal bars.

Vertical 1

specifies that the background of the display window will be vertical bars.

Forward Diagonal 2

specifies that the background of the display window will be diagonal bars. The bars start in the lower-left corner and end in the upper-right corner of the window.

Backward Diagonal 3

specifies that the background of the display window will be diagonal bars. The bars start in the upper-left corner and end in the lower-right corner of the window.

Cross 4

specifies that the background of the display window will be intersecting horizontal and vertical bars.

Cross Hatch 5

specifies that the background of the display window will be intersecting forward and backward diagonal bars.

datatype_icon

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Default: No error

datatype_icon

get/set?

Boolean value that specifies whether to retrieve (get) or modify (set) the background settings of an image window.

True Modify (set) the background settings of the window.
False Retrieve (get) the background settings of the window.

Default: True

datatype_icon

background options out

background options out returns the current background options for the specified window.

datatype_icon

Fill Style

Number from 0 to 2 that displays the fill style for the background color of the image window.

datatype_icon

Hatch Style

Number from 0 to 5 that displays the hatch pattern for the background color of the image window.

datatype_icon

Fill Color

Color selector that displays the color used to fill the image window.

datatype_icon

Background Color

Color selector that displays is the background color of the image window.

datatype_icon

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Where This Node Can Run:

Desktop OS: Windows

FPGA: Not supported

Web Server: Not supported in VIs that run in a web application


Recently Viewed Topics