Jump to content

TabControl class: Difference between revisions

From LabVIEW Wiki
Started page
 
m Removed VI Server Category from page
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{VIServerClass|name=TabControl|id=55|scope=basic|class_0=Generic|class_1=GObject|class_2=Control|class_3=PageSelector|class_4=TabControl}}
{{VIServerClass|55}}


{{stub}}
{{stub}}
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 TabControl Properties Table</span>
{{VIServerClassTables|55}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ TabControl Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|24DEB40C
| [[TabControl class/MultColors property|MultColors]]
|Allows different colors on each tab control page.
 
After you set this property to TRUE, you can use the Colors property to change the color of the page. If you assign multiple page colors and set Allow Multiple Colors to FALSE, LabVIEW retains the color of each individual page but the tab control reverts to its color before you colored the individual pages. If you set Allow Multiple Colors to TRUE, LabVIEW displays the multiple page colors again.
|R/W
|X
|- style="background-color:#FFFFCC;"
|24DEB402
| [[TabControl class/MultRows property|MultRows]]
|If TRUE, LabVIEW arranges any tabs that extend beyond the width of the tab control into an additional row of tabs. If FALSE, LabVIEW displays navigation buttons on the upper right of the tab control, which you use to scroll through tabs that are not visible.
|R/W
|X
|- style="background-color:#FFFFCC;"
|24DEB40D
| [[TabControl class/Auto Grow? property|Auto Grow?]]
|Specifies if you can auto grow the tab control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|24DEB409
| [[TabControl class/Colors property|Colors]]
|Gets or sets the colors for the foreground and background of the tab control.
 
You can set the color of the front panel object by wiring a hexadecimal number with the form RRGGBB or by wiring the color box constant to the property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|24DEB40B
| [[TabControl class/BGColor property|BGColor]]
|Gets or sets the background color of the tab control.
 
You can set the color of the front panel object by wiring a hexadecimal number with the form RRGGBB or by wiring the color box constant to the property.
 
This property is an element of the Colors property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|24DEB40A
| [[TabControl class/FGColor property|FGColor]]
|Gets or sets the foreground color of the tab control.
 
You can set the color of the front panel object by wiring a hexadecimal number with the form RRGGBB or by wiring the color box constant to the property.
 
This property is an element of the Colors property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|24DEB401
| [[TabControl class/TabDimension property|TabDimension]]
|Gets or sets the tab width, height, or all elements.
 
To set the size of the tabs, you must set the Tab Size property to Fixed Tab Size or right-click the tabs of the tab control and select <b>Advanced&#0187;Tab Size&#0187;Fixed Tab Size</b> from the shortcut menu. You cannot set the tab size smaller than the width and height of the tab caption.
 
This property is similar to the <b>Fixed tab size</b> option on the Appearance page of the <b>Tab Control Properties</b> dialog box.
 
{| 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;"|Width
|Gets or sets tab width when using fixed tab sizes.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Height
|Gets or sets tab height when using fixed tab sizes.
|}
|R/W
|X
|- style="background-color:#FFFFCC;"
|24DEB408
| [[TabControl class/TabHeight property|TabHeight]]
|Gets or sets tab height when using fixed tab sizes.
 
This property is an element of the Fixed Tab Dimension property.
 
This property is similar to the <b>Height</b> option on the Appearance page of the <b>Tab Control Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|24DEB407
| [[TabControl class/TabWidth property|TabWidth]]
|Gets or sets tab width when using fixed tab sizes.
 
This property is an element of the Fixed Tab Dimension property.
 
This property is similar to the <b>Width</b> option on the Appearance page of the <b>Tab Control Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|24DEB403
| [[TabControl class/JustifyTabs property|JustifyTabs]]
|If TRUE, LabVIEW stretches each row of tabs to fill the entire width of the tab control.
 
This property is similar to the <b>Advanced&#0187;Tab Size&#0187;</b>Justify Tabs item on the shortcut menu of a tab control and the <b>Justify</b> option on the Appearance page of the <b>Tab Control Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|24DEB40F
| [[TabControl class/PageLabelsVis? property|PageLabelsVis?]]
|Specifies if the page labels display are visible.
|R/W
|X
|- style="background-color:#FFFFCC;"
|24DEB404
| [[TabControl class/PaneDimension property|PaneDimension]]
|Gets or sets the width and height of the tab control pane.
|R/W
|X
|- style="background-color:#FFFFCC;"
|24DEB406
| [[TabControl class/PaneHeight property|PaneHeight]]
|Gets or sets the tab pane height.
 
This property is an element of the Tab Control Pane Dimension property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|24DEB405
| [[TabControl class/PaneWidth property|PaneWidth]]
|Gets or sets the tab pane width.
 
This property is an element of the Tab Control Pane Dimension property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|24DEB412
| [[TabControl class/TabInto property|TabInto]]
|If TRUE, the key focus rotates through the contents of the tab control when you press the  key.
 
This property is similar to the <b>Tabbing moves into contents</b> option on the Key Navigation page of the <b>Tab Control Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|24DEB410
| [[TabControl class/Tab Layout property|Tab Layout]]
|Gets or sets the tab layout. Valid values are 0 (Text Only), 1 (Image Only), 2 (Text - Image), and 3 (Image - Text).
|R/W
|X
|- style="background-color:#FFFFCC;"
|24DEB411
| [[TabControl class/Tab Location property|Tab Location]]
|Gets or sets the tab location. Valid values are <b>Top</b>, <b>Bottom</b>, <b>Left</b>, and <b>Right</b>.
|R/W
|X
|- style="background-color:#FFFFCC;"
|24DEB400
| [[TabControl class/TabSize property|TabSize]]
|Gets or sets how LabVIEW adjusts the size of the tabs.
 
You can size tabs to their contents, size all tabs to the largest tab, or use a fixed tab size for each tab. If you set this property to  Fixed Tab Size, you can use the Fixed Tab Dimension property to set the width and/or height of individual tabs.
 
This property is similar to the <b>Tab Size</b> option on the Appearance page of the <b>Tab Control Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|24DEB40E
| [[TabControl class/Tabs Visible? property|Tabs Visible?]]
|Specifies if the tabs are visible.
|R/W
|X
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide TabControl Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ TabControl Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#CCFFFF;"
|24DEB000
| [[TabControl class/Rearrange Pages method|Rearrange Pages]]
|Rearranges the pages of the tab control according to the order of the names in the string array.
|X
|}
</div>
 
