Class

DesktopTableRow

Table Row

---

Description

A lightweight, read-only accessor for one row of a DesktopTable.

An instance is handed out by DesktopTable.RowAt or by iterating DesktopTable.Rows. It holds no state of its own, only a weak reference to its table, so it stays valid as long as the table does and reports whatever the table currently holds for that row index.

To change a value, use the matching setter on the table itself, for example DesktopTable.CellTextAt.

Properties

Name	Type	Read-Only	Shared
ColumnCount	Integer	✓
Selected	Boolean	✓
Tag	Variant	✓

Methods

Name	Parameters	Returns	Shared
CellAlignmentAt	column As Integer	DesktopTable.Alignments
CellAlignmentOffsetAt	column As Integer	Integer
CellBoldAt	column As Integer	Boolean
CellBorderColorAt	column As Integer	ColorGroup
CellCheckBoxEnabledAt	column As Integer	Boolean
CellCheckBoxStateAt	column As Integer	DesktopCheckBox.VisualStates
CellCheckBoxValueAt	column As Integer	Boolean
CellItalicAt	column As Integer	Boolean
CellProgressBarMaximumValueAt	column As Integer	Double
CellProgressBarValueAt	column As Integer	Double
CellTagAt	column As Integer	Variant
CellTextAt	column As Integer	String
CellTooltipAt	column As Integer	String
CellTypeAt	column As Integer	DesktopTable.CellTypes
CellUnderlineAt	column As Integer	Boolean

Property descriptions

---

DesktopTableRow.ColumnCount

ColumnCount As Integer

Number of columns of a row. It is the column count of the table, so every row reports the same number.

This property is read-only.

This example reads the number of columns of a row:

Var value As Integer = Table1.RowAt(0).ColumnCount

---

DesktopTableRow.Selected

Selected As Boolean

Selection state of a row. Use DesktopTable.RowSelectedAt to change it.

This property is read-only.

This example reads the selection state of a row:

Var value As Boolean = Table1.RowAt(0).Selected

---

DesktopTableRow.Tag

Tag As Variant

Companion value of a row. Tag of a row. It is the value DesktopTable.RowTagAt sets.

This property is read-only.

This example reads the companion value of a row:

Var value As Variant = Table1.RowAt(0).Tag

Method descriptions

---

DesktopTableRow.CellAlignmentAt

CellAlignmentAt(column As Integer) As DesktopTable.Alignments

Text alignment of a cell in the specified column.

This example reads the text alignment of a cell in the specified column:

Var value As DesktopTable.Alignments = Table1.RowAt(0).CellAlignmentAt(1)

---

DesktopTableRow.CellAlignmentOffsetAt

CellAlignmentOffsetAt(column As Integer) As Integer

Alignment offset (points) of a cell in the specified column.

This example reads the alignment offset (points) of a cell in the specified column:

Var value As Integer = Table1.RowAt(0).CellAlignmentOffsetAt(1)

---

DesktopTableRow.CellBoldAt

CellBoldAt(column As Integer) As Boolean

Whether a cell in the specified column is drawn bold.

This example reads whether a cell in the specified column is drawn bold:

Var value As Boolean = Table1.RowAt(0).CellBoldAt(1)

---

DesktopTableRow.CellBorderColorAt

CellBorderColorAt(column As Integer) As ColorGroup

Border colour, Nil for none.

This example reads the border colour, Nil for none:

Var value As ColorGroup = Table1.RowAt(0).CellBorderColorAt(1)

---

DesktopTableRow.CellCheckBoxEnabledAt

CellCheckBoxEnabledAt(column As Integer) As Boolean

Whether a checkbox cell in the specified column is enabled.

This example reads whether a checkbox cell in the specified column is enabled:

Var value As Boolean = Table1.RowAt(0).CellCheckBoxEnabledAt(1)

---

DesktopTableRow.CellCheckBoxStateAt

CellCheckBoxStateAt(column As Integer) As DesktopCheckBox.VisualStates

State of a checkbox cell in the specified column.

This example reads the state of a checkbox cell in the specified column:

Var value As DesktopCheckBox.VisualStates = Table1.RowAt(0).CellCheckBoxStateAt(1)

---

DesktopTableRow.CellCheckBoxValueAt

CellCheckBoxValueAt(column As Integer) As Boolean

Value of a checkbox cell in the specified column.

This example reads the value of a checkbox cell in the specified column:

Var value As Boolean = Table1.RowAt(0).CellCheckBoxValueAt(1)

---

DesktopTableRow.CellItalicAt

CellItalicAt(column As Integer) As Boolean

Whether a cell in the specified column is drawn italic.

This example reads whether a cell in the specified column is drawn italic:

Var value As Boolean = Table1.RowAt(0).CellItalicAt(1)

---

DesktopTableRow.CellProgressBarMaximumValueAt

CellProgressBarMaximumValueAt(column As Integer) As Double

Upper bound of a progress bar cell in the specified column.

This example reads the upper bound of a progress bar cell in the specified column:

Var value As Double = Table1.RowAt(0).CellProgressBarMaximumValueAt(1)

---

DesktopTableRow.CellProgressBarValueAt

CellProgressBarValueAt(column As Integer) As Double

Value of a progress bar cell in the specified column.

This example reads the value of a progress bar cell in the specified column:

Var value As Double = Table1.RowAt(0).CellProgressBarValueAt(1)

---

DesktopTableRow.CellTagAt

CellTagAt(column As Integer) As Variant

Tag of a cell in the specified column.

This example reads the tag of a cell in the specified column:

Var value As Variant = Table1.RowAt(0).CellTagAt(1)

---

DesktopTableRow.CellTextAt

CellTextAt(column As Integer) As String

Text of a cell in the specified column.

This example reads the text of a cell in the specified column:

Var value As String = Table1.RowAt(0).CellTextAt(1)

---

DesktopTableRow.CellTooltipAt

CellTooltipAt(column As Integer) As String

Tooltip of a cell in the specified column.

This example reads the tooltip of a cell in the specified column:

Var value As String = Table1.RowAt(0).CellTooltipAt(1)

---

DesktopTableRow.CellTypeAt

CellTypeAt(column As Integer) As DesktopTable.CellTypes

Type of a cell in the specified column.

This example reads the type of a cell in the specified column:

Var value As DesktopTable.CellTypes = Table1.RowAt(0).CellTypeAt(1)

---

DesktopTableRow.CellUnderlineAt

CellUnderlineAt(column As Integer) As Boolean

Whether a cell in the specified column is drawn underlined.

This example reads whether a cell in the specified column is drawn underlined:

Var value As Boolean = Table1.RowAt(0).CellUnderlineAt(1)

Compatibility

Project Types	Desktop
Operating Systems	All

See also

DesktopTable