Click or drag to resize

GridContainer Methods

The GridContainer type exposes the following members.

Methods
  NameDescription
Public methodaddAllColumnsToDiffView
Add all columns to difference list. Columns in difference list will be checked in redline voew mode.
Public methodaddColumnToDiffView
Public methodaddRow
Adds a new row to the table.
Public methodaddXMLRows
Adds new rows loading information from xml document.
Public methodcellIsCheckbox
Returns true if this cell contains a checkbox.
Public methodcells
Get cell object to manipulate directly with its properties. Special row ids: "header_row", "input_row".
Public methodcells2
Get cell object to manipulate directly with its properties.
Public methodcellWasChanged
Returns true if cell's value was changed by user during the last editing of this cell, false otherwise.
Public methodclear
Public methodcopyRowContent
Public methoddeleteColumn
Public methoddeleteRow
Deletes a row with the specified id.
Public methoddeleteSelectedItem
Deletes the selected row.
Public methoddeselect
Deselect all selected rows.
Public methoddisable
Disables grid
Public methoddisableSortingByColumn
Public methoddropNewRowMarkers
Public methodeditCell
Move focus to this cell and switch it to the editable mode.
Public methodeditCellX
Public methodenable
Enables grid
Public methodenablePopup
Public methodEvent:gridClick
Occurs when the mouse pointer is over the grid cell and a mouse button is pressed.
JavaScript
clientControlsFactory.on(control, "gridClick", gridClick);
Public methodEvent:gridDoubleClick
Occurs when any item in grid is double clicked.
JavaScript
clientControlsFactory.on(control, "gridDoubleClick", gridDoubleClick);
Public methodEvent:gridEditCell
Calls when cell edit state is changed.
JavaScript
clientControlsFactory.on(control, "gridEditCell", gridEditCell);
Public methodEvent:gridKeyPress
Occurs when a key is pressed.
JavaScript
clientControlsFactory.on(control, "gridKeyPress", gridKeyPress);
Public methodEvent:gridLinkClick
Called when any Hyperlink in grid is clicked.
JavaScript
clientControlsFactory.on(control, "gridLinkClick", gridLinkClick);
Public methodEvent:gridMenuClick
Occurs when a menu item is clicked.
JavaScript
clientControlsFactory.on(control, "gridMenuClick", gridMenuClick);
Public methodEvent:gridMenuInit
Occurs before menu is shown.
JavaScript
clientControlsFactory.on(control, "gridMenuInit", gridMenuInit);
Public methodEvent:gridRowSelect
Occurs before any row becomes selected.
JavaScript
clientControlsFactory.on(control, "gridRowSelect", gridRowSelect);
Public methodEvent:gridSelectCell
Occurs when a cell is selected in UI.
JavaScript
clientControlsFactory.on(control, "gridSelectCell", gridSelectCell);
Public methodEvent:gridSort
Occurs when column is sorted.
JavaScript
clientControlsFactory.on(control, "gridSort", gridSort);
Public methodEvent:gridXmlLoaded
Occurs when XML content is loaded and parsed.
JavaScript
clientControlsFactory.on(control, "gridXmlLoaded", gridXmlLoaded);
Public methodgetAction
Public methodgetAllItemIds
Returns a list of all rows ids separated by the specified separator.
Public methodgetCellHeight
Public methodgetCellValue
A shortcut to get this cell value.
Public methodgetCellX
Public methodgetCellXY
Public methodgetCellY
Public methodgetColumnAt
Public methodgetColumnCount
Get column count.
Public methodgetColumnIndex
Gets column index by column name.
Public methodgetColumnName
Gets column name by column index.
Public methodgetColumnOrder
Get this column order.
Public methodgetColWidth
Get this column width.
Public methodgetColWidths
Gets all columns widths divided by ;
Public methodgetCombo
Public methodgetCurRow
Get row number for currently selected row.
Public methodgetHeader
Not implemented now.
Public methodgetHeaderCol
Returns column header label.
Public methodgetHeaderIndex
For Automation. Gets header index. Returns -1 if no such header
Public methodgetHorAligns
Public methodgetLogicalColumnOrder
Gets all column names divided by ; and in order they are shown in grid.
Public methodgetMenu
Gets pointer to grid context menu.
Public methodgetRowAt
Public methodgetRowCount
Gets the number of rows actually contained in the table.
Public methodgetRowId
Get row ID by row index (zero based, from "top" to "bottom").
Public methodgetRowIndex
Returns sequential index of this row.
Public methodgetRowsNum
Returns the total number of rows in the table.
Public methodgetSelectedCell
Returns selected cell
Public methodgetSelectedID
Returns the id of the selected row.
Public methodgetSelectedItemIDs
Returns a list of selected rows' ids separated by specified separator.
Public methodgetUserControlInfo
Public methodgetUserData
Get extra row data stored by USERDATAn parameter for this row (or by SetUserData method).
Public methodgetUserDataX
Public methodgetVisibleItemIDs
Returns a list of all currently visible rows ids separated by specified separator.
Public methodgetXml
Public methodinitXML
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>
Public methodinitXMLRows
Initialize rows from xml document.
Public methodinsertRowAt
Public methodisColumnVisible
Gets value that indicates whether the column is visible or hidden.
Public methodisEditable
Returns true if cell editing is enabled.
Public methodisInputRowVisible
Returns true when input row is visible
Public methodisItemExists
Returns true if the row with specified id exists in the table, otherwise false.
Public methodisMultiselect
Returns true if multiselect is enabled.
Public methodloadBaselineXml
Load base XML for comparation
Public methodloadCheckboxIcons
Public methodloadSortIcons
Public methodmenu
Get popup menu object to manipulate directly with its properties.
Public methodmenuAdd
Adds a ToolStripItem that displays the specified image and text to the collection.
Public methodmenuAddSeparator
Adds a menu separator. Now adds separator like "-".
Public methodmenuRemoveAll
Removes all MenuItem objects from the menu item collection.
Public methodmenuSetEnabled
Gets or sets a value indicating whether the menu item is enabled.
Public methodmoveRowDown
Moves the specified row down in the table.
Public methodmoveRowUp
Moves the specified row up in the table.
Public methodremoveAllColumnsFromDiffView
Public methodremoveAllRows
Remove all rows from grid.
Public methodremoveColumnFromDiffView
Remove column from difference list by name. Columns in difference list will be checked in redline voew mode.
Public methodrequestFocus
Sets input focus to the control.
Public methodscrollToColumn
Public methodselectAll
Select all rows in grid.
Public methodsetAction
Public methodsetCellCombo
Set comboBox for specified cell.
Public methodsetCellFont
Sets fort for specified cell. Value is in the following formats: Name-style-size, style:{bold,italic,bolditalic} [examples: Courier-bold-12]
Public methodsetCellLink
Sets link for specified cell.
Public methodsetCellTextColor
Sets text color in specified cell.
Public methodsetCellValue
A shortcut to set this cell value.
Public methodsetColumnCount
Public methodsetColumnOrder
Public methodsetColumnProperties
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
Public methodsetColumnVisible
Sets column visible
Public methodsetColWidth
Public methodsetComboList
Public methodsetCursor
Public methodsetEditable
Enable/Disable cell editing at runtime.
Public methodsetHeader
Public methodsetHeaderCol
Public methodsetHorAligns
Public methodsetInitWidths
Public methodsetInitWidthsP
Public methodsetMultiselect
Enable/Disable multiselect at runtime.
Public methodsetPaintEnabled
Public methodsetRowBgColor
Public methodsetRowTextBold
Public methodsetRowTextNormal
Public methodsetSelectedRow
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:
Public methodsetUserData
To set row level data. You can use this method to store some extra data or flags.
Public methodsetUserDataX
Public methodsetUserDragData
Public methodshowContent
Public methodshowInputRow
Display input row it true; otherwise, input row will be hidden.
Public methodshowRow
Public methodsort
Sort table by column in ascending or descending order.
Public methodsortEx
Public methodstretchColumnWidths
Public methodturnEditOff
Direction to lost focus from grid cell.
Top
See Also