Jump to content

Splitter 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 Splitter Properties Table</span>
{{VIServerClassTables|76}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ Splitter Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|7A90C802
| [[Splitter class/Colors property|Colors]]
|Colors of the splitter bar in a (Foreground Color, Background Color) pair.
 
You can set the color of the splitter bar 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 foreground and background colors of the splitter.
 
<b>Note</b>  Not all splitter styles display both the foreground and background colors. You can change the splitter style of a splitter bar by right-clicking the splitter bar and selecting <b>Splitter Style</b> from the shortcut menu.
|R/W
|X
|- style="background-color:#FFFFCC;"
|7A90C804
| [[Splitter class/BGColor property|BGColor]]
|Specifies the background color of the splitter bar.
 
This property is an element of the Colors property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|7A90C803
| [[Splitter class/FGColor property|FGColor]]
|Specifies the foreground color of the splitter bar.
 
This property is an element of the Colors property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|7A90C800
| [[Splitter class/IsVertical? property|IsVertical?]]
|Indicates whether the splitter pane is vertical. This property is TRUE if the splitter pane is vertical and FALSE if it is horizontal.
|R
|X
|- style="background-color:#FFFFCC;"
|7A90C807
| [[Splitter class/Label property|Label]]
|Reference to the label object.
|R
|X
|- style="background-color:#FFFFCC;"
|7A90C806
| [[Splitter class/Sizing property|Sizing]]
|Determines the splitter bar behavior when you resize its owner. The owner of a splitter bar can be the window or another splitter bar.
 
This property is similar to the <b>Splitter Sizing</b> option on the shortcut menu of a splitter bar.
|R/W
|X
|- style="background-color:#FFFFCC;"
|7A90C801
| [[Splitter class/Splitter Position property|Splitter Position]]
|Controls the position of the splitter. If the splitter is vertical, the position is the horizontal coordinate of the left of the splitter. If the splitter is horizontal, the position is the vertical coordinate of the top of the splitter.
 
Wiring a value to this property positions the splitter at the new location as if you had moved the splitter by hand. If the new position violates the minimum size of any pane, LabVIEW returns an error and the splitter does not move. This property is similar to dragging the splitter bar to the front panel position you want.
|R/W
|X
|- style="background-color:#FFFFCC;"
|7A90C805
| [[Splitter class/Splitter Locked property|Splitter Locked]]
|Locks the splitter bar so that it cannot be moved by the user.
 
If TRUE, the user cannot move the splitter bar. If FALSE, the user can freely move the splitter bar by clicking on it and dragging it.
 
This property is similar to selecting <b>Locked</b> from the shortcut menu.
|R/W
|X
|}
</div>
 
==Methods==
''No Methods for this class.''
 
==Events==
<span class="mw-customtoggle-eventstable">Show/Hide Splitter Events Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-eventstable">
{{VIServerLegend}}
{| class="wikitable sortable"
|+ Splitter Events Table
! Code
! Name
! Type
|- style="background-color:#FFFFCC;"
|1073741842
|[[Splitter class/Mouse Down event|Mouse Down]]
|Notify
|- style="background-color:#FFFFCC;"
|2147483655
|[[Splitter class/Mouse Down? event|Mouse Down?]]
|Filter
|- style="background-color:#FFFFCC;"
|1073741839
|[[Splitter class/Mouse Enter event|Mouse Enter]]
|Notify
|- style="background-color:#FFFFCC;"
|1073741838
|[[Splitter class/Mouse Leave event|Mouse Leave]]
|Notify
|- style="background-color:#FFFFCC;"
|1073741833
|[[Splitter class/Mouse Move event|Mouse Move]]
|Notify
|- style="background-color:#FFFFCC;"
|1073741832
|[[Splitter class/Mouse Up event|Mouse Up]]
|Notify
|- style="background-color:#FFFFCC;"
|1073741905
|[[Splitter class/Mouse Wheel event|Mouse Wheel]]
|Notify
|}
</div>


== History ==
== History ==
Line 143: 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 Splitter class
Class ID 76
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 Splitter class is a class in the VI Server Class Hierarchy, (see also VI Server).

Properties

Show/Hide Splitter Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Splitter Properties Table
Property ID Long Name (English) Description R/W RTE
7A90C800Is Vertical?Indicates whether the splitter pane is vertical. This property is TRUE if the splitter pane is vertical and FALSE if it is horizontal.Read OnlyYes
7A90C801Splitter PositionControls the position of the splitter. If the splitter is vertical, the position is the horizontal coordinate of the left of the splitter. If the splitter is horizontal, the position is the vertical coordinate of the top of the splitter.Read/WriteYes
7A90C802ColorsColors of the splitter bar in a (Foreground Color, Background Color) pair.Read/WriteYes
7A90C803Colors:FG ColorSpecifies the foreground color of the splitter bar.Read/WriteYes
7A90C804Colors:BG ColorSpecifies the background color of the splitter bar.Read/WriteYes
7A90C805Splitter Position LockedLocks the splitter bar so that it cannot be moved by the user.Read/WriteYes
7A90C806SizingDetermines the splitter bar behavior when you resize its owner. The owner of a splitter bar can be the window or another splitter bar.Read/WriteYes
7A90C807LabelReference to the label object.Read OnlyYes

Methods

This class has no methods or it inherits methods from its parent: GObject Class.

Events

Show/Hide Splitter Events Table

Legend
Basic Development Environment
VI Scripting
Private
Deprecated
Splitter Events Table
Code Name Description Type
1073741842Mouse DownGenerated when you click the mouse button on a splitter bar.Notify
2147483655Mouse Down?Generated when you click the mouse button on a splitter bar.Filter
1073741839Mouse EnterGenerated when the cursor enters the bounds of the splitter bar.Notify
1073741838Mouse LeaveGenerated when the cursor leaves the bounds of the splitter bar.Notify
1073741833Mouse MoveGenerated when you move the mouse over a splitter bar.Notify
1073741832Mouse UpGenerated when you release the mouse button on a splitter bar. 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 splitter bar.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=Splitter_class&oldid=26696"