Jump to content

Table class

From LabVIEW Wiki
Revision as of 02:00, 8 May 2020 by Q (talk | contribs) (Removed VI Server Category from page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
VI Server Class Information
Return to VI Server Class Hierarchy
Class Name Table class
Class ID 13
Scope Basic Development Environment
Class Inheritance
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/WReadable/Writable Permissions
    RTEAvailable in the Run-Time Engine
    Basic Development Environment
    VI Scripting
    Private
    Deprecated
    Table Properties Table
    Property ID Long Name (English) Description R/W RTE
    6338000ValueValue of table control: 2D array of strings.Read/WriteYes
    6338001Number of ColumnsNumber 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.Read/WriteYes
    6338002Number of RowsNumber 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.Read/WriteYes
    6338003Visible Items:Index VisibleDisplays the row-column index of the top left visible cell in a table.Read/WriteYes
    6338004Visible Items:Vertical Scrollbar VisibleIf TRUE, displays the vertical scroll bar.Read/WriteYes
    6338005Visible Items:Horizontal Scrollbar VisibleIf TRUE, displays the horizontal scroll bar.Read/WriteYes
    6338006Visible Items:Row Headers VisibleShows the row headers.Read/WriteYes
    6338007Visible Items:Column Headers VisibleIf TRUE, displays the column headers.Read/WriteYes
    6338008Selection ColorColor used to draw the data selection.Read/WriteYes
    6338009Old Edit PositionRead/WriteYes
    633800AIndex ValuesRow 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.Read/WriteYes
    633800BSelection StartRow and column index that specifies the beginning of data selection. Coordinates begin at (0,0), which is top left, and do not include headers.Read/WriteYes
    633800CSelection SizeIndex of the row and column pair that specifies the number of rows and columns in the selection.Read/WriteYes
    633800DRow Header Strings[]An array of the strings in the row headers.Read/WriteYes
    633800EColumn Header Strings[]An array of the strings in the column headers.Read/WriteYes
    633800FActive Cell:Active CellSets the row and column of the active cell(s).Read/WriteYes
    6338010Active Cell:Cell FG ColorRead/WriteYes
    6338011Active Cell:Cell Background ColorThe background color of active cell(s).Read/WriteYes
    6338012Active Cell:Cell SizeThe size of the active cell(s) in pixels.Read/WriteYes
    6338013Active Cell:Cell Size:WidthThe width of the table control in pixels.Read/WriteYes
    6338014Active Cell:Cell Size:HeightThe height of the table control in pixels.Read/WriteYes
    6338015Default ValueGets or sets the default value of the table control.Read/WriteYes (Read Only)
    6338016Autosizing Row HeightDetermines whether the rows autosize their height to display all text when fonts change or when the number of lines in a cell changes.Read/WriteYes
    6338017Smooth Horizontal ScrollingIf 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.Read/WriteYes
    6338018Multiple Line InputIf TRUE, you can enter multiple lines of text in the table cells by pressing the <Enter> key on the keyboard. If FALSE, pressing the <Enter> 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.Read/WriteYes
    6338019Value (Signaling)Sets the value of the control and generates a Value Change event.Write OnlyYes
    633801ASizeThe width and height in pixels of the table control.Read/WriteYes
    633801BSize:WidthThe width of the table control in pixels.Read/WriteYes
    633801CSize:HeightThe height of the table control in pixels.Read/WriteYes
    633801DContent Rect PositionThe coordinate in pixels, relative to the origin of the owning pane, of the top-left position of the content rectangle of the table control.Read OnlyYes
    633801EContent Rect Position:LeftThe coordinate in pixels, relative to the origin of the owning pane, of the left edge of the content rectangle of the table control.Read OnlyYes
    633801FContent Rect Position:TopThe coordinate in pixels, relative to the origin of the owning pane, of the top edge of the content rectangle of the table control.Read OnlyYes
    6338020Content Rect BoundsThe size in pixels of the content rectangle of the table control.Read OnlyYes
    6338021Content Rect Bounds:WidthThe width in pixels of the content rectangle of the table control.Read OnlyYes
    6338022Content Rect Bounds:HeightThe height in pixels of the content rectangle of the table control.Read OnlyYes
    6338023Active Cell:PositionThe coordinate in pixels, relative to the origin of the owning pane, of the top-left position of the active cell(s).Read OnlyYes
    6338024Active Cell:Position:LeftThe coordinate in pixels, relative to the origin of the owning pane, of the left edge of the active cell.Read OnlyYes
    6338025Active Cell:Position:TopThe coordinate in pixels, relative to the origin of the owning pane, of the top edge of the active cell.Read OnlyYes
    6338026Active Cell:Cell FontThe font of the active cell in the table control.Read/WriteYes
    6338027Active Cell:Cell Font:NameThe name of the font in the active cell. Predefined font names include App Font, Sys Font, and Dlg Font.Read/WriteYes
    6338028Active Cell:Cell Font:SizeThe size of the font in the active cell.Read/WriteYes
    6338029Active Cell:Cell Font:BoldIndicates whether the text in the active cell is bold.Read/WriteYes
    633802AActive Cell:Cell Font:ItalicIndicates whether the text in the active cell is italic.Read/WriteYes
    633802BActive Cell:Cell Font:UnderlineIndicates whether the text in the active cell is underlined.Read/WriteYes
    633802CActive Cell:Cell Font:StrikeoutIndicates whether to strike out the text in the active cell.Read/WriteYes
    633802DActive Cell:Cell Font:ColorThe text font color in the active cell.Read/WriteYes
    633802EActive Cell:Cell JustificationGets and sets the justification of text within a table cell.Read/WriteYes
    633802FVisible Items:Horizontal Lines VisibleIf TRUE, displays horizontal lines that separate rows in the table.Read/WriteYes
    6338030Visible Items:Vertical Lines VisibleIf TRUE, displays vertical lines that separate columns in the table.Read/WriteYes
    6338031Edit PositionThe 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.Read/WriteYes

    Methods

    Show/Hide Table Properties Table

    Legend
    RTEAvailable in the Run-Time Engine
    Basic Development Environment
    VI Scripting
    Private
    Deprecated
    Table Methods Table
    Method ID Long Name (English) Description RTE
    6337C00Set Cell Value (Deprecated)Yes
    6337C01Point to Row ColumnConverts 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.Yes (Read/Write)
    6337C02Export ImageExports an image of a table to the clipboard or disk.Yes (Read/Write)
    6337C03Export Image ColorYes
    6337C04Export Data to ClipboardExports the table data to the clipboard in a tab-delimited format, which is accepted by most spreadsheet applications.Yes (Read/Write)
    6337C05Export Data to ExcelExports the table data to Excel.Yes (Read/Write)
    6337C06Set Cell ValueSets 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.Yes (Read/Write)

    Events

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


    History

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

    See Also