cpr.controls.gridpart.GridDetailColumn

Hierarchy

Properties

Name	Type	Description
cellIndex	Number	Returns the cellIndex of the cell.
cellProp	GridDetailCellProp	Returns the configuration information of the cell.
colIndex	Number	Returns the colIndex constituting the cell.
colSpan	Number	Returns the colSpan that composes the cell.
columnName	#column	Returns the column name of the DataSet mapped to this cell.
columnType	String	Returns the columnType set in the cell.
control	UIControl	Returns the controls in that cell.
controlType	String	Returns the control type of the control in that cell.
expr	String	Returns the expression set in the cell.
fieldLabel	String	Returns the logical field name of the cell.
filterable	Boolean	If it is a cell in the header area, returns whether the multi-filter function is used in that cell.
formula	String	Returns the function expression to be expressed in a cell when exporting to Excel.
keepMerged	Boolean	Returns whether to maintain the merged state applied to the merged cell when entering edit mode.
mergeToIndexExpr	#expression	Returns an expression that returns the cellIndex of the cell to be merged.
mergedColumnName	#column	Returns the data set column name to be expressed in the cells merged by the mergeToIndexExpr property.
rowIndex	Number	Returns the rowIndex constituting the cell.
rowSpan	Number	Returns the rowSpan that composes the cell.
sortColumnName	String	In the case of a cell in the header area, the column name to be sorted is returned when the cell is clicked.
sortable	Boolean	If it is a cell in the header area, returns whether the multi-sort function is used in that cell.
style	GridStyler	Returns the style settings.
suppressRef	String	Returns other column index settings that will affect the suppressible (cell text hidden) effect.
suppressible	Boolean	Cells that match the value of the immediately previous row will return a setting value that indicates whether to hide the text.
suppressibleExpr	#expression	Returns an expression that returns whether or not to actually suppress the cell for which suppressible is true.
targetColumnName	String	For cells in the header area, when using filterable and sortable of the cell, the target dataset column name of the function is returned.
text	String	Returns the text set in the cell.
tooltip	String	Get a cell tooltip.
visible	Boolean	Returns the visible setting of the detail cell.

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.
getControl	UIControl	Returns the controls in that cell.
getControlAttr	Object	Returns the value of the specific property of the control in a particular row if the control exists in that cell.
getExpr	String	Returns the expression set in the cell.
getText	String	Returns the text set in the cell.
isBindable	Boolean	Make sure it is a bindable property.
isLastCell	Boolean	Returns whether the current column is the last data cell.
isLastColumn	Boolean	Returns whether the current column is the last data column.
setExpr		Set an expression in that Cell.
setText		Set text in the cell.
unbind		Unbind that property.

cellIndex

declaring type	GridColumn
type	Number
readonly	Returns the cellIndex of the cell.

cellProp

type	GridDetailCellProp
readonly	Returns the configuration information of the cell.

colIndex

declaring type	GridColumn
type	Number
readonly	Returns the colIndex constituting the cell.

colSpan

declaring type	GridColumn
type	Number
readonly	Returns the colSpan that composes the cell.

columnName

type	#column
get	Returns the column name of the DataSet mapped to this cell. (Column names can exist only in cells in the Detail area.)
set	Set the column name of the DataSet mapped to the cell. (Column names can exist only in cells in the Detail area.)

columnType

type	String
readonly	Returns the columnType set in the cell. (ColumnType can exist only in the cells of the Header, Detail, and Group Header areas.)

control

type	UIControl
readonly	Returns the controls in that cell.

controlType

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

expr

deprecated19.01.21 This function is provided only in the footer area.

type	String
get	Returns the expression set in the cell. (footer only)
set	Set an expression in that Cell. (footer only)

fieldLabel

declaring type	GridColumn
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.

filterable

deprecatedThis function is provided only in the 19.01.21 header area.

type	Boolean
get	If it is a cell in the header area, returns whether the multi-filter function is used in that cell.
set	In the case of a cell in the header area, set whether to use the multi-filter function in the cell.

formula

declaring type	GridColumn
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

keepMerged

type	Boolean
get	Returns whether to maintain the merged state applied to the merged cell when entering edit mode.
set	Set whether to keep the merged state applied to the merged cell when entering edit mode.

mergeToIndexExpr

type	#expression
get	Returns an expression that returns the cellIndex of the cell to be merged. The cell of cellIndex returned as a result of the expression execution must be located to the right of the current cell. (The cell must have a colIndex greater than or equal to the colIndex of the current cell.)
set	Sets an expression that returns the cellIndex of the cell to be merged. The cell of cellIndex returned as a result of the expression execution must be located to the right of the current cell. (The cell must have a colIndex greater than or equal to the colIndex of the current cell.)

mergedColumnName

