QG_GetCellOptions
QG_GetCellOptions(areaRef; cellWidth; cellHeight; bkgPict; bkgPictFormat; xCornerRadius; yCornerRadius):errorCode | |||
---|---|---|---|
![]() |
areaRef | Longint | QGrid area reference |
![]() |
cellWidth | Longint | Cell width |
![]() |
cellHeight | Longint | Cell height |
![]() |
bkgPict | Picture | Background picture |
![]() |
bkgPictFormat | Longint | Background picture format |
![]() |
xCornerRadius | Longint | Cell corner radius on the X axis |
![]() |
yCornerRadius | Longint | Cell corner radius on the Y axis |
![]() |
error | Longint | Error result |
Get the current grid cell properties
Parameter areaRef is the QGrid area reference. If areaRef is not a valid QGrid area reference, qg_paramErr error is returned.
Parameters cellWidth and cellHeight receive the cell dimensions in pixels.
Parameters bkgPict and bkgPictFormat are optional. When used, they receive the cell's background picture and its display format. If no background picture was defined for the area cells, both parameters will be empty.
Parameters xCornerRadius and yCornerRadius are optional. When used they receive the cell's corner roundness in the form of the radii across the X and Y axes respectively.
Example
// Get the cell dimensions. C_LONGINT($err;$cellWidth;$cellHeight) $err:=QG_GetCellOptions (xGrid;$cellWidth;$cellHeight) ASSERT($err=qg_noErr)
Related commands
QG_SetCellOptions | Set the properties of the grid cells |