Jump to content

Pane class: Difference between revisions

From LabVIEW Wiki
VisualWikitext
Started page
 
m Removed VI Server Category from page
 
(2 intermediate revisions by the same user not shown)
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
<!--Edit Properties, Methods, or Events in the appropriate table in one on the VI Server Templates-->
<span class="mw-customtoggle-propertiestable">Show/Hide Pane Properties Table</span>
{{VIServerClassTables|75}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ Pane Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|18166803
| [[Pane class/AllObjs() property|AllObjs()]]
|Array of references to all the objects (controls and decorations) on the pane.
|R
|X
|- style="background-color:#FFFFCC;"
|1816680B
| [[Pane class/BackgroundImage property|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 <b>Browse</b> option on the Appearance page of the <b>Pane Properties</b> 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.
 
{| class="wikitable"
|+ scope="col" style="text-align:left;"|Elements:
! scope="col" style="text-align:left;"| Name
! scope="col" style="text-align:left;"| Description
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Image Type
| Reserved for future use.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|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.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|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.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|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.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|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.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|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&#8212;The horizontal coordinate of the left edge of the rectangle.
*Top&#8212;The vertical coordinate of the top edge of the rectangle.
*Right&#8212;The horizontal coordinate of the right edge of the rectangle.
*Bottom&#8212;The vertical coordinate of the bottom edge of the rectangle.
|}
|R/W
|X
|- style="background-color:#FFFFCC;"
|1816680A
| [[Pane class/BackgroundMode property|BackgroundMode]]
|Sets the positioning of the background image in the pane.
 
This property is similar to the <b>Position</b> option on the Appearance page of the <b>Pane Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18166808
| [[Pane class/ContentRect property|ContentRect]]
|Returns the bounding rectangle of the content area of the pane in the coordinate system of the pane.
 
{| class="wikitable"
|+ scope="col" style="text-align:left;"|Elements:
! scope="col" style="text-align:left;"| Name
! scope="col" style="text-align:left;"| Description
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Left
|The horizontal coordinate of the left edge of the bounding rectangle.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Top
|The vertical coordinate of the top edge of the bounding rectangle.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Right
|The horizontal coordinate of the right edge of the bounding rectangle.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Bottom
|The vertical coordinate of the bottom edge of the bounding rectangle.
|}
|R
|X
|- style="background-color:#FFFFCC;"
|18166801
| [[Pane class/Controls() property|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
|- style="background-color:#FFFFCC;"
|18166802
| [[Pane class/Decorations() property|Decorations()]]
|Array of references to the decorations in the pane.
|R
|X
|- style="background-color:#FFFFCC;"
|18166806
| [[Pane class/HorizScrollbarVisibility property|HorizScrollbarVisibility]]
|Gets or sets the horizontal scroll bar visibility of the pane.
 
If <b>Always On</b>, the pane displays the horizontal scroll bar at all times. If <b>Always Off</b>, the pane does not display the horizontal scroll bar at any time. If <b>Off While Running</b>, the pane displays the horizontal scroll bar at edit time and hides it at run time. This property is similar to selecting <b>Horizontal Scrollbar</b> from the shortcut menu.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18166809
| [[Pane class/Label property|Label]]
|Reference to the label object.
|R
|X
|- style="background-color:#FFFFCC;"
|18166804
| [[Pane class/MinPaneSize property|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.
 
{| class="wikitable"
|+ scope="col" style="text-align:left;"|Elements:
! scope="col" style="text-align:left;"| Name
! scope="col" style="text-align:left;"| Description
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Horizontal
|The minimum width of the pane in pixels.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Vertical
|The minimum height of the pane in pixels.
|}
|R/W
|X
|- style="background-color:#FFFFCC;"
|18166805
| [[Pane class/Origin property|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.
 
{| class="wikitable"
|+ scope="col" style="text-align:left;"|Elements:
! scope="col" style="text-align:left;"| Name
! scope="col" style="text-align:left;"| Description
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Horizontal
|The horizontal coordinate of the upper left corner of the pane.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Vertical
|The vertical coordinate of the upper left corner of the pane.
|}
|R/W
|X
|- style="background-color:#FFFFCC;"
|18166800
| [[Pane class/Color property|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
|- style="background-color:#FFFFCC;"
|1816680C
| [[Pane class/ScrlToOrigAtRunTi property|ScrlToOrigAtRunTi]]
|
|R/W
|X
|- style="background-color:#FFFFCC;"
|18166807
| [[Pane class/VertScrollbarVisibility property|VertScrollbarVisibility]]
|Gets or sets the vertical scroll bar visibility of the pane.
 
If <b>Always On</b>, the pane displays the vertical scroll bar at all times. If <b>Always Off</b>, the pane does not display the vertical scroll bar at any time. If <b>Off While Running</b>, the pane displays the vertical scroll bar at edit time and hides it at run time. This property is similar to selecting <b>Vertical Scrollbar</b> from the shortcut menu.
|R/W
|X
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide Pane Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ Pane Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#FFFFCC;"
|64AFA40A
| [[Pane class/CvtPaneToPanelCoords method|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
|- style="background-color:#FFFFCC;"
|64AFA40B
| [[Pane class/CvtPanelToPaneCoords method|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
|- style="background-color:#FFFFCC;"
|64AFA409
| [[Pane class/Get Scaling method|Get Scaling]]
|Gets the scaling mode for the pane.
 
If you select <b>Scale Single Object</b>, <b>Scalable Object</b> returns a reference to the front panel control or indicator that is set to scale. In the other cases, <b>Scalable Object</b> returns Not a Refnum.
|X
|- style="background-color:#CCFFFF;"
|64AFA404
| [[Pane class/Group Objects method|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.
|
|- style="background-color:#CCFFFF;"
|64AFA405
| [[Pane class/Lock Objects method|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.
|
|- style="background-color:#CCFFFF;"
|64AFA400
| [[Pane class/MakeSpace method|MakeSpace]]
|Makes space in the pane by moving objects out of a location in a specified direction.
|
|- style="background-color:#CCFFFF;"
|64AFA403
| [[Pane class/Paste Selection method|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.
|
|- style="background-color:#CCFFFF;"
|64AFA402
| [[Pane class/Select All method|Select All]]
|Selects all objects in the pane.
|
|- style="background-color:#FFFFCC;"
|64AFA408
| [[Pane class/Set Scaling method|Set Scaling]]
|Sets the scaling mode for objects within the pane.
 
If you select <b>Scale Single Object</b>, you must wire a valid reference to a front panel control or indicator that the pane owns to <b>Scalable Object</b>. Otherwise, LabVIEW returns an error.
|X
|- style="background-color:#CCFFFF;"
|64AFA406
| [[Pane class/Ungroup Objects method|Ungroup Objects]]
|Ungroups pane objects.  If the Objects parameter is not wired, currently selected objects are ungrouped.
|
|- style="background-color:#CCFFFF;"
|64AFA407
| [[Pane class/Unlock Objects method|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.
|
|}
</div>
 
==Events==
<span class="mw-customtoggle-eventstable">Show/Hide Pane Events Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-eventstable">
{{VIServerLegend}}
{| class="wikitable sortable"
|+ Pane Events Table
! Code
! Name
! Type
|- style="background-color:#FFFFCC;"
|1073741842
|[[Pane class/Mouse Down event|Mouse Down]]
|Notify
|- style="background-color:#FFFFCC;"
|2147483655
|[[Pane class/Mouse Down? event|Mouse Down?]]
|Filter
|- style="background-color:#FFFFCC;"
|1073741839
|[[Pane class/Mouse Enter event|Mouse Enter]]
|Notify
|- style="background-color:#FFFFCC;"
|1073741838
|[[Pane class/Mouse Leave event|Mouse Leave]]
|Notify
|- style="background-color:#FFFFCC;"
|1073741833
|[[Pane class/Mouse Move event|Mouse Move]]
|Notify
|- style="background-color:#FFFFCC;"
|1073741832
|[[Pane class/Mouse Up event|Mouse Up]]
|Notify
|- style="background-color:#FFFFCC;"
|1073741905
|[[Pane class/Mouse Wheel event|Mouse Wheel]]
|Notify
|- style="background-color:#FFFFCC;"
|1073741884
|[[Pane class/Pane Size event|Pane Size]]
|Notify
|- style="background-color:#FFFFCC;"
|2147483699
|[[Pane class/Shortcut Menu Activation? event|Shortcut Menu Activation?]]
|Filter
|- style="background-color:#FFFFCC;"
|1073741876
|[[Pane class/Shortcut Menu Selection (User) event|Shortcut Menu Selection (User)]]
|Notify
|}
</div>


== History ==
== History ==
Line 336: Line 25:
*[[VI Scripting]]
*[[VI Scripting]]


[[Category:VI Server]]
 
[[Category:VI Server Class]]
[[Category:VI Server Class]]
[[Category:VI Scripting]]

Latest revision as of 02:03, 8 May 2020

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name Pane class
Class ID 75
Scope Basic Development Environment
Class Inheritance
Class Children

This class has no children.


This article is a stub. You can help LabVIEW Wiki by expanding it.
Please improve this article if you can.

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

Properties

Show/Hide Pane Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Pane Properties Table
Property ID Long Name (English) Description R/W RTE
18166800Pane ColorBackground color of the pane.Read/WriteYes
18166801Controls[]Array of references to the controls and indicators on the pane.Read OnlyYes (Read Only)
18166802Decorations[]Array of references to the decorations in the pane.Read OnlyYes (Read Only)
18166803All Objects[]Array of references to all the objects (controls and decorations) on the pane.Read OnlyYes (Read Only)
18166804Minimum Pane SizeIf 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.Read/WriteYes
18166805OriginA 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.Read/WriteYes
18166806Horizontal Scrollbar VisibilityGets or sets the horizontal scroll bar visibility of the pane.Read/WriteYes
18166807Vertical Scrollbar VisibilityGets or sets the vertical scroll bar visibility of the pane.Read/WriteYes
18166808Content Area RectReturns the bounding rectangle of the content area of the pane in the coordinate system of the pane.Read OnlyYes
18166809LabelReference to the label object.Read OnlyYes
1816680ABackground ModeSets the positioning of the background image in the pane.Read/WriteYes
1816680BBackground ImageSets the background image the pane uses. LabVIEW supports BMP, JPEG, and PNG graphic formats for background images.Read/WriteYes
1816680CScroll To Origin At Run TimeRead/WriteYes

Methods

Show/Hide Pane Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Pane Methods Table
Method ID Long Name (English) Description RTE
64AFA400Make SpaceMakes space in the pane by moving objects out of a location in a specified direction.No
64AFA402Select AllSelects all objects in the pane.No
64AFA403Paste SelectionPastes 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.No
64AFA404Group ObjectsGroups 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.No
64AFA405Lock ObjectsLocks 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.No
64AFA406Ungroup ObjectsUngroups pane objects. If the Objects parameter is not wired, currently selected objects are ungrouped.No
64AFA407Unlock ObjectsUnlocks 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.No
64AFA408Set Scaling ModeSets the scaling mode for objects within the pane.Yes (Read/Write)
64AFA409Get Scaling ModeGets the scaling mode for the pane.Yes (Read/Write)
64AFA40AConvert Pane To Panel CoordinatesConverts the input point from the local pane coordinates to the coordinates of the front panel as the output point.Yes (Read/Write)
64AFA40BConvert Panel To Pane CoordinatesConverts the input point from the front panel coordinates to the coordinates of the local pane as the output point.Yes (Read/Write)

Events

Show/Hide Pane Events Table

Legend
Basic Development Environment
VI Scripting
Private
Deprecated
Pane Events Table
Code Name Description Type
1073741842Mouse DownGenerated when you click the mouse button on a pane.Notify
2147483655Mouse Down?Generated when you click the mouse button on a pane.Filter
1073741839Mouse EnterGenerated when the cursor enters the bounds of the pane.Notify
1073741838Mouse LeaveGenerated when the cursor leaves the bounds of the pane.Notify
1073741833Mouse MoveGenerated when you move the mouse over a pane.Notify
1073741832Mouse UpGenerated when you release the mouse button on a pane. LabVIEW does not generate this event if a shortcut menu appears when you click the mouse button.Notify
1073741905Mouse WheelGenerated when you scroll the mouse wheel over a pane.Notify
1073741884Pane SizeGenerated when the user sizes the pane by clicking and dragging the window frame, clicking and dragging a splitter bar, maximizing the front panel, or when the user restores the pane to its original size from a maximized state.Notify
2147483699Shortcut Menu Activation?Generated when the user right-clicks blank space on the front panel to display the shortcut menu.Filter
1073741876Shortcut Menu Selection (User)Generated when the user selects a user-defined shortcut menu item from the shortcut menu of the pane.Notify


History

History information is needed. What changes have occurred over previous versions?
Version Change(s)
LabVIEW 2018 More info to come.

See Also

Retrieved from "https://labviewwiki.org/w/index.php?title=Pane_class&oldid=26693"