type	#column
get	Returns the data set column name to be expressed in the cells merged by the mergeToIndexExpr property.
set	Set the data set column name to be displayed in the merged cell by the mergeToIndexExpr property.

rowIndex

declaring type	GridColumn
type	Number
readonly	Returns the rowIndex constituting the cell.

rowSpan

declaring type	GridColumn
type	Number
readonly	Returns the rowSpan that composes the cell.

sortColumnName

deprecatedThis function is provided only in the 19.01.21 header area.

type	String
get	In the case of a cell in the header area, the column name to be sorted is returned when the cell is clicked.
set	In the case of a cell in the header area, set the column name to be sorted when the cell is clicked.

sortable

deprecatedThis function is provided only in the 19.01.21 header area.

type	Boolean
get	If it is a cell in the header area, returns whether the multi-sort function is used in that cell.
set	In the case of a cell in the header area, set whether to use the multi-sort function in the cell.

style

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

suppressRef

type	String
get	Returns other column index settings that will affect the suppressible (cell text hidden) effect. (Related property: [suppressible] This property is valid when suppressible=true.)
set	Set other column indices that will affect the suppressible (cell text hidden) effect. (Related property: [suppressible] This property is valid when suppressible=true.)

suppressible

type	Boolean
get	Cells that match the value of the immediately previous row will return a setting value that indicates whether to hide the text. (Providing a cell merging effect)
set	Cells matching the value of the immediately preceding row hide the text. (Provides cell merging effect) When the detail line at the time of design has two or more lines, If the detail has as many rowSpans as the total number of rows, suppression is supported, Suppression is not supported for individual lines. In the case of tree cells, only the lowest leaf node supports suppression when the level and value are the same.

suppressibleExpr

type	#expression
get	Returns an expression that returns whether or not to actually suppress the cell for which suppressible is true. When the value returned as a result of expression execution is true, suppress is executed, and when false, it is excluded from suppression. Only when suppressible is true, suppress is executed by default when not set as a valid attribute.
set	Sets an expression that returns whether or not to perform actual suppression on cells for which suppressible is true. When the value returned as a result of expression execution is true, suppress is executed, and when false, it is excluded from suppression. Only when suppressible is true, suppress is executed by default when not set as a valid attribute.

targetColumnName

deprecatedThis function is provided only in the 19.01.21 header area.

type	String
get	For cells in the header area, when using filterable and sortable of the cell, the target dataset column name of the function is returned.
set	For cells in the header area, when using filterable and sortable of the cell, set the target dataset column name of the function.

text

deprecatedThis function is provided only in the 19.01.21 header area.

type	String
get	Returns the text set in the cell. (header only)
set	Set text in the cell. (header only)

tooltip

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

visible

deprecated

type	Boolean
get	Returns the visible setting of the detail cell.
set	Returns the visible setting of the detail cell. 19.01.21 This function is provided only in the header area.

ariaLabel(ariaLabel)

declaring typeGridColumn

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)

declaring typeGridColumn

Bind that property.

Parameters

name	type		description
name	String		The attribute name to bind.

return	IBindFactory	Factory showing bind type.

getAriaColIndex()

declaring typeGridColumn

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)

declaring typeGridColumn

Returns bind attribute information.

Parameters

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

return	BindInfo	BindInfo Properties

getControl(conditionalId)

Returns the controls in that cell. If the cell is a conditional control, you must enter the ConditionalID.

Parameters

name	type		description
conditionalIdoptional	String		Conditional ID.

return	UIControl	Control in that cell.

getControlAttr(rowIndex, attrName)

Returns the value of the specific property of the control in a particular row if the control exists in that cell.

Parameters

name	type		description
rowIndex	Number		Row index to get the attribute value.
attrName	String		Attribute name.

return	Object	Property Value.

getExpr()

deprecated19.01.21 This function is provided only in the footer area.

Returns the expression set in the cell.
(footer only)

return	String	The expression set in the cell.

getText()

deprecatedThis function is provided only in the 19.01.21 header area.

Returns the text set in the cell.
(header only)

return	String	The text set in the cell.

isBindable(name)

declaring typeGridColumn

Make sure it is a bindable property.

Parameters

name	type		description
name	String		Properties to check.

return	Boolean

isLastCell()

Returns whether the current column is the last data cell.

return	Boolean	Whether it is the last cell

isLastColumn()

Returns whether the current column is the last data column.

return	Boolean	Whether it is the last column

setExpr(expr)

deprecated19.01.21 This function is provided only in the footer area.

Set an expression in that Cell.
(footer only)

Parameters

name	type		description
expr	String		The expression to set.

setText(text)

deprecatedThis function is provided only in the 19.01.21 header area.

Set text in the cell.
(header only)

Parameters

name	type		description
text	String		The text to set.

unbind(name)

declaring typeGridColumn

Unbind that property.

Parameters

name	type		description
name	String		Attribute name to unbind.