SetTableRowAttribute
- Updated2023-02-21
- 2 minute(s) read
SetTableRowAttribute
int SetTableRowAttribute (int panelHandle, int controlID, int rowIndex, int rowAttribute, ...);
Purpose
Sets an attribute of a table row.
 |
Note This function does not change the attributes of the existing cells in a row. To change attributes, you must use SetTableCellRangeAttribute and pass VAL_TABLE_ROW_RANGE. |
Refer to the SetTableColumnAttribute function reference for an example of how to use this and other table functions to insert cells into a table control and modify the attributes of new and existing cells.
Supported Controls
You can use SetTableRowAttribute with table controls.
Parameters
| Input | ||
| Name | Type | Description |
| panelHandle | int | Specifier for a particular panel that is currently in memory. You can obtain this handle from functions such as LoadPanel and NewPanel. |
| controlID | int | The defined constant, located in the .uir header file, that you assigned to the control in the User Interface Editor, or the ID returned by functions such as NewCtrl and DuplicateCtrl. |
| rowIndex | int | The one-based index of the table row for which you want to set the attribute. Pass –1 if you want to set the attribute for all rows in the table. |
| rowAttribute | int | The row attribute value to set. In the function panel, when you click the control or press <Enter>, <Spacebar>, or <Ctrl-down arrow>, a dialog box appears containing a hierarchical list of the available attributes. Attributes whose values cannot be obtained are dimmed. Help text is shown for each attribute. To select an attribute, double-click it or select it and then press <Enter>. If the attribute shown in this ring control has named constants as valid values, you can open a list of them by moving to the Attribute Value control and pressing <Enter>. The Attribute Values dialog box displays the values and value help for the constants. |
| attributeValue | ... | The value to which to set the row attribute. If the attribute shown in this ring control has named constants as valid values, you can open a list of them by pressing <Enter>. The Attribute Values dialog box displays the values and value help for the constants. |
Return Value
| Name | Type | Description |
| status | int | Return value indicating whether the function was successful. A negative number indicates that an error occurred. |
Additional Information
Library: User Interface Library
Include file: userint.h
LabWindows/CVI compatibility: LabWindows/CVI 5.5 and later
Example
Refer to userint\gridview.cws for an example of using the SetTableRowAttribute function.