Jump to content

DigitalTable class

From LabVIEW Wiki
Revision as of 20:07, 1 September 2019 by Q (talk | contribs)
VI Server Class Information
Return to VI Server Class Hierarchy
Class Name DigitalTable class
Class ID 61
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 DigitalTable class is a class in the VI Server Class Hierarchy, (see also VI Server).

Properties

Show/Hide DigitalTable Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
DigitalTable Properties Table
Property ID Short Name (English) Description R/W RTE
7494C012 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
7494C014 CellBGColor Background color of the active cell in the control. R/W X
7494C013 CellFGColor Color of the text in the active cell in the control. R/W X
7494C01C 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
7494C01D 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:Cell Position property.

R X
7494C01E 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:Cell Position property.

R X
7494C01F CellFont The font of all cells in the digital data 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.

Elements:
Name Description
Font Name The name of the font in all cells. Predefined font names include App Font, Sys Font, and Dlg Font. If you select an invalid font name, this property returns an error.
Size The size of the font in all cells.
Bold Indicates whether the text in all cells is bold.
Italic Indicates whether the text in all cells is italic.
Underline Indicates whether the text in all cells is underlined.
Strikeout Indicates whether to strike out the text in all cells.
Color The text font color in all cells.
R/W X
7494C022 CellFontBold Indicates whether the text in all cells is bold.

This property is an element of the Cell Font property.

R/W X
7494C026 CellFontColor The text font color in all cells.

This property is an element of the Cell Font property.

R/W X
7494C023 CellFontItalic Indicates whether the text in all cells is italic.

This property is an element of the Cell Font property.

R/W X
7494C020 CellFontName The name of the font in all cells. Predefined font names include App Font, Sys Font, and Dlg Font.

This property is an element of the Cell Font property.

If you select an invalid font, this property returns an error.

R/W X
7494C021 CellFontSize The size of the font in all cells.

This property is an element of the Cell Font property.

R/W X
7494C025 CellFontStrike Indicates whether to strike out the text in all cells.

This property is an element of the Cell Font property.

R/W X
7494C024 CellFontUnder Indicates whether the text in all cells is underlined.

This property is an element of the Cell Font property.

R/W X
7494C019 ContentRectBounds The size in pixels of the content rectangle of the digital data control. R X
7494C01B ContentRectBoundsHeight The height in pixels of the content rectangle of the digital data control.

This property is an element of the Content Rect Bounds property.

R X
7494C01A ContentRectBoundsWidth The width in pixels of the content rectangle of the digital data control.

This property is an element of the Content Rect Bounds property.

R X
7494C016 ContentRectPos The coordinate in pixels, relative to the origin of the owning pane, of the top-left position of the content rectangle of the digital data control. R X
7494C017 ContentRectPosLeft The coordinate in pixels, relative to the origin of the owning pane, of the left edge of the content rectangle of the digital data control.

This property is an element of the Content Rect Position property.

R X
7494C018 ContentRectPosTop The coordinate in pixels, relative to the origin of the owning pane, of the top edge of the content rectangle of the digital data control.

This property is an element of the Content Rect Position property.

R X
7494C001 DefVal Gets or sets the default value of the digital table control. R/W X
7494C027 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 headers. 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
7494C009 Format Selects the format in which to display the data.


0Binary 1Octal 2Hexadecimal 3Decimal

This property is similar to the Data Format item on the shortcut menu of a digital data control.

R/W X
7494C006 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 digital data control.

R/W X
7494C00E SelColor Color to use to highlight 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
7494C00D 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. Valid values include 0 through n-1, where n is the total number of rows in the digital table.
Column Index of the column that specifies the total number of columns in the selection. Valid values include 0 through m-1, where m is the total number of columns in the digital table.
R/W X
7494C00C SelStart Index of the row and column pair that specifies the beginning of data selection (inclusive).
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 digital 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 digital table.
R/W X
7494C008 SigNumVis If TRUE, displays the signal numbers in the top row as column headers.

This property is similar to the Visible Items»Signal Numbers item of the shortcut menu of a digital data control.

R/W X
7494C002 Size Width and height in pixels of the digital data control.

This property is similar to setting the width and height of the digital data control in the Resize Objects dialog box. This property is also similar to the Size Height and Size Width options on the Appearance page of the Properties dialog box.

R/W X
7494C004 Height Height of the digital data control in pixels.

This property is an element of the Size property.

This property is similar to the Height item in the Resize Objects dialog box. This property is also similar to the Size Height option on the Appearance page of the Properties dialog box.

R/W X
7494C003 Width Width of the digital data control in pixels.

This property is an element of the Size property.

This property is similar to the Width item in the Resize Objects dialog box. This property is also similar to the Size Width option on the Appearance page of the Properties dialog box.

R/W X
7494C00A TopLeft The row and column of the cell displayed in the top left corner of the table. Use this property to read or change the top item, or use it to read or change the leftmost column of information displayed.

This property returns the row and column of the cell at the top left corner of the visible table window, which is not necessarily the top left item of the table. To access the top left item, wire a value of (0,0) to the Active Cell property.

Elements:
Name Description
Row The row index of the cell displayed in the top left corner of the table.
Column The column index of the cell displayed in the top left corner of the table.
R/W X
7494C007 TransitionsVis If TRUE, displays the transition values in the leftmost column as row headers.

This property is similar to the Visible Items»Transitions item of the shortcut menu of a digital data control.

R/W X
7494C000 Value Value of digital data control. R/W X
7494C015 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
7494C005 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 digital data control.

R/W X

Methods

Show/Hide DigitalTable Methods Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
DigitalTable Methods Table
Method ID Short Name (English) Description RTE
7494BC03 Export Data to Clipboard Exports the table data to the clipboard in a tab-delimited format, which is accepted by most spreadsheet applications. X
7494BC04 Export Data to Excel Exports the table data to Excel. X
7494BC01 ExportImage Exports an image of a digital data control or indicator to clipboard or disk.

This method is similar to the Export Simplified Image option on the shortcut menu of a digital data control.

X
7494BC02 ExportImage Color X
7494BC00 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.

Note The Point to Row Column method does not return an error for points that lie within a control but outside of the actual cell area for that control, such as the scroll bar. Use the InBounds parameter to verify that a point lies within the cell area of a control.

X

Events

No Events for this class.

History

History information is needed. What changes have occured over previous versions?
Version Change(s)
LabVIEW 2018 More info to come.

See Also

Retrieved from "https://labviewwiki.org/w/index.php?title=DigitalTable_class&oldid=9157"