gui_grid

Send grid commands to the gui client.

Available in:

Apps (win) Apps (char) Reportwriter RPC Standalone PL
X        

Syntax

void gui_grid(cmd,parameter[,parameter...])
int           cmd
expr          parameter

Description

Sends commands to the current grid object. Commands are defined in dv.h:
Command Description Parameter(s)
gui_grid_clearClears current grid contents Number of null rows to initialize. 0 - original count.
gui_grid_deleteDeletes specified number of rows Row index to start delete operation.
Optional number of rows to delete (default 1).
gui_grid_freezeFreeze column Column number
gui_grid_headerChange column header Column number, header
gui_grid_modifyModify or insert a row of NULLs Row index of affected row.
< 0Insert NULL row before Row index.
= 0Clear out Row index row.
> 0Insert NULL row after Row index
gui_grid_moveMove column Column number, new column position
gui_grid_rgbSet the cell color String: row col color. If row or col are <0, then all rows or cols are affected. If row or col are greater than the row or column count, then the last row or column is affected. Refer to field_color for color definitions
gui_grid_rowoffsetSet the current grid offset New row offset
gui_grid_saveSend grid data to clipboard and
optionally to Excel or a file in CSV format
Include headers (True/False) [,Excel | Filename]
gui_grid_scrollScroll to the indicated position.
"Bottom"Scroll vertically to the end of the grid. Optional parameter 1 (non-zero) positions to the last row.
"End"Scroll vertically to the end of the grid
"Home"Scroll vertically to the beginning of the grid
"Last"Scroll to the previously saved scrolling offset (client keeps the last scrolling offset automatically).
"LeftEnd"Scroll horizontally to the beginning of the grid
"RightEnd"Scroll horizontally to the end of the grid
"Top"Scroll vertically to the beginning of the grid. Optional parameter 1 (non-zero) positions to the first row.
gui_grid_styleStyle column Column number, style name
gui_grid_unfreezeUnfreeze column Column number. Column is moved to the first unfrozen position. Column < 0 unfreezes all frozen columns.
gui_grid_widthChange column width Column number, width. Width < 0 - auto sizing, width = 0 - hidden, else size in pixels.

Notes

The column number is always the zero-based column number in the original grid. Frozen columns are appended from the left. The parameters may be comma separated, e.g. gui_grid(gui_header,1,"New Header"), or in a string, e.g. gui_grid(gui_header,"1 New Header").

Example

Freeze columns 3 and 6:
gui_grid(gui_grid_freeze,3);
gui_grid(gui_grid_freeze,6);
Columns 3 and 6 are now frozen on the left side of the grid.

Send grid data to Excel:

gui_grid(gui_grid_save,"Excel");