$root.$iwindows.WINDOW.$objs.Complex Grid $root.$iwindows.WINDOW.$objs.Complex Grid
Parent: $root.$iwindows.WINDOW.$objs
Children
Presents data as a series of columns and rows similar to a spreadsheet; in runtime the user can create new rows, enter data into cells, and size the columns.
| Object specific | |
| $borderradius | Radius for rounded border corners.1 to 4 pixel values separated by -,in order topleft,topright,bottomright,bottomleft.If bottomleft is omitted it is topright.If bottomright is omitted it is topleft.If topright is omitted it is topleft |
| $calculation | Either a calculation,the result of which is the value searched when typing text; or a literal string enclosed in single or double quotes, which is the name of the column containing the value searched when typing text |
| $canclickvertheader | If true,the vertical header of the grid will accept clicks and highlight selected lines,provided that the $enterable property of the grid is kFalse |
| $canresizecolumns | If true, the user can use the mouse to resize the columns of the object |
| $canresizeheader | If true, the header on the complex grid can be resized |
| $canresizerows | One of the kResize... constants,indicating how the user can use the mouse to resize the rows of the object kResizeHeaderAndRows kResizeHeaderOnly kResizeNone kResizeRowsOnly |
| $columns | Number of columns. This can only be assigned when the design window containing the complex grid is open |
| $dropbetweenlines | If true, the object highlights between lines during drag and drop |
| $enterable | If true, the field is enterable |
| $extendable | If true, the grid automatically extends to allow the user to enter more lines |
| $extendedgridlines | If true,the gridlines will extend beyond the final row to the bottom of the complex grid |
| $fieldstylefocused | The style in system class #STYLES assigned to this field in addition to $fieldstyle when the control has focus |
| $firstsel | The number of the first selected character or line in the current contents |
| $firstvis | The number of the first visible character or line in the contents |
| $gridsection | The type of the complex grid section containing the object. One of the kGrid... constants |
| $headerborder | The border style for the grid header kBorder3DFace kBorder3DHilite kBorderBevel kBorderChisel kBorderCtrlComboBox kBorderCtrlDropList kBorderCtrlEdit kBorderCtrlGroupBox kBorderCtrlList kBorderCtrlListCell kBorderCtrlShadow kBorderCtrlShadowEx kBorderCtrlTabPane kBorderDefault kBorderEmbossed kBorderEmbossedChisel kBorderInset kBorderInsetBevel kBorderNone kBorderPlain kBorderShadow kBorderSingleEmbossed kBorderSingleInset |
| $headerfillcolor | The fill color for the grid or headed list box header |
| $headerheight | The height of the grid header |
| $headerlinestyle | The line style for the grid header |
| $hiliteline | If true, the object highlights lines during drag and drop |
| $horzfooterborder | The border style for the grid horizontal footer kBorder3DFace kBorder3DHilite kBorderBevel kBorderChisel kBorderCtrlComboBox kBorderCtrlDropList kBorderCtrlEdit kBorderCtrlGroupBox kBorderCtrlList kBorderCtrlListCell kBorderCtrlShadow kBorderCtrlShadowEx kBorderCtrlTabPane kBorderDefault kBorderEmbossed kBorderEmbossedChisel kBorderInset kBorderInsetBevel kBorderNone kBorderPlain kBorderShadow kBorderSingleEmbossed kBorderSingleInset |
| $horzfooterfillcolor | The fill color for the grid horizontal footer |
| $horzfooterheight | The height of the grid horizontal footer |
| $horzfooterlinestyle | The line style for the grid horizontal footer |
| $horzheaderborder | The border style for the grid horizontal header kBorder3DFace kBorder3DHilite kBorderBevel kBorderChisel kBorderCtrlComboBox kBorderCtrlDropList kBorderCtrlEdit kBorderCtrlGroupBox kBorderCtrlList kBorderCtrlListCell kBorderCtrlShadow kBorderCtrlShadowEx kBorderCtrlTabPane kBorderDefault kBorderEmbossed kBorderEmbossedChisel kBorderInset kBorderInsetBevel kBorderNone kBorderPlain kBorderShadow kBorderSingleEmbossed kBorderSingleInset |
| $horzheaderfillcolor | The fill color for the grid horizontal header |
| $horzheaderheight | The height of the grid horizontal header |
| $horzheaderlinestyle | The line style for the grid horizontal header |
| $lastsel | The number of the final selected character or line in the current contents |
| $lastvis | The number of the final fully visible character or line in the contents |
| $multipleselect | If true, the field allows the user to select more than one line |
| $rowborder | The border style for the grid row section kBorder3DFace kBorder3DHilite kBorderBevel kBorderChisel kBorderCtrlComboBox kBorderCtrlDropList kBorderCtrlEdit kBorderCtrlGroupBox kBorderCtrlList kBorderCtrlListCell kBorderCtrlShadow kBorderCtrlShadowEx kBorderCtrlTabPane kBorderDefault kBorderEmbossed kBorderEmbossedChisel kBorderInset kBorderInsetBevel kBorderNone kBorderPlain kBorderShadow kBorderSingleEmbossed kBorderSingleInset |
| $rowdividerlinestyle | The line style for the grid row divider |
| $rowheight | The height for the grid row |
| $selectionbackcolor | The color of selected lines. kColorDefault means use the default color. When not kColorDefault only applies when the control has the focus |
| $selectiontextcolor | The text color of selected lines. kColorDefault means use the default color. When not kColorDefault applies irrespective of whether the control has the focus |
| $showheader | If true, the grid has a header |
| $showhorzfooter | If true, the grid has a scrollable horizontal footer |
| $showhorzheader | If true, the grid has a scrollable horizontal header |
| $showvertheader | If true, the grid has a scrollable vertical header |
| $slideouttype | A kGridSlideOut... constant that specifies how the columns slide out for a grid with 2 or more columns and no horizontal scroll bar kGridSlideOutTypeLeft kGridSlideOutTypeLeftRight kGridSlideOutTypeNone kGridSlideOutTypeRight |
| $tooltippos | A kTooltipPos... constant that specifies where $tooltip appears relative to the control kTooltipPosBottom kTooltipPosLeft kTooltipPosMouse kTooltipPosRight kTooltipPosTop |
| $vertheaderborder | The border style for the grid vertical header kBorder3DFace kBorder3DHilite kBorderBevel kBorderChisel kBorderCtrlComboBox kBorderCtrlDropList kBorderCtrlEdit kBorderCtrlGroupBox kBorderCtrlList kBorderCtrlListCell kBorderCtrlShadow kBorderCtrlShadowEx kBorderCtrlTabPane kBorderDefault kBorderEmbossed kBorderEmbossedChisel kBorderInset kBorderInsetBevel kBorderNone kBorderPlain kBorderShadow kBorderSingleEmbossed kBorderSingleInset |
| $vertheaderfillcolor | The fill color for the grid vertical header |
| $vertheaderlinecolor | The line color for the vertical header |
| $vertheaderlinestyle | The line style for the vertical header |
| $vertheaderwidth | The width of the vertical header |
| Standard | $active $backcolor $backpattern $bordercolor $candropcursor $componentinfo $container $contextmenu $cursor $dataname $disablesystemfocus $dragborder $dragiconid $dragmode $dragrange $dropmode $edgefloat $effect $enabled $fieldstyle $forecolor $framehwnd $gridcolumn $hasfocus $height $helpfile $horzscroll $hscroll $hwnd $ident $keyevents $left $mouseevents $name $nodropcursor $objtype $order $osdropflags $rmouseevents $selected $sidepanel $sidepanelmode $statusevents $tooltip $top $userinfo $vertscroll $visible $vscroll $width |
| Object specific | |
| $clearexceptions | $clearexceptions([iRowNumber]) Clears row based attribute exceptions in complex grid fields; omit iRowNumber to clear all exceptions |
| $getrowheight | $getrowheight([iRow=-1]) returns the complex grid row height. iRow is row number (-1 current row) |
| $sendevent | $sendevent(iEvent[,eventParameters...]) Sends event iEvent (an ev... constant value) to the object with eventParameters passed as name,value pairs, for example $sendevent(evClick,'pLineNumber',2).Returns kFalse if the event is discarded |
| $setrowheight | $setrowheight(iSz[,iRow=-1,iNewSize=-1,iCurve=kAnimationCurveEaseOut,iAnimDuration=350]) animates change to row height using iSz (kGridRowSize...).iRow is row number (-1 current row).If expanding iNewSize is new size (-1 to use $rowheight) |
| $showpanel | $showpanel(iAction[,iMode=kSidePanelModeAuto]) executes kSidePanelAction... on a side panel object. iMode only applies to kSidePanelActionShow,and must be kSidePanelModeCover/Push/Auto. For JS client,$showpanel must be executed on the client |
| $slideoutcolumn | $slideoutcolumn(iDirection[,iRow=-1,iType=kGridSlideOutTypeRight]) uses iDirection (a kGridSlideDirection... constant) to hide or show iType (a kGridSlideOutType... constant).iRow is -1 for current row or a row number |
| Standard | $redraw |
| Object specific | |||||||||
| evCellBefore | Always sent to a cell before the focus enters Parameters
| ||||||||
| evCellChanged | Sent to a field after the grid cell has been changed Parameters
| ||||||||
| evCellChanging | Sent to a field before the grid cell is changed Parameters
| ||||||||
| evExtend | Sent to grid field when the list is to be extended Parameters
| ||||||||
| evFixedCellClicked | Sent to the grid when a fixed cell is clicked Parameters
| ||||||||
| evScrollTip | Sent to the grid field during scrolling so the scroll tip can be changed Parameters
| ||||||||
| evWillHide | Sent to a field before it is hidden. Currently only used when the field is set as a side panel Parameters
| ||||||||
| evWillShow | Sent to a field before it becomes visible. Currently only used when the field is set as a side panel Parameters
| ||||||||
| Standard | evAfter evBefore evCanDrop evClick evClipChangedData evDisabled evDrag evDragBorder evDragFinished evDrop evEnabled evHidden evHScrolled evKey evMouseDouble evMouseDown evMouseEnter evMouseLeave evMouseUp evOpenContextMenu evRMouseDouble evRMouseDown evRMouseUp evSent evShiftTab evShown evTab evVScrolled evWillDrop |
| $bobjs | $dividers | $methods | $objs |