GetTableCellRangeRect

int GetTableCellRangeRect (int panelHandle, int controlID, Rect cellRange, Rect *panelCoordinates);

Purpose

Converts a table control cell range into panel coordinates.

Parameters

Input
Name Type Description
panelHandle integer Specifier for a particular panel that is currently in memory. You obtain this handle from LoadPanel, NewPanel, or DuplicatePanel.
controlID integer 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 NewCtrl or 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);

Example

GetTableCellRangeRect (panelHandle, controlID, MakeRect (2, 3, 5, 5), &cell);

Output
Name Type Description
panelCoordinates Rect (passed by reference) 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 integer Return value indicating whether the function was successful. A negative number indicates that an error occurred.

Code Error Message String
xx Success