cpr.controls.gridpart.config.GridHeaderCellConfigurator

Hierarchy

Properties

Name	Type	Description
columnType	"checkbox" \| "normal"	If it is a default column, it returns the type of column.
control	UIControl	Returns the control placed in the cell.
controlConstraint	ControlConstraint	Returns Control Constraints.
emptyValueSort	EMPTYVALUESORT	When header sorting is used (sortable=true), processing of empty values is returned.
fieldLabel	String	Returns the logical field name of the cell.
filterDialogPosition	FilterDialogPosition	When using the Filterable property, it returns the position of the Filter Dialog.
filterDialogTitle	String	When using the filterable attribute, the title value of the filter dialog is returned.
filterable	Boolean	Returns the value of the multi-filter function through the column value specified by targetColumnName in the cell.
formula	String	Returns the function expression to be expressed in a cell when exporting to Excel.
sortColumnName	#column	Returns the name of the dataset column that has been sorted when the cell is clicked.
sortKeyExpression	#expression	When using header sorting (sortable=true), returns the expression by which to be sorted.
sortable	Boolean	Returns the multiple alignment feature settings in the cell.
style	GridStyler	Returns the style settings for the cell.
targetColumnName	#column	Returns the target dataset column name setting value of the corresponding function when filterable and sortable of the corresponding cell is used.
text	StyledString	Returns the string to be displayed in the header.
tooltip	String
visible	Boolean	Returns the visible setting for the entire column where the header cell is located.

Methods

Name	Return Type	Description
bind	IBindFactory	Gets the bind factory for the given attribute name.
getBindInfo	BindInfo	Returns bind attribute information.
isBindable	Boolean	Make sure it is a bindable property.
unbind

GridHeaderCellConfigurator(grid)

Parameters

name	type		description
grid	Grid

columnType

type	"checkbox" \| "normal"
get	If it is a default column, it returns the type of column. header: "rowindex", "checkbox", "normal"
set	In the case of the default column, set the type of column. Header: "Checkbox", "Normal"

control

declaring type	GridCellConfigurator
type	UIControl
get	Returns the control placed in the cell.
set	Sets the control for the cell.

controlConstraint

declaring type	GridCellConfigurator
type	ControlConstraint
get	Returns Control Constraints.
set	Set Control Constraints.

emptyValueSort

type	EMPTYVALUESORT
get	When header sorting is used (sortable=true), processing of empty values is returned.
set	Sets the handling of empty values when using header sorting (sortable=true).

fieldLabel

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

filterDialogPosition

type	FilterDialogPosition
get	When using the Filterable property, it returns the position of the Filter Dialog.
set	Set the location of the Filter Dialog when using the Filterable property.

filterDialogTitle

type	String
get	When using the filterable attribute, the title value of the filter dialog is returned.
set	When using the filterable attribute, set the title of the filter dialog.

filterable

type	Boolean
get	Returns the value of the multi-filter function through the column value specified by targetColumnName in the cell.
set	Sets whether to use the multi-filter function through the column value specified by targetColumnName for the cell.

formula

declaring type	GridCellConfigurator
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?) Convert 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 Excel row index

sortColumnName

type	#column
get	Returns the name of the dataset column that has been sorted when the cell is clicked. It is not compatible with the targetColumnName and sortable properties, which are different settings related to sorting of header cells. If both are set, the targetColumnName and sortable properties are applied.
set	Sets the dataset column name to sort when the cell is clicked. It is not compatible with the targetColumnName and sortable properties, which are different settings related to sorting of header cells. If both are set, the targetColumnName and sortable properties are applied.

sortKeyExpression

type	#expression
get	When using header sorting (sortable=true), returns the expression by which to be sorted.
set	When using header sorting (sortable=true), set the criteria to be sorted as an expression. ex. When you want to sort by column2 in a column whose targetColumnName is column1, set to 'column2'.

sortable

type	Boolean
get	Returns the multiple alignment feature settings in the cell.
set	Sets whether to use the multi-sort function by the column value specified by targetColumnName for the cell. It is not compatible with the sortColumnName property, which is another sort-related setting for header cells. If targetColumnName is specified and sortColumnName is specified in the header cell with sortable set to true, the targetColumnName and sortable properties are applied.

style

declaring type	GridCellConfigurator
type	GridStyler
readonly	Returns the style settings for the cell.

targetColumnName

type	#column
get	Returns the target dataset column name setting value of the corresponding function when filterable and sortable of the corresponding cell is used.
set	Set the target dataset column name of the function when using filterable and sortable of the cell.

text

type	StyledString
get	Returns the string to be displayed in the header.
set	Sets the string to be displayed in the header.

tooltip

declaring type	GridCellConfigurator
type	String

visible

type	Boolean
get	Returns the visible setting for the entire column where the header cell is located.
set	Sets the visible entire column where the header cell is located.

bind(name)

declaring typeGridCellConfigurator

Gets the bind factory for the given attribute name.

Parameters

name	type		description
name	String		The attribute name for which to get the bind factory.

return	IBindFactory

getBindInfo(name)

declaring typeGridCellConfigurator

Returns bind attribute information.

Parameters

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

return	BindInfo	BindInfo Properties

isBindable(name)

declaring typeGridCellConfigurator

Make sure it is a bindable property.

Parameters

name	type		description
name	String		Properties to check.

return	Boolean

unbind(name)

declaring typeGridCellConfigurator

Parameters

name	type		description
name	String

cpr.controls.gridpart.config.GridHeaderCellConfigurator

Index

Constructor

Properties

Methods