Pane class

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name	Pane class
Class ID	75
Scope	Basic Development Environment
Class Inheritance	Generic GObject Pane
Class Children	This class has no children.

The Pane class is a class in the VI Server Class Hierarchy, (see also VI Server).

Properties

Show/Hide Pane Properties Table

Legend
R/W	Readable/Writable Permissions
RTE	Available in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated

Pane Properties Table

Property ID	Short Name (English)	Description	R/W	RTE
18166803	AllObjs()	Array of references to all the objects (controls and decorations) on the pane.	R	X
1816680B	BackgroundImage	Sets the background image the pane uses. LabVIEW supports BMP, JPEG, and PNG graphic formats for background images. This property is similar to the Browse option on the Appearance page of the Pane Properties dialog box. If you want to use a picture to set the image, use the Picture to Pixmap VI to convert the data to an image data cluster before using this method. To use a file to set the image, use the Read JPEG File, Read PNG File, or Read BMP File VIs to convert the data to an image data cluster before using this method. Elements: Name Description Image Type Reserved for future use. Image Depth Specifies the color depth of the image, which is the number of bits to use to describe the color of each pixel in the image. Valid values include 1, 4, 8, and 24 bits per pixel. Image Depth affects how LabVIEW interprets the values of Image and Colors. Image A 1-D array of bytes that describes the color of each pixel in the image in raster order. The value of Image Depth determines how LabVIEW interprets the value of this input. If Image Depth is 24, each pixel has three bytes to describe its color. The first byte for each pixel describes the red value, the second byte describes the green value, and the third byte describes the blue value. If Image Depth is 8, each pixel has one byte to describe its color. The value of each bit corresponds to an element in Colors, which stores 32-bit RGB values where the most-significant byte is zero, followed in order by red, green, and blue values. Valid values include 0 through 255. If Image Depth is 4, the behavior is similar to when Image Depth is 8 except valid values in image include 0 through 15. If Image Depth is 1, any value of zero in Image corresponds to element 0 in Colors. All other values correspond to element 1 in Colors. Mask An array of bytes in which each bit describes mask information for a pixel. The first byte describes the first eight pixels, the second byte describes the next eight pixels, and so on. If a bit is zero, LabVIEW draws the corresponding pixel as transparent. If the array is empty, LabVIEW draws all pixels without transparency. If the array does not contain a bit for each pixel in the image, LabVIEW draws any pixels missing from the array without transparency. Colors An array of RGB color values that correspond to the values in image. The value of Image Depth determines how LabVIEW interprets the value of this input. If Image Depth is 24, LabVIEW ignores this input. If Image Depth is 8, the array can have 256 elements. If Image Depth is 4, the array can have 16 elements. If Image Depth is 1, the array can have 2 elements. Rectangle A cluster that contains coordinates that describe the bounding rectangle in which you want to draw the image. The VI clips the image to the width and height of the rectangle. The bottom and right edges of the rectangle bounds do not contain image pixels. Horizontal coordinates increase to the right, and vertical coordinates increase to the bottom. Left—The horizontal coordinate of the left edge of the rectangle. Top—The vertical coordinate of the top edge of the rectangle. Right—The horizontal coordinate of the right edge of the rectangle. Bottom—The vertical coordinate of the bottom edge of the rectangle.	R/W	X
1816680A	BackgroundMode	Sets the positioning of the background image in the pane. This property is similar to the Position option on the Appearance page of the Pane Properties dialog box.	R/W	X
18166808	ContentRect	Returns the bounding rectangle of the content area of the pane in the coordinate system of the pane. Elements: Name Description Left The horizontal coordinate of the left edge of the bounding rectangle. Top The vertical coordinate of the top edge of the bounding rectangle. Right The horizontal coordinate of the right edge of the bounding rectangle. Bottom The vertical coordinate of the bottom edge of the bounding rectangle.	R	X
18166801	Controls()	Array of references to the controls and indicators on the pane. Use the To More Generic Class and To More Specific Class functions to cast these references to a class other than the Control class.	R	X
18166802	Decorations()	Array of references to the decorations in the pane.	R	X
18166806	HorizScrollbarVisibility	Gets or sets the horizontal scroll bar visibility of the pane. If Always On, the pane displays the horizontal scroll bar at all times. If Always Off, the pane does not display the horizontal scroll bar at any time. If Off While Running, the pane displays the horizontal scroll bar at edit time and hides it at run time. This property is similar to selecting Horizontal Scrollbar from the shortcut menu.	R/W	X
18166809	Label	Reference to the label object.	R	X
18166804	MinPaneSize	If the pane is sizable, this property determines the minimum size to which a pane can be reduced. Setting this property can cause the pane or window to grow if its current size is less than the minimum size. Elements: Name Description Horizontal The minimum width of the pane in pixels. Vertical The minimum height of the pane in pixels.	R/W	X
18166805	Origin	A cluster that contains the vertical and horizontal coordinates of the upper left corner of the pane. The coordinates are relative to the coordinate system of the pane. To convert to panel coordinates, use the Convert Pane To Panel Coordinates method. As the scrollbars on the front panel move, this property returns new coordinates. You can use this property to scroll the pane by setting the origin. Elements: Name Description Horizontal The horizontal coordinate of the upper left corner of the pane. Vertical The vertical coordinate of the upper left corner of the pane.	R/W	X
18166800	Color	Background color of the pane. You can set the color of the pane by wiring an numeric constant with the representation of U32 with the form RRGGBB or the color box constant to the property. This property is similar to using the color picker to specify the color of the pane.	R/W	X
1816680C	ScrlToOrigAtRunTi		R/W	X
18166807	VertScrollbarVisibility	Gets or sets the vertical scroll bar visibility of the pane. If Always On, the pane displays the vertical scroll bar at all times. If Always Off, the pane does not display the vertical scroll bar at any time. If Off While Running, the pane displays the vertical scroll bar at edit time and hides it at run time. This property is similar to selecting Vertical Scrollbar from the shortcut menu.	R/W	X

