Jump to content

DigitalTable class: Difference between revisions

From LabVIEW Wiki
← Older edit
VisualWikitext
mNo edit summary
m Removed VI Server Category from page
 
(2 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 DigitalTable Properties Table</span>
{{VIServerClassTables|61}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ DigitalTable Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|7494C012
| [[DigitalTable class/ActiveCell property|ActiveCell]]
|Sets the row and column of the active cell(s).
 
{| class="wikitable"
|+ scope="col" style="text-align:left;"| Elements:
! scope="col" style="text-align:left;"| Name
! scope="col" style="text-align:left;"| Description
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"| 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.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"| 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.
{| class="wikitable"
! scope="col" | Row
! scope="col" | Column
! scope="col" style="text-align:left;"| Result
|- style="vertical-align:top;"
| -2
| 0
|Selects all cells of the first column, including the column header.
|- style="vertical-align:top;"
| -2
| -2
| Selects all rows and columns, including column headers.
|- style="vertical-align:top;"
| -1
| 0
| Selects the header of the first column.
|- style="vertical-align:top;"
| -1
| -2
|Selects the headers of all columns.
|}
|R/W
|X
|- style="background-color:#FFFFCC;"
|7494C014
| [[DigitalTable class/CellBGColor property|CellBGColor]]
|Background color of the active cell in the control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|7494C013
| [[DigitalTable class/CellFGColor property|CellFGColor]]
|Color of the text in the active cell in the control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|7494C01C
| [[DigitalTable class/ActiveCellPos property|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
|- style="background-color:#FFFFCC;"
|7494C01D
| [[DigitalTable class/ActiveCellPosLeft property|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
|- style="background-color:#FFFFCC;"
|7494C01E
| [[DigitalTable class/ActiveCellPosTop property|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
|- style="background-color:#FFFFCC;"
|7494C01F
| [[DigitalTable class/CellFont property|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.
 
{| class="wikitable"
|+ scope="col" style="text-align:left;"| Elements:
! scope="col" style="text-align:left;"| Name
! scope="col" style="text-align:left;"| Description
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|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.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Size
|The size of the font in all cells.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Bold
|Indicates whether the text in all cells is bold.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Italic
|Indicates whether the text in all cells is italic.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Underline
|Indicates whether the text in all cells is underlined.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Strikeout
|Indicates whether to strike out the text in all cells.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Color
|The text font color in all cells.
|}
|R/W
|X
|- style="background-color:#FFFFCC;"
|7494C022
| [[DigitalTable class/CellFontBold property|CellFontBold]]
|Indicates whether the text in all cells is bold.
 
This property is an element of the Cell Font property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|7494C026
| [[DigitalTable class/CellFontColor property|CellFontColor]]
|The text font color in all cells.
 
This property is an element of the Cell Font property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|7494C023
| [[DigitalTable class/CellFontItalic property|CellFontItalic]]
|Indicates whether the text in all cells is italic.
 
This property is an element of the Cell Font property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|7494C020
| [[DigitalTable class/CellFontName property|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
|- style="background-color:#FFFFCC;"
|7494C021
| [[DigitalTable class/CellFontSize property|CellFontSize]]
|The size of the font in all cells.
 
This property is an element of the Cell Font property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|7494C025
| [[DigitalTable class/CellFontStrike property|CellFontStrike]]
|Indicates whether to strike out the text in all cells.
 
This property is an element of the Cell Font property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|7494C024
| [[DigitalTable class/CellFontUnder property|CellFontUnder]]
|Indicates whether the text in all cells is underlined.
 
This property is an element of the Cell Font property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|7494C019
| [[DigitalTable class/ContentRectBounds property|ContentRectBounds]]
|The size in pixels of the content rectangle of the digital data control.
|R
|X
|- style="background-color:#FFFFCC;"
|7494C01B
| [[DigitalTable class/ContentRectBoundsHeight property|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
|- style="background-color:#FFFFCC;"
|7494C01A
| [[DigitalTable class/ContentRectBoundsWidth property|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
|- style="background-color:#FFFFCC;"
|7494C016
| [[DigitalTable class/ContentRectPos property|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
|- style="background-color:#FFFFCC;"
|7494C017
| [[DigitalTable class/ContentRectPosLeft property|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
|- style="background-color:#FFFFCC;"
|7494C018
| [[DigitalTable class/ContentRectPosTop property|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
|- style="background-color:#CCFFFF;"
|7494C001
| [[DigitalTable class/DefVal property|DefVal]]
|Gets or sets the default value of the digital table control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|7494C027
| [[DigitalTable class/EditPos property|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.
 
{| class="wikitable"
|+ scope="col" style="text-align:left;"| Elements:
! scope="col" style="text-align:left;"| Name
! scope="col" style="text-align:left;"| Description
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Row
|The row of the  current text entry. Possible values are 0…n, where n is the total number of rows - 1.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|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
|- style="background-color:#FFFFCC;"
|7494C009
| [[DigitalTable class/Format property|Format]]
|Selects the format in which to display the data.
 
 
0Binary
1Octal
2Hexadecimal
3Decimal
 
This property is similar to the <b>Data Format</b> item on the shortcut menu of a digital data control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|7494C006
| [[DigitalTable class/HorizScroll property|HorizScroll]]
|If TRUE, displays the horizontal scroll bar.
 
This property is similar to the <b>Visible Items&#0187;</b>Horizontal Scrollbar item on the shortcut menu of a digital data control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|7494C00E
| [[DigitalTable class/SelColor property|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
|- style="background-color:#FFFFCC;"
|7494C00D
| [[DigitalTable class/SelSize property|SelSize]]
|Index of the row and column pair that specifies the number of rows and columns in the selection.
 
{| class="wikitable"
|+ scope="col" style="text-align:left;"| Elements:
! scope="col" style="text-align:left;"| Name
! scope="col" style="text-align:left;"| Description
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|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.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|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
|- style="background-color:#FFFFCC;"
|7494C00C
| [[DigitalTable class/SelStart property|SelStart]]
|Index of the row and column pair that specifies the beginning of data selection (inclusive).
 
{| class="wikitable"
|+ scope="col" style="text-align:left;"| Elements:
! scope="col" style="text-align:left;"| Name
! scope="col" style="text-align:left;"| Description
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|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.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|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
|- style="background-color:#FFFFCC;"
|7494C008
| [[DigitalTable class/SigNumVis property|SigNumVis]]
|If TRUE, displays the signal numbers in the top row as column headers.
 
This property is similar to the <b>Visible Items&#0187;</b>Signal Numbers item of the shortcut menu of a digital data control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|7494C002
| [[DigitalTable class/Size property|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 <b>Size Height</b> and <b>Size Width</b> options on the Appearance page of the <b>Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|7494C004
| [[DigitalTable class/Height property|Height]]
|Height of the digital data control in pixels.
 
This property is an element of the Size property.
 
This property is similar to the <b>Height</b> item in the Resize Objects dialog box. This property is also similar to the <b>Size Height</b> option on the Appearance page of the <b>Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|7494C003
| [[DigitalTable class/Width property|Width]]
|Width of the digital data control in pixels.
 
This property is an element of the Size property.
 
This property is similar to the <b>Width</b> item in the Resize Objects dialog box. This property is also similar to the <b>Size Width</b> option on the Appearance page of the <b>Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|7494C00A
| [[DigitalTable class/TopLeft property|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.
 
{| class="wikitable"
|+ scope="col" style="text-align:left;"| Elements:
! scope="col" style="text-align:left;"| Name
! scope="col" style="text-align:left;"| Description
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Row
|The row index of the cell displayed in the top left corner of the table.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Column
|The column index of the cell displayed in the top left corner of the table.
|}
|R/W
|X
|- style="background-color:#FFFFCC;"
|7494C007
| [[DigitalTable class/TransitionsVis property|TransitionsVis]]
|If TRUE, displays the transition values in the leftmost column as row headers.
 
This property is similar to the <b>Visible Items&#0187;Transitions</b> item of the shortcut menu of a digital data control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|7494C000
| [[DigitalTable class/Value property|Value]]
|Value of digital data control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|7494C015
| [[DigitalTable class/Val(Sgnl) property|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
|- style="background-color:#FFFFCC;"
|7494C005
| [[DigitalTable class/VertScroll property|VertScroll]]
|If TRUE, displays the vertical scroll bar.
 
This property is similar to the <b>Visible Items&#0187;</b>Vertical Scrollbar item on the shortcut menu of a digital data control.
|R/W
|X
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide DigitalTable Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ DigitalTable Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#FFFFCC;"
|7494BC03
| [[DigitalTable class/Export Data to Clipboard method|Export Data to Clipboard]]
|Exports the table data to the clipboard in a tab-delimited format, which is accepted by most spreadsheet applications.
|X
|- style="background-color:#FFFFCC;"
|7494BC04
| [[DigitalTable class/Export Data to Excel method|Export Data to Excel]]
|Exports the table data to Excel.
|X
|- style="background-color:#FFFFCC;"
|7494BC01
| [[DigitalTable class/ExportImage method|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
|- style="background-color:#D1BB80;"
|7494BC02
| [[DigitalTable class/ExportImage Color method|ExportImage Color]]
|
|X
|- style="background-color:#FFFFCC;"
|7494BC00
| [[DigitalTable class/Point To Row Column method|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.
 
<b>Note</b>  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
|}
</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 470: 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 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 Long Name (English) Description R/W RTE
7494C000ValueValue of digital data control.Read/WriteYes
7494C001Default ValueGets or sets the default value of the digital table control.Read/WriteYes (Read Only)
7494C002SizeWidth and height in pixels of the digital data control.Read/WriteYes
7494C003Size:WidthWidth of the digital data control in pixels.Read/WriteYes
7494C004Size:HeightHeight of the digital data control in pixels.Read/WriteYes
7494C005Vertical Scrollbar VisibleIf TRUE, displays the vertical scroll bar.Read/WriteYes
7494C006Horizontal Scrollbar VisibleIf TRUE, displays the horizontal scroll bar.Read/WriteYes
7494C007Transitions VisibleIf TRUE, displays the transition values in the leftmost column as row headers.Read/WriteYes
7494C008Signal Numbers VisibleIf TRUE, displays the signal numbers in the top row as column headers.Read/WriteYes
7494C009FormatSelects the format in which to display the data.Read/WriteYes
7494C00ATop Left CellThe 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.Read/WriteYes
7494C00BOld Edit PositionRead/WriteYes
7494C00CSelection StartIndex of the row and column pair that specifies the beginning of data selection (inclusive).Read/WriteYes
7494C00DSelection SizeIndex of the row and column pair that specifies the number of rows and columns in the selection.Read/WriteYes
7494C00ESelection ColorColor to use to highlight the data selection.Read/WriteYes
7494C012Active Cell:Active CellSets the row and column of the active cell(s).Read/WriteYes
7494C013Active Cell:Cell Foreground ColorColor of the text in the active cell in the control.Read/WriteYes
7494C014Active Cell:Cell Background ColorBackground color of the active cell in the control.Read/WriteYes
7494C015Value (Signaling)Sets the value of the control and generates a Value Change event.Write OnlyYes
7494C016Content Rect PositionThe 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.Read OnlyYes
7494C017Content Rect Position:LeftThe coordinate in pixels, relative to the origin of the owning pane, of the left edge of the content rectangle of the digital data control.Read OnlyYes
7494C018Content Rect Position:TopThe coordinate in pixels, relative to the origin of the owning pane, of the top edge of the content rectangle of the digital data control.Read OnlyYes
7494C019Content Rect BoundsThe size in pixels of the content rectangle of the digital data control.Read OnlyYes
7494C01AContent Rect Bounds:WidthThe width in pixels of the content rectangle of the digital data control.Read OnlyYes
7494C01BContent Rect Bounds:HeightThe height in pixels of the content rectangle of the digital data control.Read OnlyYes
7494C01CActive Cell: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
7494C01DActive Cell:Cell Position:LeftThe coordinate in pixels, relative to the origin of the owning pane, of the left edge of the active cell.Read OnlyYes
7494C01EActive Cell:Cell Position:TopThe coordinate in pixels, relative to the origin of the owning pane, of the top edge of the active cell.Read OnlyYes
7494C01FCell FontThe font of all cells in the digital data control. Use this property to change the size, style, or color of the cell font.Read/WriteYes
7494C020Cell Font:NameThe name of the font in all cells. Predefined font names include App Font, Sys Font, and Dlg Font.Read/WriteYes
7494C021Cell Font:SizeThe size of the font in all cells.Read/WriteYes
7494C022Cell Font:BoldIndicates whether the text in all cells is bold.Read/WriteYes
7494C023Cell Font:ItalicIndicates whether the text in all cells is italic.Read/WriteYes
7494C024Cell Font:UnderlineIndicates whether the text in all cells is underlined.Read/WriteYes
7494C025Cell Font:StrikeoutIndicates whether to strike out the text in all cells.Read/WriteYes
7494C026Cell Font:ColorThe text font color in all cells.Read/WriteYes
7494C027Edit 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 headers. Values of (–2, –2) indicate that no edits are being made to the text of the control.Read/WriteYes

Methods

Show/Hide DigitalTable Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
DigitalTable Methods Table
Method ID Long Name (English) Description RTE
7494BC00Point 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)
7494BC01Export ImageExports an image of a digital data control or indicator to clipboard or disk.Yes (Read/Write)
7494BC02Export Image ColorYes
7494BC03Export Data to ClipboardExports the table data to the clipboard in a tab-delimited format, which is accepted by most spreadsheet applications.Yes (Read/Write)
7494BC04Export Data to ExcelExports the table data to Excel.Yes (Read/Write)

Events

This class has no events or it inherits events from its parent: Control 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=DigitalTable_class&oldid=26683"