$root.$iwindows.WINDOW.$objs.Data Grid

Parent: $root.$iwindows.WINDOW.$objs
 
Children 

Class notation

Properties Methods Events 

Presents the data in tabular format and lets you enter text data into the cells. You can size the columns by clicking on the header buttons.

Properties

Object specific 
$autocorrectspellingIf true,and the user types a separator (e.g. space or comma) when no text is selected,the control replaces a misspelt word immediately before the selection with a correctly spelt word
$autosizeIf true, the data grid sizes rows according to the contents
$autosizeheightThe maximum number of lines (2-100) when autosize is kTrue
$borderradiusRadius 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
$canresizecolumnsIf true, the user can use the mouse to resize the columns of the object
$cellbordercolorThe color used to draw the grid cell borders
$cellleftpaddingThe amount of extra padding added to the left of a cells content
$columnactiveIf true, the column is active
$columndatacolThe column from which to map data. Either a list column number, or for the JavaScript client data grid a list column number or name
$columnenabledIf true, the column is enabled
$columnforecolorThe foreground color of the column
$columnheadercolorThe color of the header
$columnheadertextcolorThe text color of the header
$columnjstThe alignment of the column
kCenterJst kLeftJst kRightJst
$columnnameThe name of the column
$columnnamesThe names of the columns
$columnpicklistThe name of the picklist for the column
$columnrawpictformatIf set,it indicates the type of picture data that is stored in the column; set it to one of the picture conversion types, or *ALL to mean any supported type is allowed
$columntextcolorThe text color of the column
$columntypeSpecifies how data is handled for the column. One of the data grid type constants
kDataGridAutoData kDataGridComboPicker kDataGridDroplistPicker kDataGridIcon
$columnwidthThe width of the column in pixels (or if allowed by the control, a percentage of the control width)
$columnwidthsComma separated list of column widths,expressed in pixels
$currentcolumnThe current design column
$defaultheightThe default height of a grid cell
$defaultwidthThe default width of a column
$disabledefaultcontextmenuIf true, the default context menu for the object will not be generated in response to a context click ($clib.$disabledefaultcontextmenu and $cobj.$disabledefaultcontextmenu must both be false for the menu to be generated)
$disablesearchonopenIf true,the combo box list is not used to populate the edit field based on the content of the edit field when the popup list is opened (for the data grid this property is used for columns with $columntype kDataGridComboPicker)
$extendableIf true, the grid automatically extends to allow the user to enter more lines
$fieldstylefocusedThe style in system class #STYLES assigned to this field in addition to $fieldstyle when the control has focus
$fixedcolIf true, the grid has a first fixed vertical column
$fixedrowIf true, the grid has a first fixed horizontal row
$gridendcolorThe color used to draw empty space after the end of the data
$gridhcellThe datagrid/stringgrid current horizontal cell
$gridsectionThe type of the complex grid section containing the object. One of the kGrid... constants
$gridvcellThe datagrid/stringgrid current vertical cell
$hscrolltipsIf true,the control uses a tooltip to indicate the horizontal scroll position
$listheightThe maximum number of lines displayed in the dropped list for a combo box or dropdown list.For the data grid,this property applies to combo boxes or dropdown lists used to manipulate cell data.Ignored on macOS when the dropped list is a menu
$showbinarylengthIf true,the data grid displays the length of binary data,and also allows the droplist button for a cell to open a modal window to edit list,row and binary columns
$shownullsIf true, the field displays null values using the text 'NULL'
$showspellingerrorsIf true,the control underlines spelling errors using a dotted line
$studioideIf true,the control draws in a platform independent IDE style
$tooltipposA kTooltipPos... constant that specifies where $tooltip appears relative to the control
kTooltipPosBottom kTooltipPosLeft kTooltipPosMouse kTooltipPosRight kTooltipPosTop
$userdefinedIf true,the datagrid is developer defined and not automatic
$vscrolltipsIf true,the control uses a tooltip to indicate the vertical scroll position.For JavaScript client complex grid tooltip is either return value of client-executed method $getscrolltip(row) or column 1 of the list if the method is not present
Standard$active $alpha $bordercolor $candropcursor $componentinfo $container $contextmenu $cursor $dataname $disablefontsizekeys $disablesystemfocus $dragborder $dragiconid $dragmode $dragrange $dropmode $edgefloat $effect $enabled $fieldstyle $font $fontsize $fontstyle $forecolor $framehwnd $gridcolumn $hasfocus $height $helpfile $horzscroll $hscroll $hwnd $ident $keyevents $left $linestyle $mouseevents $name $nodropcursor $objtype $order $osdropflags $pastestripscontrolcharacters $rmouseevents $selected $showcontrolcharacters $sidepanel $sidepanelmode $statusevents $textcolor $tooltip $top $userinfo $vertscroll $visible $vscroll $width

Methods

Object specific 
$enablecolumn$enablecolumn(iColumnNumber[,bEnable]) gets/sets the enabled flag for the specified data or string grid column
$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
$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
Standard$redraw

Events

Object specific 
evBorderIconClickedSent to a field when the border icon is clicked
Parameters
pEventCodeThe event code
pLeftBorderIconkTrue if the left border icon was clicked
evWillHideSent to a field before it is hidden. Currently only used when the field is set as a side panel
Parameters
pEventCodeThe event code
pSidePanelIf true,this object is being hidden or shown as a side panel
evWillShowSent to a field before it becomes visible. Currently only used when the field is set as a side panel
Parameters
pEventCodeThe event code
pSidePanelIf true,this object is being hidden or shown as a side panel
StandardevAfter evBefore evCanDrop evClick evClipChangedData evDisabled evDoubleClick evDrag evDragBorder evDragFinished evDrop evEnabled evHidden evHScrolled evKey evMouseDouble evMouseDown evMouseEnter evMouseLeave evMouseUp evOpenContextMenu evRMouseDouble evRMouseDown evRMouseUp evSent evShiftTab evShown evTab evVScrolled evWillDrop

Children

Top 

$methods