Methods

Show/Hide Pane Methods Table

Legend
RTE	Available in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated

Pane Methods Table

Method ID	Short Name (English)	Description	RTE
64AFA40A	CvtPaneToPanelCoords	Converts the input point from the local pane coordinates to the coordinates of the front panel as the output point. The pane coordinates are relative to the pane origin. The front panel coordinates are relative to the top left of the window. You can use this method to compare the position of two objects on different panes. Before the conversion, the object coordinates are relative to different origins, but after the conversion, the converted coordinates are all relative to the same position on the front panel.	X
64AFA40B	CvtPanelToPaneCoords	Converts the input point from the front panel coordinates to the coordinates of the local pane as the output point. The front panel coordinates are relative to the top left of the window. The pane coordinates are relative to the pane origin.	X
64AFA409	Get Scaling	Gets the scaling mode for the pane. If you select Scale Single Object, Scalable Object returns a reference to the front panel control or indicator that is set to scale. In the other cases, Scalable Object returns Not a Refnum.	X
64AFA404	Group Objects	Groups pane objects together. If the Objects parameter is not wired, the method groups the currently selected objects. All objects must be in the same pane or an error is returned. After this method executes, the panel selection list contains the grouped objects.
64AFA405	Lock Objects	Locks pane objects. If the Objects parameter is not wired, currently selected objects are locked. After this method executes, the panel selection list contains the locked objects.
64AFA400	MakeSpace	Makes space in the pane by moving objects out of a location in a specified direction.
64AFA403	Paste Selection	Pastes the contents of the clipboard at the specified coordinates in the pane. If the pane is unwired then the default pane is the top left pane.
64AFA402	Select All	Selects all objects in the pane.
64AFA408	Set Scaling	Sets the scaling mode for objects within the pane. If you select Scale Single Object, you must wire a valid reference to a front panel control or indicator that the pane owns to Scalable Object. Otherwise, LabVIEW returns an error.	X
64AFA406	Ungroup Objects	Ungroups pane objects. If the Objects parameter is not wired, currently selected objects are ungrouped.
64AFA407	Unlock Objects	Unlocks objects. If the Objects parameter is not wired, currently selected objects are unlocked. You can select or wire-in multiple locked objects to unlock them.

Events

Show/Hide Pane Events Table

Legend
Basic Development Environment
VI Scripting
Private
Deprecated

Pane Events Table

Code	Name	Type
1073741842	Mouse Down	Notify
2147483655	Mouse Down?	Filter
1073741839	Mouse Enter	Notify
1073741838	Mouse Leave	Notify
1073741833	Mouse Move	Notify
1073741832	Mouse Up	Notify
1073741905	Mouse Wheel	Notify
1073741884	Pane Size	Notify
2147483699	Shortcut Menu Activation?	Filter
1073741876	Shortcut Menu Selection (User)	Notify

History

Version	Change(s)
	More info to come.

See Also

• VI Server Class Hierarchy
• VI Server
• VI Scripting