RaGrid

Advanced grid custom control.

(See RaGrid.png)

Summary

RaGrid	Advanced grid custom control.
Add	Create control.
AddColumn	Add column.
AddRow	Add row.
CellConvert	Convert cell.
ComboAddString	Populate combo box.
ComboClear	Clear combo box.
EnterEdit	Edit cell.
EndEdit	End cell editing.
DeleteRow	Delete row.
GetCell	Get cell value.
GetCellRect	Get cell rect.
GetColFormat	Get column format.
GetColCount	Returns number of columnns.
GetColWidth	Get column width.
GetColors	Get colors.
GetColumn	Get column parameters.
GetCurrentCell	Get current cell.
GetCurrentCol	Get current column .
GetCurrentRow	Get currently selected row.
GetHdrHeight	Get height of the header row.
GetHdrText	Get header text.
GetRowColor	Get row color.
GetRowHeight	Get height of the row.
GetRowCount	Returns number of rows.
MoveRow	Move row.
ResetContent	Reset content of the control.
ResetColumns	Reset columns of the control.
ScrollCell	Scrolls current cell into view.
SetCell	Set cell value.
SetColors	Set colors.
SetColWidth	Set column width.
SetColFormat	Set column format.
SetCurrentRow	Set current row.
SetCurrentCol	Set current column.
SetCurrentCell	Set current cell.
SetFont	Sets the control font.
SetHdrHeight	Set height of the header row.
SetHdrText	Set header text.
SetRowColor	Set row color.
SetRowHeight	Set height of the row.
Sort	Sort column.
About

Add

RG_Add( HParent,
X,
Y,
W,
H,
Style = "",
Handler = "",
DllPath = "" )

Create control.

Parameters

X..H	Position of the control.
Style	Space separated list of control styles, by default both scroll bars are visible. You can use numbers or style strings.
Handler	Notification events handler.
DllPath	Path of the control dll, by default control is searched in the current folder.

Styles

NOSEL, NOFOCUS, HGRIDLINES, VGRIDLINES, GRIDLINES, GRIDFRAME, NOCOLSIZE.

Handler

Result := Handler(HCtrl, Event, Col, Row, Data )

HCtrl	Control sending the event.
Event	Specifies event that occurred. Event must be registered to be able to monitor it.
Col,Row	Cell coordinates.
Data	Numeric data of the cell. Pointer to string for textual cells and DWORD value for numeric.
Result	Return 1 to prevent action.

Events

Headerclick	Sent when user clicks header.
Buttonclick	Sent when user clicks the button in a button cell.
Checkclick	Sent when user double clicks the checkbox in a checkbox cell.
Imageclick	Sent when user double clicks the image in an image cell.
Beforeselchange	Sent when user request a selection change.
Afterselchange	Sent after a selection change.
Beforeedit	Sent before the cell edit control shows.
Afteredit	Sent when the cell edit control is about to close.
Beforeupdate	Sent before a cell updates grid data.
Afterupdate	Sent after grid data has been updated.
Userconvert	Sent when user cell needs to be converted.

Returns

Control’s handle.

AddColumn

RG_AddColumn( hGrd,
o1 = "",
o2 = "",
o3 = "",
o4 = "",
o5 = "",
o6 = "",
o7 = "",
o8 = "",
o9 = "",
o10 = "" )

Add column.

Parameters

o1..o7

Named parameters.

Named Parameters

type	Column data type. See bellow list of types.
w	Width.
txt	Column caption.
txtmax	Max text lenght for EDITTEXT and EDITLONG types.
hdral	Header text alignment. Number, LEFT=0, CENTER=1, RIGHT=2
hdrflag	Header flags. If initially sorted set to initial sort direction. ASC=0, DES=1, INVERT=2.
txtal	Column text alignment.
il	Handle of the image list. For the image columns and combobox only.
format	Format string for the EDITLONG, DATE and TIME types.
data	User data.
hctrl	Handle of the column editing control. Used internally and with USER type.
items	Items for the COMBOBOX column type. Syntax suggar for ComboAddString function.

Types

EDITTEXT, EDITLONG, CHECKBOX, COMBOBOX, BUTTON, EDITBUTTON, HOTKEY, IMAGE, DATE, TIME, USER.

Returns

Column count. 0 on failure.

Remarks

Columns can not be added when the control has rows. Total number of supported columns is around 3K.

AddRow

RG_AddRow( hGrd,
Row = "",
c1 = "",
c2 = "",
c3 = "",
c4 = "",
c5 = "",
c6 = "",
c7 = "",
c8 = "",
c9 = "",
c10 = "" )

Add row.

Parameters

Row	Row number. If 0 row is appended. If omitted, blank row is added and cN are ignored if present.
if two numbers separated by space,	r o - r is taken as row number, o as row offset.
c1..c10	Column values.

Remarks

Maximum 65K rows are supported.

CellConvert

RG_CellConvert( hGrd,
Col = "",
Row = "" )

Convert cell.

ComboAddString

RG_ComboAddString( hGrd,
Col,
Items )

Populate combo box.

Parameters

Col	Column number.
Items	”\|” separated list of items.

ComboClear

RG_ComboClear( hGrd,
Col )

Clear combo box.

EnterEdit

RG_EnterEdit( hGrd,
Col = "",
Row = "" )

Edit cell.

Parameters

Col, Row

Cell coordinates. If omitted, currently selected cell is used.

EndEdit

RG_EndEdit( hGrd,
Col = "",
Row = "",
bCancel = 1 )

End cell editing.

