Page class

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name	class
Class ID	{{{1}}}
Scope
Class Inheritance	This class is a top-level class.
Class Children	This class has no children.

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

Properties

Show/Hide Page Properties Table

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

Page Properties Table

Property ID	Short Name (English)	Description	R/W	RTE
18044C0A	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 Advanced»Allow Multiple Colors from the shortcut menu.	R/W	X
18044C0C	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
18044C0B	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
18044C02	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
18044C03	DecosOnPage	Gets an array of references to all decorations on a tab control page.	R	X
18044C07	Desc	Gets or sets the description of a tab control page. This property is similar to the Description and Tip 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
18044C09	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
18044C04	ObjectsOnPage	Gets an array of references to all controls, indicators, and decorations on a page.	R	X
18044C00	PageEnb	Gets or sets the state of a tab control page. This property is similar to the Advanced»Page Enabled State item on the shortcut menu of a tab control.	R/W	X
18044C06	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
18044C01	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
18044C05	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 Advanced»Make Page Caption Match Label on the shortcut menu.	R/W	X
18044C08	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

Methods

Show/Hide Page Methods Table

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

Page Methods Table

Method ID	Short Name (English)	Description	RTE
18044801	Import Image	Imports the image from the clipboard to the page.	X
18044802	Remove Image	Removes the image from the page.	X
18044800	Reorder Controls	Reorders the controls on the page according to the order of the input array of control references.	X

Events

No Events for this class.

History

Version	Change(s)
	More info to come.

See Also

• VI Server Class Hierarchy
• VI Server
• VI Scripting