WebSquare.uiplugin.gridView.column

Type

uiplugin

Property Summary

adaptiveStyle: Class to apply to the GridView in the adaptive mode.
allOption: Displays the All label when the inputType is selectbox.
allowChar: Characters that can be inputted by the end user.
alt: alt property of the image when the inputType is image.
applyFormat: Applies the format in the editing mode as well as other modes.
autocomplete: Same as autocomplete in HTML5. Specify the message to display after type validation.
autoFitFilterList: Sets the useFilterList and the useFilter as "true", and adjusts the width of the filter list in the header.
blockSelect: Blocks selection of the column.
calendarClass: Skin type of the calendar.
calendarValueType: Calendar type when the inputType is calendar.
checkAlways: Checks readOnly or disabled rows when checking the header in case the inputType of the header and the body is checkbox. (Set the property in the body.)
checkboxLabel: Property to display the label when the inputType is checkbox.
checkboxLabelColumn: In case of inputType="checkbox" column, the label is generated by combining information of the columns (to comply with the web accessibility requiremets.)
checkboxLabelFormatter: Name of the function that converts the label data of the CheckBox button when the inputType is "checkbox" (to comply with web accessibility requirements.)
checkboxLabelPosition: The position to display the label next to the checkbox - right or left.
checkcomboboxRangeSeparator: Displays the continuous values in "x-y" format on inputType="checkcombobox" column.
checkcomboboxUseDrag: Allows the end user to selects multiple items on inputType="checkcombobox" column through mouse dragging.
checkcomboboxUseEdit: Allows the end user to directly edit the value in inputType="checkcombobox" column.
checkcomboboxValidateOnInput: [default: false] Validates the user’s input (useEdit=“true”) for the inputType="checkcombobox" column. Supported in IE9 or higher versions supporting oninput event.
checkcomboboxVisibleColMax: Number of the columns to display for the inputType="checkcombobox" column. To be used when the number of columns are decided based on the number of the selection items.
checkcomboboxVisibleColNum: Number of the column to display for the inputType="checkcombobox" column.
checkcomboboxVisibleRowNum: Number of the rows to display for the inputType="checkcombobox" column.
checkHeaderOnviewchange: Generates onviewchange event upon user’s clicking the header heckbox when the inputType of the header or of the body is “checkbox”.
chooseOption: Displays the selection guide message.
chooseOptionLabel: Set the label of the selection guide message.
class: Class to apply to column.
closeonmouseleave: Closes the list upon mouse moving out when the list is open on the subLayer. [default: false, true]
colMerge: Displays the rows of the same data on the selected column in a single cell.
colSpan: Number of columns to span
copyOption: When copying Gridview data, decide which value to copy - those defined in the DataList (“dataList”) or those currently display (“display”).
customFormatter: Name of the formatter function that receives data, formattedData, rowIndex, and colIndex as parameters.
customModelFormatter: User-defined function executed before the data is saved in the dataCollection bound with the component. [default: ""]
customModelUnformatter: User-defined function to be executed upon the data being read from the dataCollection bound with the component. [default: ""]
dataType: Data type of the column
dateValidCheck: Validates when the dataType is date.
dateValidSet: [default: false, true] For dataType="date", validates the inputted date. If not valid, goes back to the previous value.
dateValidSetCustom: [default: false, true] In case invalid data is entered, only the invalidMessageFunc will be called.
defaultValue: Initial value of the cell
delimiter: Delimiter to separate the value from the label when both the value and the label are displayed on the list.
depthColumn: Column ID to display the depth when the inputType is drilldown.
depthType: Displaying method of the node relations when using the drilldown feature.
directOpen: Directly opens the item table upon clicking the arrow button of the AutoComplete. Valid for viewType="icon" and viewTypeIconImage="true".
disabled: Disable the cell.
disabledClass: Class to add when the cell is disabled.
displayFormat: Value displaying format in the cell
displayFormatFunc: User-defined function to apply in case of dataType="date".
displayFormatter: Name of the function to format the data of the cell.
displayMode: Displaying method. [default: label, value delim label, label delim value, value]
displayType: Displays all text in the widened cell in case of inputType="textarea".
editModeEvent: Mouse action event to edit the cell data.
editModeEventIcon: Mouse action to edit cell data in the viewType="icon" column.
editType: Sets the operation triggered by the end user’s clicking the component.
embeddedInput: An input component in the cell or dynamically add upon conversion to the editMode.
escape: Converts <>&" characters into HTML Escape characters.
escapeFormatter: Name of the excapeFormatter function that receives data, rowIndex, and colIndex as parameters.
eventPriority: Decides which event to trigger first - onviewchange or oneditend - when the inputType is 'select'. [default: onviewchange, oneditend]
excelCellType: Specify the display type (cell type) of the data on the downloaded Excel file.
excelExpression: Applies the Excel formula to the Excel file downloaded by advancedExcelDownload from the GridView.
excelFormat: Sets the Excel file format to be downloaded from the GridView by the advancedExcelDownload() method.
excelFormatter: Set the excelFormat for the Excel file to be downloaded form the GridView by the advancedExcelDownload() method.
expression: Formula for inputType="expression".
falseValue: Value to be used upon cell unselection when the valueType is other.
filterDisplayMode: Displaying mode of the items
fixColumnWidth: Fixes the width of the column.
fixPickerStatus: Decide the items to fixe for pickerType="dynamic".
hidden: Hidden status of the column
hiddenClass: Class to add when the column is hidden.
hideCustomFilter: Hides the user-defined filter in case of useFilter="true".
hideThreshold: Threshold to hide columns when the screen size is reduced. (Unit: px)
id: Column ID
ignoreChar: Characters that are banned among those initially allowed for the end user.
imageClickFunction: Function to execute upon cell clicking in case of inputType="image" or inputType="textimage".
imageHeight: Height of the image when the inputType is image.
imageSrc: Path of the image when the inputType is image.
imageWidth: Width of the image when the inputType is image.
imeMode: Set ime-mode(css) for inputType="text".
importExp: Data conversion formula for the inputted data.
inputType: Cell type
ioFormat: Data format for format conversion of date-type data.
keepFocusOnCheckHeaderClick: [default: false, true] Keeps the focus on the selected cell on the body of which inputTypei is "checkbox" although the end user clicks the header.
localeRef: Key of the language text.
maskFormat: Provides a similar feature to that of jQuery Mask plug-in. Changes numeric characters instead of #. [default: ""]
maskFormatModelExcludeChar: Specifies the characters to exclude from the bound DataCollection when using the maskFormat.
max: Maximum value when the dataType is number.
maxByteLength: Maximum byte length.
maxLength: Maximum length.
min: Minimum value when the dataType is number.
minWidth: Minimum width of the column
monthNames: String data of the months from January to December divided by comma (,).
navBtn: When the inputType is "checkcombox", displays [Unselect] and [Select] buttons below the list.
noDisabledOnReadOnly: Does not disable the readOnly="true" cells on inputType="checkbox" or "radio" column.
orderByColumn: ID of the body column based on which the data is to be sorted.
partialCheckNextClick: Defines the operation upon the end user’s clicking the checked header (inputType="checkbox") on the GridView.
pickerType: Decides how to select years and months on the calendar.
placeholder: Valid when the input Type is text, textarea, textImage, calendar, spinner, secret, or autoComplete. Shows the placeholder upon the end user’s entering the editing mode.
radioLabel: Displays the label when the inputType is radio.
radioLabelColumn: For inputType="radio", the column label will be generated by referring to other columns (in order to comply with the web accessibility requirements.)
radioLabelDelimiter: Sepearator for the label values of the radioLabelColumn. [default: ","]
radioLabelFormatter: Name of the function to convert the label data of the Radio button when the inputType is "radio" (to comply with the web accessibility requirements.)
radioLabelPosition: Decides the position to display the label next to the radio - right or left.
readOnly: Current value of the readOnly property for the column.
readOnlyClass: Name of the class to add in readOnly state.
rowSpan: Number of rows to span
searchTarget: Search target to suggest items for the end user when the inputType is "autoComplete".
selectedData: Keeps the selected data which does not exist in the bound DataList when the inputType is "select" or "autoComplete".
separator: Delimiter in case of inputType="checkcombobox".
showDepth: Depth to display upon initial loading when the inputType is drilldown.
skipKeyMoveEditMode: Ignores keyMoveEditMode, moveKeyEditMode, and moveKeyEditModeAll properties in certain columns.
sortable: Use of the sorting feature. [default: false, true]
sortLabel: Properties for the body column. To be set in the body column. [default: false, true]
textAlign: Text alignment of the cell
trueValue: Value to be used upon cell selection when the valueType is other.
type: Same as the type tag in HTML.
typeGetter: Name of the function that returns the inputType when the inputType is custom. Not supported when inputType is “drilldown”.
upperColumn: Column ID to serve as the starting point for colMerge
useFilter: Use of the filter. [default: false, true]
useKeywordHighlight: Applies a separate class to the keyword in the searched result when the inputType is "autoComplete".
useLocale: Multilanguage support
useMonthYearFormat: Converts the year/month order displayed on the calendar into month/year order. [default: false, true]
userData1: User-defined property.
userData2: User-defined property.
userData3: User-defined property.
validateOnInput: [default: false] Whether to validate the input on inputType "text" or "calendar" column. (Supported in IE9 and higher versions which support the oninput event.)
validator: Executes the defined function upon blurring in the input column.
value: Cell value
valueType: When the inputType is radio or checkbox, determines the trueValue as well as the falseValue.
viewType: Displays the icon proper for the inputType of the column.
viewTypeIconImage: Displays the arrow with an image to open the item table of the Calendar or AutoComplete.
voidNull: Sets the href value as javascript:void(null); when the inputType is link.
width: Column width
yearSuffix: Character string to be added after the year data.