Parameters

Col, Row	Cell coordinates. If omitted, currently selected cell is used.
bCancel	Set to true to end editing.

DeleteRow

RG_DeleteRow( hGrd,
Row = "" )

Delete row.

Parameters

Row	1 based row index. Of omited, current row is deleted.

GetCell

RG_GetCell( hGrd,
Col = "",
Row = "" )

Get cell value.

GetCellRect

RG_GetCellRect( hGrd,
Col = "",
Row = "",
ByRef Top = "",
ByRef Left = "",
ByRef Right = "",
ByRef Bottom = "" )

Get cell rect.

GetColFormat

RG_GetColFormat( hGrd,
Col = "" )

Get column format.

GetColCount

RG_GetColCount( hGrd )

Returns number of columnns.

GetColWidth

RG_GetColWidth( hGrd,
Col = "" )

Get column width.

Parameters

Col	Column number. Omit to get width for currently selected column.

GetColors

RG_GetColors( hGrd,
pQ,
ByRef o1 = "",
ByRef o2 = "",
ByRef o3 = "" )

Get colors.

Parameters

pQ	Query parameter, string of color types to get.
o1..o3	Reference to output variables.

Returns

o1.

GetColumn

RG_GetColumn( hGrd,
Col = "",
pQ = "type",
ByRef o1 = "",
ByRef o2 = "",
ByRef o3 = "",
ByRef o4 = "",
ByRef o5 = "",
ByRef o6 = "",
ByRef o7 = "",
ByRef o8 = "",
ByRef o9 = "",
ByRef o10 = "" )

Get column parameters.

Parameters

Col	Column number. Omit to get current column.
pQ	Query parameter. Space separated list of named parameters: w txt hdral txtal type txtmax format il hdrflag hctrl data. See AddColumn for details. By default “type”. Set “” to get all parameters.
o1..o10	Reference to output variables.

Returns

GetCurrentCell

RG_GetCurrentCell( hGrd,
ByRef Col,
ByRef Row )

Get current cell.

Parameters

Col, Row

Reference to variables to receive output.

GetCurrentCol

RG_GetCurrentCol( hGrd )

Get current column .

GetCurrentRow

RG_GetCurrentRow( hGrd )

Get currently selected row.

GetHdrHeight

RG_GetHdrHeight( hGrd )

Get height of the header row.

GetHdrText

RG_GetHdrText( hGrd,
Col = "" )

Get header text.

GetRowColor

RG_GetRowColor( hGrd,
Row = "",
ByRef B = "",
ByRef F = "" )

Get row color.

Parameters

Row	Row number. If omitted current row will be used.
B,F	Background, foreground color.

GetRowHeight

RG_GetRowHeight( hGrd )

Get height of the row.

GetRowCount

RG_GetRowCount( hGrd )

Returns number of rows.

MoveRow

RG_MoveRow( hGrd,
From,
To )

Move row.

Parameters

From	Number of the row to move.
To	New position of the row.

ResetContent

RG_ResetContent( hGrd )

Reset content of the control.

ResetColumns

RG_ResetColumns( hGrd )

Reset columns of the control.

ScrollCell

RG_ScrollCell( hGrd )

Scrolls current cell into view.

SetCell

RG_SetCell( hGrd,
Col = "",
Row = "",
Value = "" )

Set cell value.

Parameters

Col,Row	Cell coordinates. Omit to use current cell.
Value	Cell value. If omitted, empty string or 0 is used, depending on type.

SetColors

RG_SetColors( hGrd,
Colors )

Set colors.

Parameters

Colors

Space separated string of the color types and values. Possible types are B (background color), F (foreground color) and G (grid color).

SetColWidth

RG_SetColWidth( hGrd,
Col = "",
Width = 0 )

Set column width.

Parameters

Col	Column number. Omit to get width for currently selected column.
Width	Column width, by default 0.

SetColFormat

RG_SetColFormat( hGrd,
Col = "",
Format = "" )

Set column format.

SetCurrentRow

RG_SetCurrentRow( hGrd,
Row )

Set current row.

SetCurrentCol

RG_SetCurrentCol( hGrd,
Col )

Set current column.

SetCurrentCell

Set current cell.

Parameters

Col, Row

Coordinates of the cell to select.

SetFont

RG_SetFont( hGrd,
pFont = "" )

Sets the control font.

Parameters

pFont

AHK font definition: “Style, FontName”

SetHdrHeight

RG_SetHdrHeight( hGrd,
Height = )

Set height of the header row.

Parameters

Height

Header height. By default 0.

SetHdrText

RG_SetHdrText( hGrd,
Col = "",
Text = "" )

Set header text.

SetRowColor

RG_SetRowColor( hGrd,
Row = "",
B = "",
F = "" )

Set row color.

Parameters

Row	Row number. If omitted current row will be used.
B,F	Background, foreground color, by default b/w.

SetRowHeight

RG_SetRowHeight( hGrd,
Height )

Set height of the row.

Sort

RG_Sort( hGrd,
Col = "",
SortType = 3 )

Sort column.

Parameters

Col	Column number. Omit to get width for currently selected column.
SortType	Number, 1 (ASC), 2 (DES), 3 (INVERT). By default, 3.

About

RaGrid control version: 2.0.1.6 by KetilO. See http://www.masm32.com/board/index.php?topic=55
AHK module ver 2.0.1.6-3 by majkinetor.
RaGrid is freely distributed for any kind of purpose.
AHK module licensed under BSD http://creativecommons.org/licenses/BSD/.