GetTableCellRangeRect
int GetTableCellRangeRect (int panelHandle, int controlID, Rect cellRange, Rect *panelCoordinates);
Purpose
Converts a table control cell range into panel coordinates.
Supported Controls
You can use GetTableCellRangeRect 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 get the panel
coordinates. If you want to convert the entire cell grid, you can pass the VAL_TABLE_ENTIRE_RANGE macro. 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); ExampleGetTableCellRangeRect (panelHandle, controlID, MakeRect (2, 3, 5, 5), &cell); |
| Output | ||
| Name | Type | Description |
| panelCoordinates | Rect | A Rect structure containing the coordinates of the specified cell range. The values in the Rect structure are in terms of pixel coordinates. The origin (0,0) is the upper left corner of the panel. The Rect structure is defined as follows: typedef struct { int top; int left; int height; int width; } Rect; |
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 GetTableCellRangeRect function:
- userint\colview.cws
Open example - userint\gridview.cws
Open example