cpr.controls.gridpart.GridFooterBand

Hierarchy

Index

Properties
Name Type Description
cellCount Number Returns the number of cells in the band.
visible Boolean Returns the visible value of the band.
Methods
Name Return Type Description
getCellIndices Number[] Returns an array of cellIndex.
getColumn GridFooterColumn Returns a specific cell.
getColumnByColIndex GridFooterColumn[] Returns an array of GridColumn that fits this information.
getColumnByName GridDetailColumn[] Returns a GridDetailColumn array bound to a specific columnName.
getControl UIControl Returns controls that exist in a specific cell.
getControlAttr Object If a control exists in a specific cell, it returns the value of that control's specific property.
getRowHeight Number Returns the height of each region by row index.
getRowHeights { height: Number }[] Returns the row height of the region.
setRowHeights Change the row height of the area.

Properties

cellCount
declaring type GridBand
type Number
readonly
Returns the number of cells in the band.
visible
type Boolean
get
Returns the visible value of the band.
Only the footer works.
set
Set the visible band.
Only the footer works.

Methods

getCellIndices()
declaring typeGridBand
Returns an array of cellIndex.
return Number[] cellIndex array.
getColumn(cellIndex)
Returns a specific cell.
Parameters
name type description
cellIndex Number Cell index.
return GridFooterColumn The cell of the input cell index.
getColumnByColIndex(colIndex, colSpan)
Returns an array of GridColumn that fits this information.
Parameters
name type description
colIndex Number The colIndex of the column to find.
colSpan Number The colSpan of the column you are looking for.
return GridFooterColumn[] A GridColumn array for that information.
getColumnByName(columnName)
deprecatedThis function is only available in 19.01.21 detail.
Returns a GridDetailColumn array bound to a specific columnName.
Parameters
name type description
columnName String The columnName bound to detail.
return GridDetailColumn[] GridDetailColumn array of input columnName.
getControl(cellIndex)
declaring typeGridBand
Returns controls that exist in a specific cell.
Parameters
name type description
cellIndex Number Cell index.
return UIControl The control that exists at the input cell index.
getControlAttr(cellIndex, attrName)
If a control exists in a specific cell, it returns the value of that control's specific property.
Parameters
name type description
cellIndex Number
attrName String Attribute name.
return Object Property Value.
getRowHeight(rowIndex)
declaring typeGridBand
Returns the height of each region by row index.
The unit is px.
Parameters
name type description
rowIndex Number Row index.
return Number The height of the input row index.
getRowHeights()
declaring typeGridBand
Returns the row height of the region.
Row height at design time.
The unit is px.
return { height: Number }[] Row height array.
setRowHeights(heights)
declaring typeGridBand
Change the row height of the area.
Parameters
name type description
heights Number[] Set height array. (ex. [30])