$root.$iremoteforms.REMOTEFORM.$objs.datagrid

Parent: $root.$iremoteforms.REMOTEFORM.$objs

Class notation

Properties

Warning: with the exception of $componentctrl, $componentlib, $ident, $name and $objtype, the values of properties can only be read in client methods.

Object specific
$::boldheader If true,the grid header has a bold font
$::candragdisplayorder If true,the user can drag and drop a column in the header,to change the display order.This property cannot be changed at runtime
$::columnwidths A comma separated list of column widths
$::displayorder Comma separated list of column numbers,indicating the order in which columns are displayed by the data grid.Initially set to 1,2,...,$designcols.Reset to the initial value whenever you change the number of columns
$::headerheight The height of the grid header (when $hasheader is kTrue). If zero,the header height is $rowheight
$::rowheight The height of a grid row. Zero means the height will be calculated automatically
$autoedit If true,and the cell is editable,it will automatically go into edit mode when selected
$canresizecolumns If true, the user can use the mouse to resize the columns of the object
$cansortcolumns If true,the user can click in the column heading to sort a column (see also $columncansort)
$columnbackalpha The alpha value (0-255) used with $columnbackcolor, when $columnbackcolor is not kColorDefault
$columnbackcolor The background color of the column. kColorDefault means use the grid background
$columncanresize If true,and $canresizecolumns is kTrue, the user can resize the column using the mouse
$columncansort If true,and $cansortcolumns is kTrue, the user can click in the column header to sort the column
$columndatacol The column from which to map data. Either a list column number, or for the JavaScript client data grid a list column number or name
$columndateformat Only applies when $columnmode is kJSDataGridModeFormatted.The format used to display 'Date Time' data. A kJSFormat... constant
kJSFormatCustom kJSFormatFullDate kJSFormatFullDateTime kJSFormatLongDate kJSFormatLongDateTime kJSFormatMediumDate kJSFormatMediumDateTime kJSFormatNone kJSFormatShortDate kJSFormatShortDateTime kJSFormatTime
$columndateformatcustom Only applies when $columnmode is kJSDataGridModeFormatted.A JS date-time format string used when $columndateformat is kJSFormatCustom.If empty,it defaults to the format set using $clientcommand 'setcustomformat'
$columnenabled If true, the column is enabled
$columnfontstyle The text style of the column
$columnjst The alignment of the column
kCenterJst kLeftJst kRightJst
$columnminwidth The minimum width of the column (only relevant when the column can be resized)
$columnmode Specifies how data is handled for the column.A kJSDataGridMode... constant
kJSDataGridModeAuto kJSDataGridModeCustomFormat kJSDataGridModeDropList kJSDataGridModeFormatted
$columnname The name of the column
$columnnames The names of the columns
$columnnumberformat Only applies when $columnmode is kJSDataGridModeFormatted.The JS number format used to display 'Number' and 'Integer' data. See $numberformat for syntax details
$columnpicklist The name of the picklist for the column
$columnpopuptext If true, and the column uses the editor for character data,use a popup text editor
$columnstyledtext If true, the column data can contain text styles inserted by the style() function. Setting $columnstyledtext to true sets $columnenabled to false
$columntextcolor The text color of the column
$columnwidth The width of the column in pixels (or if allowed by the control, a percentage of the control width)
$columnwidthsarepercentage If true, column widths specify a percentage of the width of the control rather than a number of pixels
$currentcolumn The current design column
$disabledefaultcontextmenu If 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)
$enterable If true, the grid is enterable
$evenrowcolor The background color of even numbered displayed rows. kColorDefault means use the same color as the odd numbered rows ($backcolor)
$extendable If true, the grid automatically extends to allow the user to enter more lines
$filterareaheight The height of the filter area (when $hasfilterarea is kTrue). If zero, the height is calculated automatically
$filtercol The grid column number to which the filter will apply
$filterlabel The label for the filter entry field
$filtervalue The name of an instance variable that contains the value used for filtering
$gridlinescolor The color of the divider lines in the grid ($gridlinesvisible must be kTrue to display the divider lines)
$gridlinesdotted If true ,the divider lines in the grid are dotted ($gridlinesvisible must be kTrue to display the divider lines)
$gridlinesvisible If true, the grid divider lines are visible
$hasfilterarea If true, the grid has a filter area,which can be opened by clicking on a button in the header
$hasheader If true, the grid has a header. Note that you can only set $hasfilterarea to kTrue if the grid has a header
$hcell The current grid column
$headertext The text displayed in the grid header when $hasheader is kTrue
$hidecolumnheader If true, the column header is not visible
$hideselection If true, the grid does not highlight selected lines
$multipleselect If true, the field allows the user to select more than one line
$pagesize If greater than 0 a list pager will be attached to the control. This specifies the number of entries per page
$selectedlinecolor The color used to display selected lines. Use kColorDefault for the default color defined in omnis.css
$selectedlinetextcolor The text color used for selected lines. Use kColorDefault for the default color defined in omnis.css
$setlineheight If true, the grid sets the line height so that text is vertically centered in each row
$sortascending If true, the sort indicator displayed when assigning $sortcol will indicate an ascending sort
$sortcol The grid column number of a sortable column that is to display the sort indicator
$userdefined If true,the datagrid is developer defined and not automatic
$vcell The current grid row
Standard $alpha $backalpha $backcolor $bordercolor $componentctrl $componentlib $contextmenu $cssclassname $dataname $dateformat $dateformatcustom $disablesystemfocus $dragborder $edgefloat $effect $enabled $errortext $errortextpos $events $fieldstyle $font $fontsize $fontstyle $height $hscroll $ident $left $linestyle $name $numberformat $objtype $order $textcolor $tooltip $top $userinfo $visible $vscroll $width

Methods

$addcolorcss $addcolorcss(cClassName,iRgbColor,iAlpha) Call this in $init to add your own background color class to use with the html returned by kJSDataGridModeCustomFormat.This class takes browser specific issues with transparency into account

Events

Object specific
evCellChanged

Sent to a field after the grid cell has been changed
Parameters

pEventCode The event code
pHorzCell The selected column
pVertCell The selected row
evColumnsResized

Sent to the data grid after the user has resized a column
Parameters

pEventCode The event code
pColumnWidths A comma separated list of the new column widths
evHeadedListDisplayOrderChanged

Sent to a headed list box when its $displayorder property has been changed when the user drags and drops a column heading
Parameters

pEventCode The event code
pDisplayOrder The order of the columns (a comma separated list of column numbers)
evHeaderClick

Sent to a headed list box after the user clicks on a button in the header
Parameters

pEventCode The event code
pHorzCell The selected column
Standard evClick evDoubleClick evDragBorder evExecuteContextMenu evOpenContextMenu