Jump to content

Page class: Difference between revisions

From LabVIEW Wiki
← Older edit
VisualWikitext
mNo edit summary
m Removed VI Server Category from page
 
(3 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 Page Properties Table</span>
{{VIServerClassTables|54}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ Page Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|18044C0A
| [[Page class/Colors property|Colors]]
|Gets or sets the foreground and background colors of a tab control page.
 
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.
 
To set the colors, you must set the Allow Multiple Colors property to TRUE or right-click the tabs of the tab control and select <b>Advanced&#0187;Allow Multiple Colors</b> from the shortcut menu.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18044C0C
| [[Page class/BGColor property|BGColor]]
|Gets or sets the background color of the tab control page.
 
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;"
|18044C0B
| [[Page class/FGColor property|FGColor]]
|Gets or sets the foreground color of the tab control page.
 
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;"
|18044C02
| [[Page class/CtlsOnPage property|CtlsOnPage]]
|Returns an array of references to the controls and indicators on a page. The order in which you place the objects on the page determines the index of the object in the array. For example, if the first object you place on the page is a numeric control, the index of the numeric control in the array returned by this property is 0.
|R
|X
|- style="background-color:#FFFFCC;"
|18044C03
| [[Page class/DecosOnPage property|DecosOnPage]]
|Gets an array of references to all decorations on a tab control page.
|R
|X
|- style="background-color:#FFFFCC;"
|18044C07
| [[Page class/Desc property|Desc]]
|Gets or sets the description of a tab control page.
 
This property is similar to the <b>Description and Tip</b> item on the shortcut menu of a page on a tab control.
 
If you set the description, it appears in the Context Help window for that page and in any custom documentation you generate for the VI. You can format the text in the description to appear bold in the Context Help window.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18044C09
| [[Page class/IndependentLabel property|IndependentLabel]]
|Makes the tab control page caption independent of the page label.
 
After you set this property to TRUE, you can use the Tab Caption property to change the page caption.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18044C04
| [[Page class/ObjectsOnPage property|ObjectsOnPage]]
|Gets an array of references to all controls, indicators, and decorations on a page.
|R
|X
|- style="background-color:#FFFFCC;"
|18044C00
| [[Page class/PageEnb property|PageEnb]]
|Gets or sets the state of a tab control page.
 
This property is similar to the <b>Advanced&#0187;</b>Page Enabled State item on the shortcut menu of a tab control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18044C06
| [[Page class/PageLabel property|PageLabel]]
|Gets the label of a tab control page.
 
Page labels correspond to the values of the enumerated type control on the block diagram.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18044C01
| [[Page class/PageVis property|PageVis]]
|Shows or hides individual pages of a tab control.
 
If you hide the default page, the next page becomes the default page. If the only visible page is the default page, you cannot hide the default page.
 
This property is similar to the Hide Page and Show Hidden Pages items on the shortcut menu of a tab control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18044C05
| [[Page class/TabCaption property|TabCaption]]
|Gets or sets the text of a caption on a tab control page.
 
To set the caption, you must set the Independent Label property to TRUE or right-click the tabs of the tab control and remove the checkmark next to <b>Advanced&#0187;Make Page Caption Match Label</b> on the shortcut menu.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18044C08
| [[Page class/TipStrip property|TipStrip]]
|Gets or sets the tip strip of a tab control page. A tip strip is the brief description of the object that appears when you move the cursor over the object.
 
Other products refer to tip strips as tooltips.
|R/W
|X
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide Page Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ Page Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#FFFFCC;"
|18044801
| [[Page class/Import Image method|Import Image]]
|Imports the image from the clipboard to the page.
|X
|- style="background-color:#FFFFCC;"
|18044802
| [[Page class/Remove Image method|Remove Image]]
|Removes the image from the page.
|X
|- style="background-color:#CCFFFF;"
|18044800
| [[Page class/Reorder Controls method|Reorder Controls]]
|Reorders the controls on the page according to the order of the input array of control references.
|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 175: 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 Page class
Class ID 54
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 Page class is a class in the VI Server Class Hierarchy, (see also VI Server).

Properties

Show/Hide Page Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Page Properties Table
Property ID Long Name (English) Description R/W RTE
18044C00Page Enabled StateGets or sets the state of a tab control page.Read/WriteYes
18044C01Page VisibleShows or hides individual pages of a tab control.Read/WriteYes
18044C02Controls on Page[]Returns an array of references to the controls and indicators on a page. The order in which you place the objects on the page determines the index of the object in the array. For example, if the first object you place on the page is a numeric control, the index of the numeric control in the array returned by this property is 0.Read OnlyYes (Read Only)
18044C03Decorations on Page[]Gets an array of references to all decorations on a tab control page.Read OnlyYes (Read Only)
18044C04Objects on Page[]Gets an array of references to all controls, indicators, and decorations on a page.Read OnlyYes (Read Only)
18044C05Tab CaptionGets or sets the text of a caption on a tab control page.Read/WriteYes
18044C06Page LabelGets the label of a tab control page.Read/WriteYes (Read Only)
18044C07DescriptionGets or sets the description of a tab control page.Read/WriteYes
18044C08Tip StripGets or sets the tip strip of a tab control page. A tip strip is the brief description of the object that appears when you move the cursor over the object.Read/WriteYes
18044C09Independent LabelMakes the tab control page caption independent of the page label.Read/WriteYes
18044C0AColorsGets or sets the foreground and background colors of a tab control page.Read/WriteYes
18044C0BColors:FG ColorGets or sets the foreground color of the tab control page.Read/WriteYes
18044C0CColors:BG ColorGets or sets the background color of the tab control page.Read/WriteYes

Methods

Show/Hide Page Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Page Methods Table
Method ID Long Name (English) Description RTE
18044800Reorder ControlsReorders the controls on the page according to the order of the input array of control references.Yes (Read/Write)
18044801Import ImageImports the image from the clipboard to the page.Yes (Read/Write)
18044802Remove ImageRemoves the image from the page.Yes (Read/Write)

Events

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


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=Page_class&oldid=26679"