GridContainer Class |
Namespace: Aras.Client.Controls.Public
Aras.Client.Controls.Public.GridContainer = function(); Type.createClass( 'Aras.Client.Controls.Public.GridContainer');
The GridContainer type exposes the following members.
Name | Description | |
---|---|---|
![]() | GridContainer |
Name | Description | |
---|---|---|
![]() | bgColor |
The default cell bgcolor.
|
![]() | bgInvert |
Enable background row color inverting when selected. Default is true.
|
![]() | borderGColor |
Cell border color.
|
![]() | delimeter |
The delimiter character.
|
![]() | font |
The default text font.
|
![]() | rowHeight |
Specifies the default row height in pixels. Default is 26.
|
Name | Description | |
---|---|---|
![]() | addAllColumnsToDiffView |
Add all columns to difference list.
Columns in difference list will be checked in redline voew mode.
|
![]() | addColumnToDiffView | |
![]() | addRow |
Adds a new row to the table.
|
![]() | addXMLRows |
Adds new rows loading information from xml document.
|
![]() | cellIsCheckbox |
Returns true if this cell contains a checkbox.
|
![]() | cells |
Get cell object to manipulate directly with its properties. Special row ids: "header_row", "input_row".
|
![]() | cells2 |
Get cell object to manipulate directly with its properties.
|
![]() | cellWasChanged |
Returns true if cell's value was changed by user during the last editing of this cell, false otherwise.
|
![]() | clear | |
![]() | copyRowContent | |
![]() | deleteColumn | |
![]() | deleteRow |
Deletes a row with the specified id.
|
![]() | deleteSelectedItem |
Deletes the selected row.
|
![]() | deselect |
Deselect all selected rows.
|
![]() | disable |
Disables grid
|
![]() | disableSortingByColumn | |
![]() | dropNewRowMarkers | |
![]() | editCell |
Move focus to this cell and switch it to the editable mode.
|
![]() | editCellX | |
![]() | enable |
Enables grid
|
![]() | enablePopup | |
![]() | Event:gridClick |
Occurs when the mouse pointer is over the grid cell and a mouse button is pressed.
JavaScript clientControlsFactory.on(control, "gridClick", gridClick); |
![]() | Event:gridDoubleClick |
Occurs when any item in grid is double clicked.
JavaScript clientControlsFactory.on(control, "gridDoubleClick", gridDoubleClick); |
![]() | Event:gridEditCell |
Calls when cell edit state is changed.
JavaScript clientControlsFactory.on(control, "gridEditCell", gridEditCell); |
![]() | Event:gridKeyPress |
Occurs when a key is pressed.
JavaScript clientControlsFactory.on(control, "gridKeyPress", gridKeyPress); |
![]() | Event:gridLinkClick |
Called when any Hyperlink in grid is clicked.
JavaScript clientControlsFactory.on(control, "gridLinkClick", gridLinkClick); |
![]() | Event:gridMenuClick |
Occurs when a menu item is clicked.
JavaScript clientControlsFactory.on(control, "gridMenuClick", gridMenuClick); |
![]() | Event:gridMenuInit |
Occurs before menu is shown.
JavaScript clientControlsFactory.on(control, "gridMenuInit", gridMenuInit); |
![]() | Event:gridRowSelect |
Occurs before any row becomes selected.
JavaScript clientControlsFactory.on(control, "gridRowSelect", gridRowSelect); |
![]() | Event:gridSelectCell |
Occurs when a cell is selected in UI.
JavaScript clientControlsFactory.on(control, "gridSelectCell", gridSelectCell); |
![]() | Event:gridSort |
Occurs when column is sorted.
JavaScript clientControlsFactory.on(control, "gridSort", gridSort); |
![]() | Event:gridXmlLoaded |
Occurs when XML content is loaded and parsed.
JavaScript clientControlsFactory.on(control, "gridXmlLoaded", gridXmlLoaded); |
![]() | getAction | |
![]() | getAllItemIds |
Returns a list of all rows ids separated by the specified separator.
|
![]() | getCellHeight | |
![]() | getCellValue |
A shortcut to get this cell value.
|
![]() | getCellX | |
![]() | getCellXY | |
![]() | getCellY | |
![]() | getColumnAt | |
![]() | getColumnCount |
Get column count.
|
![]() | getColumnIndex |
Gets column index by column name.
|
![]() | getColumnName |
Gets column name by column index.
|
![]() | getColumnOrder |
Get this column order.
|
![]() | getColWidth |
Get this column width.
|
![]() | getColWidths |
Gets all columns widths divided by ;
|
![]() | getCombo | |
![]() | getCurRow |
Get row number for currently selected row.
|
![]() | getHeader |
Not implemented now.
|
![]() | getHeaderCol |
Returns column header label.
|
![]() | getHeaderIndex |
For Automation. Gets header index. Returns -1 if no such header
|
![]() | getHorAligns | |
![]() | getLogicalColumnOrder |
Gets all column names divided by ; and in order they are shown in grid.
|
![]() | getMenu |
Gets pointer to grid context menu.
|
![]() | getRowAt | |
![]() | getRowCount |
Gets the number of rows actually contained in the table.
|
![]() | getRowId |
Get row ID by row index (zero based, from "top" to "bottom").
|
![]() | getRowIndex |
Returns sequential index of this row.
|
![]() | getRowsNum |
Returns the total number of rows in the table.
|
![]() | getSelectedCell |
Returns selected cell
|
![]() | getSelectedID |
Returns the id of the selected row.
|
![]() | getSelectedItemIDs |
Returns a list of selected rows' ids separated by specified separator.
|
![]() | getUserControlInfo | |
![]() | getUserData |
Get extra row data stored by USERDATAn parameter for this row (or by SetUserData method).
|
![]() | getUserDataX | |
![]() | getVisibleItemIDs |
Returns a list of all currently visible rows ids separated by specified separator.
|
![]() | getXml | |
![]() | initXML |
Load this XML string/url into the grid.
XML <table editable="true" multiselect="true"><columns><column width="100" align="left" order="0"></column><column width="200" align="center" order="1"></column></columns><thead height="20"><th>header 1</th><th>header 2</th></thead></table> |
![]() | initXMLRows |
Initialize rows from xml document.
|
![]() | insertRowAt | |
![]() | isColumnVisible |
Gets value that indicates whether the column is visible or hidden.
|
![]() | isEditable |
Returns true if cell editing is enabled.
|
![]() | isInputRowVisible |
Returns true when input row is visible
|
![]() | isItemExists |
Returns true if the row with specified id exists in the table, otherwise false.
|
![]() | isMultiselect |
Returns true if multiselect is enabled.
|
![]() | loadBaselineXml |
Load base XML for comparation
|
![]() | loadCheckboxIcons | |
![]() | loadSortIcons | |
![]() | menu |
Get popup menu object to manipulate directly with its properties.
|
![]() | menuAdd |
Adds a ToolStripItem that displays the specified image and text to the collection.
|
![]() | menuAddSeparator |
Adds a menu separator. Now adds separator like "-".
|
![]() | menuRemoveAll |
Removes all MenuItem objects from the menu item collection.
|
![]() | menuSetEnabled |
Gets or sets a value indicating whether the menu item is enabled.
|
![]() | moveRowDown |
Moves the specified row down in the table.
|
![]() | moveRowUp |
Moves the specified row up in the table.
|
![]() | removeAllColumnsFromDiffView | |
![]() | removeAllRows |
Remove all rows from grid.
|
![]() | removeColumnFromDiffView |
Remove column from difference list by name.
Columns in difference list will be checked in redline voew mode.
|
![]() | requestFocus |
Sets input focus to the control.
|
![]() | scrollToColumn | |
![]() | selectAll |
Select all rows in grid.
|
![]() | setAction | |
![]() | setCellCombo |
Set comboBox for specified cell.
|
![]() | setCellFont |
Sets fort for specified cell.
Value is in the following formats:
Name-style-size, style:{bold,italic,bolditalic}
[examples: Courier-bold-12]
|
![]() | setCellLink |
Sets link for specified cell.
|
![]() | setCellTextColor |
Sets text color in specified cell.
|
![]() | setCellValue |
A shortcut to set this cell value.
|
![]() | setColumnCount | |
![]() | setColumnOrder | |
![]() | setColumnProperties |
A comma delimited list of name/value pairs to configures the column by setting its type and other properties.
type={FIELD|COMBO|NOEDIT}, list={integer}, sortable={yes|no}, sorttype={string|numeric|date}, inputformat={format_string}, locale={locale_string}
Property name is case sensitive.
Type NOEDIT means this column's cells will be non-editable.
Type FIELD means cells will be editable with input field as edit widget.
Type COMBO means cells will be editable with combobox as edit widget.
For type=COMBO also specify the LISTn property to Initialize combobox.
For type=COMBO also specify the LISTn property to Initialize combobox.
You also can Initialize combobox at runtime using ONEDITCELL event handler.
There is also a possibility to insert checkbox in cell. See TEXTn parameter description.
example 1: type=COMBO,list=1,sortable=no
example 2: sorttype=date, inputformat={dd/MM/yy, hh:mm:ss},locale=enUS
|
![]() | setColumnVisible |
Sets column visible
|
![]() | setColWidth | |
![]() | setComboList | |
![]() | setCursor | |
![]() | setEditable |
Enable/Disable cell editing at runtime.
|
![]() | setHeader | |
![]() | setHeaderCol | |
![]() | setHorAligns | |
![]() | setInitWidths | |
![]() | setInitWidthsP | |
![]() | setMultiselect |
Enable/Disable multiselect at runtime.
|
![]() | setPaintEnabled | |
![]() | setRowBgColor | |
![]() | setRowTextBold | |
![]() | setRowTextNormal | |
![]() | setSelectedRow |
Set selected row at runtime. If multi == false new row becomes the only selected row. If
multi == true new row becomes the selected and all previously selected rows stay selected
also. You should use next trick to Deselect all rows:
|
![]() | setUserData |
To set row level data. You can use this method to store some extra data or flags.
|
![]() | setUserDataX | |
![]() | setUserDragData | |
![]() | showContent | |
![]() | showInputRow |
Display input row it true; otherwise, input row will be hidden.
|
![]() | showRow | |
![]() | sort |
Sort table by column in ascending or descending order.
|
![]() | sortEx | |
![]() | stretchColumnWidths | |
![]() | turnEditOff |
Direction to lost focus from grid cell.
|