Admin Production ni-theme
Current Publication

SetTableCellRangeAttribute

LabWindows/CVI

SetTableCellRangeAttribute

int SetTableCellRangeAttribute (int panelHandle, int controlID, Rect cellRange, int cellAttribute, ...);

Purpose

Sets an attribute of a range of table cells to a specified value.

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 SetTableCellRangeAttribute 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.
cellRange Rect A Rect structure specifying the cell range for which you want to set the attribute.

The Rect structure is defined as follows:

typedef struct
{
int top;
int left;
int height;
int width;
} Rect;


Pass the one-based row and column indices of the first cell in the range as the top and left fields of the structure, respectively. Pass the number of columns in the range as the width field of the structure, and the number of rows in the range as the height field of the structure.

You can create a Rect without having to declare a variable by using the following function:

Rect MakeRect (int top, int left, int height, int width);

Example

SetTableCellRangeAttribute (panelHandle, controlID, MakeRect (2, 3, 5, 5), cellAttribute, attributeValue);

cellAttribute int The cell 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 cell 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

Examples

Refer to the following examples that use the SetTableCellRangeAttribute function:

  • userint\colview.cws

    Open example
  • userint\gridview.cws

    Open example