Table class

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name	Table class
Class ID	13
Scope	Basic Development Environment
Class Inheritance	Generic GObject Control Table
Class Children	This class has no children.

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

Properties

Show/Hide Table Properties Table

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

Table Properties Table

Property ID	Short Name (English)	Description	R/W	RTE
633800F	ActiveCell	Sets the row and column of the active cell(s). Elements: Name Description Row Sets the row(s) of the active cell(s). Possible values are 0…n, where n is the total number of rows - 1. Enter –2 to select all rows. Column Sets the column(s) of the active cell(s). Possible values are 0…m, where m is the total number of columns - 1. Enter –2 to select all columns. Enter –1 to select the column header. The following table lists example values for this property. Row Column Result -2 0 Selects all cells of the first column, including the column header. -2 -2 Selects all rows and columns, including column headers. -1 0 Selects the header of the first column. -1 -2 Selects the headers of all columns.	R/W	X
6338011	CellBGColor	The background color of active cell(s). 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
6338026	CellFont	The font of the active cell in the table control. Use this property to change the size, style, or color of the cell font. You cannot use this property with a strict type definition.	R/W	X
6338029	CellFontBold	Indicates whether the text in the active cell is bold. This property is an element of the Active Cell:Cell Font property.	R/W	X
633802D	CellFontColor	The text font color in the active cell. This property is an element of the Active Cell:Cell Font property.	R/W	X
633802A	CellFontItalic	Indicates whether the text in the active cell is italic. This property is an element of the Active Cell:Cell Font property.	R/W	X
6338027	CellFontName	The name of the font in the active cell. Predefined font names include App Font, Sys Font, and Dlg Font. This property is an element of the Active Cell:Cell Font property. If you select an invalid font, this property returns an error.	R/W	X
6338028	CellFontSize	The size of the font in the active cell. This property is an element of the Active Cell:Cell Font property.	R/W	X
633802C	CellFontStrike	Indicates whether to strike out the text in the active cell. This property is an element of the Active Cell:Cell Font property.	R/W	X
633802B	CellFontUnder	Indicates whether the text in the active cell is underlined. This property is an element of the Active Cell:Cell Font property.	R/W	X
633802E	CellJustify	Gets and sets the justification of text within a table cell.	R/W	X
6338012	CellSize	The size of the active cell(s) in pixels. Changing the cell size does not change the size of the table control.	R/W	X
6338014	Height	The height of the table control in pixels. This property is an element of the Size property. This property is similar to the Size Height option on the Appearance page of the Properties dialog box.	R/W	X
6338013	Width	The width of the table control in pixels. This property is an element of the Size property. This property is similar to the Size Width option on the Appearance page of the Properties dialog box.	R/W	X
6338023	ActiveCellPos	The coordinate in pixels, relative to the origin of the owning pane, of the top-left position of the active cell(s).	R	X
6338024	ActiveCellPosLeft	The coordinate in pixels, relative to the origin of the owning pane, of the left edge of the active cell. This property is an element of the Active Cell:Position property.	R	X
6338025	ActiveCellPosTop	The coordinate in pixels, relative to the origin of the owning pane, of the top edge of the active cell. This property is an element of the Active Cell:Position property.	R	X
6338016	AutoRowHt	Determines whether the rows autosize their height to display all text when fonts change or when the number of lines in a cell changes. If FALSE, you can have clipped text in cells, and the user will be unable to manually resize the row height at run time to see all of the text. This property affects only user input. If you use the Value property to set the table strings, the rows do not automatically resize. To resize the rows, set this property to FALSE and then set it back to TRUE. This property is similar to the Autosize Row Height item on the shortcut menu of a table.	R/W	X
633800E	ColHdrs()	An array of the strings in the column headers.	R/W	X
6338020	ContentRectBounds	The size in pixels of the content rectangle of the table control.	R	X
6338022	ContentRectBoundsHeight	The height in pixels of the content rectangle of the table control. This property is an element of the Content Rect Bounds property.	R	X
6338021	ContentRectBoundsWidth	The width in pixels of the content rectangle of the table control. This property is an element of the Content Rect Bounds property.	R	X
633801D	ContentRectPos	The coordinate in pixels, relative to the origin of the owning pane, of the top-left position of the content rectangle of the table control.	R	X
633801E	ContentRectPosLeft	The coordinate in pixels, relative to the origin of the owning pane, of the left edge of the content rectangle of the table control. This property is an element of the Content Rect Position property.	R	X
633801F	ContentRectPosTop	The coordinate in pixels, relative to the origin of the owning pane, of the top edge of the content rectangle of the table control. This property is an element of the Content Rect Position property.	R	X
6338015	DefVal	Gets or sets the default value of the table control.	R/W	X
6338031	EditPos	The row-column pair index of the current text entry. Values of (0,0) indicate the top-left text entry. A value of –1 indicates the row or column header. Values of (–2, –2) indicate that no edits are being made to the text of the control. Before you use this property to set text focus on a control, set key focus of the control. Elements: Name Description Row The row of the current text entry. Possible values are 0…n, where n is the total number of rows - 1. Column The column of the current text entry. Possible values are 0…m, where m is the total number of columns - 1. Enter –1 to select the column header.	R/W	X
633800A	IndexVals	Row and column index of the cell displayed in the top left corner. If you display the row and column headers, the non-header cell is the top left corner. Elements: Name Description Row The row of the cell displayed in the top left corner. Possible values are 0…n, where n is the total number of rows - 1. Column The column of the cell displayed in the top left corner. Possible values are 0…m, where m is the total number of columns - 1.	R/W	X
6338018	MultilineInput	If TRUE, you can enter multiple lines of text in the table cells by pressing the key on the keyboard. If FALSE, pressing the key on the keyboard while editing cells causes LabVIEW to commit the edits in the current cell and the text focus moves to the next cell. This property does not affect run-time behavior of the table. This property is similar to the Multi-line Input item on the shortcut menu of a table.	R/W	X
6338001	NumCols	Number of visible columns in the table, including the row headers if visible. The number of columns might change if the vertical scroll bar is visible. This property counts partially visible columns. If you wire a value of 0 to this property, LabVIEW displays the leftmost column. The table control resizes according to the number of columns you set. This property is similar to the Columns option on the Appearance page of the Table Properties dialog box.	R/W	X
6338002	NumRows	Number of visible rows in the table. If the table uses column headers, this number includes one row for the column headers. The number of rows might change if the horizontal scroll bar is visible. This property counts partially visible rows. If you wire a value of 0 to this property, LabVIEW displays the topmost row. The table resizes according to the number of rows you set. This property is similar to the Visible Items»Row Headers item on the shortcut menu of a table and the Rows option on the Appearance page of the Table Properties dialog box.	R/W	X
633800D	RowHdrs()	An array of the strings in the row headers.	R/W	X
6338008	SelColor	Color used to draw the data selection. 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
633800C	SelSize	Index of the row and column pair that specifies the number of rows and columns in the selection. Elements: Name Description Row Index of the row that specifies the total number of rows in the selection. Column Index of the column that specifies the total number of columns in the selection.	R/W	X
633800B	SelStart	Row and column index that specifies the beginning of data selection. Coordinates begin at (0,0), which is top left, and do not include headers. Elements: Name Description Row Index of the row that specifies the beginning of the selection. Valid values include 0 through n-1, where n is the total number of rows in the table. Column Index of the column that specifies the beginning of the selection. Valid values include 0 through m-1, where m is the total number of columns in the table.	R/W	X
633801A	Size	The width and height in pixels of the table control. This property is similar to the Size Height and Size Width options on the Appearance page of the Properties dialog box.	R/W	X
633801C	Height	The height of the table control in pixels. This property is an element of the Size property. This property is similar to the Size Height option on the Appearance page of the Properties dialog box.	R/W	X
633801B	Width	The width of the table control in pixels. This property is an element of the Size property. This property is similar to the Size Width option on the Appearance page of the Properties dialog box.	R/W	X
6338017	SmoothHScroll	If TRUE, the horizontal scrolling of the table is by pixels, such that the first column may be horizontally clipped. If FALSE, the table scrolls by whole column widths such that the first column is never clipped. However, if a column is wider than the width of the table, you cannot see the text that is hidden off the right edge of that column. This property is similar to the Smooth Scrolling item on the shortcut menu of a table.	R/W	X
6338000	Value	Value of table control: 2D array of strings.	R/W	X
6338019	Val(Sgnl)	Sets the value of the control and generates a Value Change event. This property updates the value of an object similar to the Value property. However, Value (Signaling) also causes LabVIEW to generate an event as if the user had interactively changed the value of the object. National Instruments recommends you use this property only when you rely on LabVIEW generating an event in response to the programmatic value change.	W	X
6338007	ColHdrVis	If TRUE, displays the column headers. This property is similar to the Visible Items»Column Headers item on the shortcut menu of a table and the Show column headers option on the Appearance page of the Table Properties dialog box.	R/W	X
633802F	Horizontal Lines Visible	If TRUE, displays horizontal lines that separate rows in the table. This property is similar to the Visible Items»Horizontal Lines item on the shortcut menu of a table and the Show horizontal lines option on the Appearance page of the Properties dialog box.	R/W	X
6338005	HorizScroll	If TRUE, displays the horizontal scroll bar. This property is similar to the Visible Items»Horizontal Scrollbar item on the shortcut menu of a table and the Show horizontal scroll bar option on the Appearance page of the Table Properties dialog box.	R/W	X
6338003	IndexVis	Displays the row-column index of the top left visible cell in a table. This property is similar to the Visible Items»Index Display item on the shortcut menu of a table and Show index display option on the Appearance page of the Table Properties dialog box.	R/W	X
6338006	RowHdrVis	Shows the row headers. This property is similar to the Visible Items»Row Headers item on the shortcut menu of a table and the Show row headers option on the Appearance page of the Table Properties dialog box.	R/W	X
6338030	Vertical Lines Visible	If TRUE, displays vertical lines that separate columns in the table. This property is similar to the Visible Items»Vertical Lines item on the shortcut menu of a table and the Show vertical lines option on the Appearance page of the Properties dialog box.	R/W	X
6338004	VertScroll	If TRUE, displays the vertical scroll bar. This property is similar to the Visible Items»Vertical Scrollbar item on the shortcut menu of a table and the Show vertical scroll bar option on the Appearance page of the Table Properties dialog box.	R/W	X

Methods

Show/Hide Table Methods Table

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

Table Methods Table

Method ID	Short Name (English)	Description	RTE
6337C04	Export Data to Clipboard	Exports the table data to the clipboard in a tab-delimited format, which is accepted by most spreadsheet applications.	X
6337C05	Export Data to Excel	Exports the table data to Excel.	X
6337C02	ExportImage	Exports an image of a table to the clipboard or disk. This method is similar to the Export Simplified Image option on the shortcut menu of a table.	X
6337C03	ExportImageColor		X
6337C01	Point To Row Column	Converts a pixel coordinate to a row-column pair in the coordinates of the control. This method also returns whether the point is inside the bounds of the content rectangle.	X
6337C06	Set Cell Value	Sets the value of a cell specified by the row and column index. If you specify –2 for the row and column index, LabVIEW returns error 1.	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