Event Summary

Method Summary

Property Detail

adaptiveStyle: Class to apply to the GridView in the adaptive mode.
(Supports only height at present.)
allOption: Displays the All label when the inputType is selectbox.
allowChar: Characters that can be inputted by the end user.
alt: alt property of the image when the inputType is image.
applyFormat: Applies the format in the editing mode as well as other modes.
autocomplete: Same as autocomplete in HTML5. Specify the message to display after type validation.
Support may differ by browser.
autoFitFilterList: Sets the useFilterList and the useFilter as "true", and adjusts the width of the filter list in the header. [default: false, true]
blockSelect: Blocks selection of the column.
calendarClass: The skin type of the calendar. [default:class1, class2, class3, class4, class5]
calendarValueType: Calendar type when the inputType is calendar.
checkAlways: Checks readOnly or disabled rows when checking the header in case the inputType of the header and the body is checkbox. (Set the property in the body.)
Apply the property to the body.
checkboxLabel: Property to display the label when the inputType is checkbox.
Display the property value next to the checkbox.
Determine the right and the left positions using the checkboxLabelPosition property.
checkboxLabelColumn: In case of inputType="checkbox" column, the label is generated by combining information of the columns (to comply with the web accessibility requiremets.)
Multiple IDs to refer to in order to generate the label can be separated by delimiters (',').
checkboxLabelFormatter: Name of the function that converts the label data of the CheckBox button when the inputType is "checkbox" (to comply with web accessibility requirements.)
The value returned by the function is used as the label. Three parameters of rowIndex, colIndex, and label must be sent.
checkboxLabelPosition: The position to display the label next to the checkbox - right or left. [default: right]
checkcomboboxRangeSeparator: The range is determined based on the sequence of the items on the selection item list.
checkcomboboxUseDrag: Allows the end user to selects multiple items on inputType="checkcombobox" column through mouse dragging.
Hold the Shift and drag the mouse to unselect items.
checkcomboboxUseEdit: (Options) "true": Allows end users to directly enter selection items in the input field. "false" (Default) : Not allows end users to directly enter selection items. (The end user must click the checkbox, and setValue() API must be used to set the selections.)
checkcomboboxValidateOnInput: [default:false] Validates the user’s input (useEdit=“true”) for the inputType="checkcombobox" column. Supported in IE9 or higher versions supporting oninput event.
checkcomboboxVisibleColMax: Number of the columns to display for the inputType="checkcombobox" column. To be used when the number of columns are decided based on the number of the selection items.
visibleColNum = Math.min(visibleColMax, Math.ceil(itemCount / visibleRowNum))
In case the visibleColNum is defined, the visibleColMax will be denied.
checkcomboboxVisibleColNum: Number of the column to display for the inputType="checkcombobox" column. The default is 1.
checkcomboboxVisibleRowNum: Number of the rows to display for the inputType="checkcombobox" column. "1" is not recommended.
checkHeaderOnviewchange: Whether to trigger onviewchange event upon the user's clicking the header checkbox when the inputType of the header and of the body is "checkbox"
When enabled, user's selecting the header checkbox will triger as many onviewchange events as the number of the rows with changed status.
chooseOption: Displays the selection guide message.
Display the text defined as the chooseOptionLabel property.
However, if chooseOptionLabel is not specified while chooseOption is "true", "-Choose-" (label) will be displayed.
At the time, the value will be "" (empty string).
chooseOptionLabel: Set the label of the selection guide message.
Valid in case of chooseOption="true".
class: Class to apply to column.
closeonmouseleave: Closes the list upon mouse moving out when the list is open on the subLayer. [default:false, true]
colMerge: Displays the rows of the same data on the selected column in a single cell.
colSpan: Number of columns to span
copyOption: When copying Gridview data, decide which value to copy - those defined in the DataList (“dataList”) or those currently display (“display”).
copyOption can be set for the entire gridView. However, the copyOption of the column has a higher priority.
directOpen: Directly opens the item table upon clicking the arrow button of the AutoComplete. Valid for viewType="icon" and viewTypeIconImage="true".
Directly opens AutoComplete or SelectBox upon the end user’s pressing Enter key while the focus is on the AutoComplete or SelectBox.
disabled: Disable the cell.
disabledClass: Class to add when the cell is disabled.
displayFormat: Value displaying format in the cell
displayFormatFunc: User-defined function to apply in case of dataType="date".
Sets the displayFormat with the return of the corresponding function.
Will be ignored when the displayFormat is defined.
displayFormatter: Name of the function to format the data of the cell.
The function is to be defined.
displayMode: Displaying method. [default: label, value delim label, label delim value, value]
Both the label and the value are displayed.
When the inputType of the GridView column is "select" or "autoComplete".
The delimiter is defined as a property.
displayType: Displays all text in the widened cell in case of inputType="textarea".
Valid when the width is defined and there is no horizontal scroll.
editModeEvent: Mouse action event to edit the cell data. [default: ondblclick, onclick, onsecondclick]
editModeEventIcon: Mouse action to edit cell data in the viewType="icon" column. [default: onclick, ondblclick]
editType: Sets the operation triggered by the end user’s clicking the component.
embeddedInput: An input component in the cell or dynamically add upon conversion to the editMode.
| Valid when the inputType is text, textarea, textImage, secret, or calendar.
escape: Decodes HTML escape characters as tags.
escapeFormatter: Name of the excapeFormatter function that receives data, rowIndex, and colIndex as parameters.
Formats the value, and returns the formatted value.
Functions almost same as the customFormatter. The purpose is however to directly control character string that can cause security issues such as <script> tag.
Valid when the inputType is text.
Formatter to be applied first.
eventPriority: Decides which event to trigger first - onviewchange or oneditend - when the inputType is 'select'. [default: onviewchange, oneditend]
Designed to ensure the lower compatibility.
eventPropagation: Propagate the click event when the inputType is "checkbox" or "radio". [default: false, true]
excelCellType: Specify the display type (cell type) of the data on the downloaded Excel file.
When downloading a GridView into an Excl file using advancedDataDownload() method, add options.useDataFormat : "true" option setting.
excelExpression: Applies the Excel formula to the Excel file downloaded by advancedExcelDownload from the GridView.
The end user can use the Excel formula. In case column names are set, it will be also applied to the downloaded Excel file.
(Related APIs: advancedEXcelDownload of the GridView)
excelFormat: Sets the Excel file format to be downloaded from the GridView by the advancedExcelDownload() method.
In case both the excelFormat and the displayFormat are defined, the excelFormat will be used.
(Related APIs: advancedEXcelDownload of the GridView)
excelFormatter: Set the excelFormat for the Excel file to be downloaded form the GridView by the advancedExcelDownload() method.
In case both the excelFormat and the displayFormat are defined, the excelFormat will be used.
(Related APIs: advancedEXcelDownload of the GridView)
expression: Formula when the inputType is expression.
falseValue: Value to be used upon cell unselection when the valueType is other.
filterDisplayMode: Item display. [default: value]
fixColumnWidth: Fixes the column width. [default:false, true]
hidden: Hidden status of the column
hiddenClass: Class to add when the column is hidden.
hideCustomFilter: Hides the user-defined filter in case of useFilter="true".
hideThreshold: Threshold to hide columns when the screen size is reduced. (Unit: px)
If not specified, column hiding will not occur although the screen size changes.
id: Column ID
ignoreChar: Characters that are banned among those initially allowed for the end user.
imageClickFunction: Function to execute upon cell clicking in case of inputType="image" or inputType="textimage".
For the function, the parameters such as rowIndex, colId, and nowValue are sent.
imageHeight: Height of the image when the inputType is image.
imageSrc: Path of the image when the inputType is image.
imageWidth: Width of the image when the inputType is image.
imeMode: Set ime-mode(css) for inputType="text".
Runs only on the browsers that support the ime-mode.
importExp: Data conversion formula for the inputted data.
inputType: Cell type
ioFormat: Data format for format conversion of date-type data.
localeRef: Key of the language text.
When there is no text for the key, "global_undefined" will be displayed on the screen.
maskFormat: Provides a similar feature to that of jQuery Mask plug-in. Changes numeric characters instead of #. [default: ""]
The applyFormat is to decide hot to apply the format.
Valid when the dataType is "text" or "number" In case the dataType is "number", "0" can be used to mask data.
(# is not displayed, but "0" is displayed when being inputted.)
maskFormatModelExcludeChar: Specifies the characters to exclude from the bound DataCollection when using the maskFormat.
The maskFormatModelExcludeChar contained in the data will not be saved in the DataCollection.
maxByteLength: Maximum byte length.
Maximum length (Valid when the inputType is text, input, textarea, textImage or secret.)
maxLength: Maximum length.
Maximum length (Valid when the inputType is text, input, textarea, textImage or secret.)
minWidth: Minimum width of the column. (Unit: px) [Default: 20]
monthNames: String data of the months from January to December divided by comma (,).
navBtn: When the inputType is "checkcombox", displays [Unselect] and [Select] buttons below the list.
[Unselect] - Cancels item selections.
[Select] - Applies item selections.
noDisabledOnReadOnly: Does not disable the readOnly="true" cells on inputType="checkbox" or "radio" column. [default: false, true]
orderByColumn: ID of the body column based on which the data is to be sorted.
partialCheckNextClick: Defines the operation upon the end user’s clicking the checked header (inputType="checkbox") on the GridView.
placeholder: Valid when the input Type is text, textarea, textImage, calendar, spinner, secret, or autoComplete. Shows the placeholder upon the end user’s entering the editing mode.
Same as the placeholder property in HTML5. Displays additional info such as hints for the end user.
When nothing is entered, the placeholder will be displayed. Upon end user’s input, the placeholder will disappear.
Depends on the browser. (Example: Text will disappear upon focusing in IE while text will disappear upon text input in Chrome.)
radioLabel: Displays the label when the inputType is radio.
Display the property value next to the radio.
Determine the right and the left positions using the radioLabelPosition property.
Unlike inputType="checkbox", the radio is supported only in the body, not the header.
radioLabelColumn: For inputType="radio", the column label will be generated by referring to other columns (in order to comply with the web accessibility requirements.)
Multiple IDs to refer to in order to generate the label can be separated by delimiters (',').
radioLabelFormatter: Name of the function to convert the label data of the Radio button when the inputType is "radio" (to comply with the web accessibility requirements.)
The value returned by the function is used as the label. Three parameters of rowIndex, colIndex, and label must be sent.
radioLabelPosition: Decides the position to display the label next to the radio - right or left. [default:right]
readOnly: Current value of the readOnly property for the column.
readOnlyClass: Name of the class to add in readOnly state.
rowSpan: Number of rows to span
searchTarget: Search target to suggest items for the end user when the inputType is "autoComplete". [default:label, value, both]
selectedData: Keeps the selected data which does not exist in the bound DataList when the inputType is "select" or "autoComplete". [default: true, false]
separator: Delimiter in case of inputType="checkcombobox". [default: Blank (space)]
showDepth: Depth to display upon initial loading when the inputType is drilldown.
skipKeyMoveEditMode: Ignores keyMoveEditMode, moveKeyEditMode, and moveKeyEditModeAll properties in certain columns. [default: false, true]
sortable: Use of the sorting feature. [default: false, true]
Supports through header clicking or double-clicking.
sortLabel: Properties for the body column. To be set in the body column. [default: false, true]
When the the inputType is "select", "autoComplete", or "custom"
and the sortable is "true", sorting will be made based on the label value.
textAlign: Text alignment of the cell
trueValue: Value to be used upon cell selection when the valueType is other.
type: Functions same as the html type tag. [default: text]
typeGetter: Name of the function that returns the inputType when the inputType is custom.
The customized function receives JSON object containing colID, colIndex, rowIndex, and realRowIndex, and returns the inputType for the cell.
upperColumn: Column ID to serve as the starting point for colMerge
useFilter: Use of the filter. [default: false, true]
Set the filtering status for each column.
useKeywordHighlight: Applies a separate class to the keyword in the searched result when the inputType is "autoComplete". [default: false, true]
useLocale: Multilanguage support
Uses multi-language keys of the client to display label values in multiple languages.
(For more information, see the user guide.)
useMonthYearFormat: Converts the year/month order displayed on the calendar into month/year order. [default: false, true]
When bound with the dataCollection, the date will be saved in order of "Year" > "Month" > "Day".
userData1: User-defined property.
Use getUserData("userData3") to get the data.
userData2: User-defined property.
Use getUserData("userData3") to get the data.
userData3: User-defined property.
Use getUserData("userData3") to get the data.
validateOnInput: [default:false] Whether to validate the input on inputType "text" or "calendar" column. (Supported in IE9 and higher versions which support the oninput event.)
true: Validates upon the oninput event being triggered.
false (Default): Does not validate input.
validator: Executes the defined function upon blurring in the input column.
The end user can use the Excel formula. In case column names are set, it will be also applied to the downloaded Excel file.
value: Cell value
valueType: When the inputType is radio or checkbox, determines the trueValue as well as the falseValue.
viewType: Displays the icon proper for the inputType of the column.
viewTypeIconImage: Displays the arrow with an image to open the item table of the Calendar or AutoComplete.
voidNull: Sets the href value as javascript:void(null); when the inputType is link.
width: Column width
yearSuffix: Character string to be added after the year data.

Event Detail

Method Detail

Copyrights Inswave Systems Co., Ltd.