FillTableCellRange
int FillTableCellRange (int panelHandle, int controlID, Rect cellRange, ...);
Purpose
Sets the values of a table control cell range to the same specified value.
Supported Controls
You can use FillTableCellRange 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 values. To use this function, you must specify a cell range in which all cells are of compatible types. Cells are of compatible types if they are all of type VAL_CELL_NUMERIC, or if they are all of type VAL_CELL_PICTURE, or if they are a combination of the other cell types. If the cell type is VAL_CELL_NUMERIC, all cells in the range also must share an identical data type. 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); ExampleFillTableCellRange (panelHandle, controlID, MakeRect (2, 3, 5, 5), value); |
value | ... | The new value of each cell in the range. The value that this function expects depends on the cell type. If the cell type is VAL_CELL_PICTURE, the function expects an ID of the bitmap containing the new image. The ID must be a value obtained from NewBitmapEx, GetBitmapFromFile, GetCtrlBitmap, ClipboardGetBitmap, GetCtrlDisplayBitmap, GetPanelDisplayBitmap, GetScaledPanelDisplayBitmap, GetScaledCtrlDisplayBitmap, or DuplicateBitmap. A value of 0 indicates that there is no image. You can use this to delete an existing image. If the cell type is VAL_CELL_STRING, VAL_CELL_RING, VAL_CELL_COMBO_BOX, or VAL_CELL_BUTTON, the function expects a NUL-terminated string. If the cell type is VAL_CELL_NUMERIC, the function expects a number of a data type matching the data type of the cell. |
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