==Events==
''No Events for this class.''


== History ==
== History ==
{{ambox|text=History information is needed.  What changes have occured over previous versions?}}
{{ambox|text=History information is needed.  What changes have occurred over previous versions?}}
{| class="wikitable"
{| class="wikitable"
! Version
! Version
Line 219: 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:02, 8 May 2020

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

This class has no children.


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

Properties

Show/Hide TabControl Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
TabControl Properties Table
Property ID Long Name (English) Description R/W RTE
24DEB400Tab SizeGets or sets how LabVIEW adjusts the size of the tabs.Read/WriteYes
24DEB401Fixed Tab DimensionGets or sets the tab width, height, or all elements.Read/WriteYes
24DEB402Allow Multiple RowsIf TRUE, LabVIEW arranges any tabs that extend beyond the width of the tab control into an additional row of tabs. If FALSE, LabVIEW displays navigation buttons on the upper right of the tab control, which you use to scroll through tabs that are not visible.Read/WriteYes
24DEB403Justify TabsIf TRUE, LabVIEW stretches each row of tabs to fill the entire width of the tab control.Read/WriteYes
24DEB404Tab Control Pane DimensionGets or sets the width and height of the tab control pane.Read/WriteYes
24DEB405Tab Control Pane Dimension:WidthGets or sets the tab pane width.Read/WriteYes
24DEB406Tab Control Pane Dimension:HeightGets or sets the tab pane height.Read/WriteYes
24DEB407Fixed Tab Dimension:WidthGets or sets tab width when using fixed tab sizes.Read/WriteYes
24DEB408Fixed Tab Dimension:HeightGets or sets tab height when using fixed tab sizes.Read/WriteYes
24DEB409ColorsGets or sets the colors for the foreground and background of the tab control.Read/WriteYes
24DEB40AColors:FG ColorGets or sets the foreground color of the tab control.Read/WriteYes
24DEB40BColors:BG ColorGets or sets the background color of the tab control.Read/WriteYes
24DEB40CAllow Multiple ColorsAllows different colors on each tab control page.Read/WriteYes
24DEB40DAuto Grow?Specifies if you can auto grow the tab control.Read/WriteYes
24DEB40ETabs Visible?Specifies if the tabs are visible.Read/WriteYes
24DEB40FPage Labels Display Visible?Specifies if the page labels display are visible.Read/WriteYes
24DEB410Tab LayoutGets or sets the tab layout. Valid values are 0 (Text Only), 1 (Image Only), 2 (Text - Image), and 3 (Image - Text).Read/WriteYes
24DEB411Tab LocationGets or sets the tab location. Valid values are Top, Bottom, Left, and Right.Read/WriteYes
24DEB412Tab IntoIf TRUE, the key focus rotates through the contents of the tab control when you press the <Tab> key.Read/WriteYes

Methods

Show/Hide TabControl Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
TabControl Methods Table
Method ID Long Name (English) Description RTE
24DEB000Rearrange PagesRearranges the pages of the tab control according to the order of the names in the string array.Yes (Read/Write)

Events

This class has no events or it inherits events from its parent: PageSelector Class.


History

Version Change(s)
LabVIEW 2018 More info to come.

See Also