cpr.controls.gridpart.GridColumn

Properties

Name	Type	Description
cellIndex	Number	Returns the cellIndex of the cell.
cellProp	GridCellProp	Returns the configuration information of the cell.
colIndex	Number	Returns the colIndex constituting the cell.
colSpan	Number	Returns the colSpan that composes the cell.
control	UIControl	Returns the controls in that cell.
controlType	String	Returns the control type of the control in that cell.
fieldLabel	String	Returns the logical field name of the cell.
formula	String	Returns the function expression to be expressed in a cell when exporting to Excel.
rowIndex	Number	Returns the rowIndex constituting the cell.
rowSpan	Number	Returns the rowSpan that composes the cell.
style	GridStyler	Returns the style settings.
tooltip	String	Get a cell tooltip.

Methods

Name	Return Type	Description
ariaLabel	String	Applies the entered ariaLabel value to the aria-label attribute of the control HTML element.
bind	IBindFactory	Bind that property.
getAriaColIndex	Number	Returns the value of the cell number.
getBindInfo	BindInfo	Returns bind attribute information.
isBindable	Boolean	Make sure it is a bindable property.
unbind		Unbind that property.

cellIndex

type	Number
readonly	Returns the cellIndex of the cell.

cellProp

type	GridCellProp
readonly	Returns the configuration information of the cell.

colIndex

type	Number
readonly	Returns the colIndex constituting the cell.

colSpan

type	Number
readonly	Returns the colSpan that composes the cell.

control

type	UIControl
readonly	Returns the controls in that cell.

controlType

type	String
readonly	Returns the control type of the control in that cell.

fieldLabel

type	String
get	Returns the logical field name of the cell.
set	Set the logical field name of the cell. If the fieldLabel of the control placed in the cell is set, the fieldLabel of the control is applied.

formula

type	String
get	Returns the function expression to be expressed in a cell when exporting to Excel.
set	Set the function expression to be expressed in the cell when exporting to Excel. Supported built-in functions: #C(number?) Converts set cell index or current cell index to Excel column name #R(number?) Use the set row index or convert the current row index to an Excel row index

rowIndex

type	Number
readonly	Returns the rowIndex constituting the cell.

rowSpan

type	Number
readonly	Returns the rowSpan that composes the cell.

style

type	GridStyler
readonly	Returns the style settings. cpr.data.UIControl.style Note

tooltip

type	String
get	Get a cell tooltip.
set	Specifies a cell tooltip. It works on mouse over.

ariaLabel(ariaLabel)

Applies the entered ariaLabel value to the aria-label attribute of the control HTML element.
Only valid in fieldLabel attribute expressions.
When ariaLabel is used, only the entered ariaLabel value is applied, not including cell location information and text values that are applied by default.

Parameters

name	type		description
ariaLabel	String		ariaLabel to set

return	String	Applied ariaLabel

bind(name)

Bind that property.

Parameters

name	type		description
name	String		The attribute name to bind.

return	IBindFactory	Factory showing bind type.

getAriaColIndex()

Returns the value of the cell number.
If the cell is not visible on the grid, no value is returned. Or you must use wholeRenderingMode.
The getAriaColIndex information is required for accessibility.
If ariaLabelCellPosition is set to false in the default.js setting, cell location information is not included in the grid cell aria-label. Use getAriaColIndex when the user wants to include cell location information as fieldLabel.

return	Number

getBindInfo(name)

Returns bind attribute information.

Parameters

name	type		description
name	String		The name of the attribute being bound.

return	BindInfo	BindInfo Properties

isBindable(name)

Make sure it is a bindable property.

Parameters

name	type		description
name	String		Properties to check.

return	Boolean

unbind(name)

Unbind that property.

Parameters

name	type		description
name	String		Attribute name to unbind.