Client-Side Object Model - Utility Functions

Introduction

The utility functions described here are used by the JavaScript code of the UltraWebGrid Control. The purpose of exposing and documenting them is to allow developers to put as much logic as possible on the client machine in order to obtain gains in both performance and functionality.

Many of these Utility functions are involved with more than simply returning a property value. They are concerned with 'resolving' the property value according to an ordered set of precedance rules. The rules of precedance are straightforward: Check the local value first, if that value is 0, meaning notset, check the next most local value.  This may be the Row, Column, Band or Grid. Repeat the procedure until either a value is found, or the Grid object default is encountered and applied.

HTML ID Formats

Many functions and properties are based on the Id of elements within the page. The Ids of elements is based upon a method of identifying Table and Cell objects uniquely as to owner and position within the Document Object Model, (DOM) of the page. The element most commonly used for funciont calls is the <TD> tag element. The Id of <TD> the tag is made up of several distinct components that are interpreted by the JavaScript in order to identify the position of the <TD> tag or cell within the DOM. The following Id is an example of a typical <TD> tag Id representing a cell:

<td id='UltraWebGrid1rc_3_2_4'>

The components of the Id are delimited by the underscore character. The first component indicates the Id of the owning grid. The next component is the object type identifier: in this case 'rc', indicating that the object is a cell. If the object is a cell, the last component indicates the column number within the band that the cell belongs to. The components between the object type identifier and the last position indicate the row position of the cell within the band hierarchy. In this case the Id indicates the 4th column within the 2nd child row of the 3rd top-level row of the grid. The number of bands references by the Id is equal to the total number of components in the Id minus 2.

The following Id is an example of a typical <TH> tag Id representing a column:

<td id='UltraWebGrid1c_2_4'>

The first component indicates the Id of the owning grid. The next component is the object type identifier: in this case 'c', indicating that the object is a column. The next component is the index of the Band to which the column belongs. And the last component is the index of the column within the band.

Functions

To see a description and example of the function, click on the text of the function.
If you want to see all of the function definitions and examples expanded, click here.
To collapse all definitions and examples, click here.

function igcmbo_getComboById(string comboId)

function igtbl_getElementById(string tagId)

function igtbl_getGridById(string gridId)

function igtbl_getBandById(string cellId)

function igtbl_getColumnById(string cellId)

function igtbl_getRowById(string CellId)

function igtbl_getCellById(string CellId)

function igtbl_getActiveCell(string gridName)

function igtbl_getActiveRow(string gridName)

function igtbl_isCell(string itemName)

function igtbl_isRowLabel(string itemName)

function igtbl_isColumnHeader(string itemName)

function igtbl_getCollapseImage(string gridName, int bandNo)

function igtbl_getExpandImage(string gridName, int bandNo)

function igtbl_getCellClickAction(string gridName, int bandNo)

function igtbl_getSelectTypeCell(string gridName, int bandNo)

function igtbl_getSelectTypeColumn(string gridName, int bandNo)

function igtbl_getSelectTypeRow(string gridName, int bandNo)

function igtbl_getHeaderClickAction(string gridName, int bandNo, int columnNo)

function igtbl_getAllowUpdate(string gridName, int bandNo, int columnNo)

function igtbl_getAllowColSizing(string gridName, int bandNo, int columnNo)

function igtbl_getRowSizing(string gridName, int bandNo, string row)

function igtbl_getRowSelectors(string gridName, int bandNo)

function igtbl_getNullText(string gridName, int bandNo, int columnNo)

function igtbl_getEditCellClass(string gridName, int bandNo)

function igtbl_getFooterClass(string gridName, int bandNo, int columnNo)

function igtbl_getGroupByRowClass(string gridName, int bandNo)

function igtbl_getHeadClass(string gridName, int bandNo, int columnNo)

function igtbl_getRowLabelClass(string gridName, int bandNo)

function igtbl_getSelGroupByRowClass(string gridName, int bandNo)

function igtbl_getSelHeadClass(string gridName, int bandNo, int columnNo)

function igtbl_getSelCellClass(string gridName, int bandNo, int columnNo)

function igtbl_getExpAreaClass(string gridName, int bandNo)

function igtbl_toggleRow(string gridName, string srcRow, boolean expand)

function igtbl_clearSelectionAll(string gridName)

function igtbl_selectCell(string gridName, string cellId, boolean selFlag, boolean fireEvent)

function igtbl_selectRow(string gridName, string rowId, boolean selFlag, boolean fireEvent)

function igtbl_selectColumn(string gridName, string columnId, boolean selFlag, boolean fireEvent)

function igtbl_setActiveCell(string gridName, element cell)

function igtbl_setActiveRow(string gridName, element row)

function igtbl_getInnerText(sourceElement)