Click or drag to resize

TreeGridContainer Class

Container for grid in "tree" mode

Namespace:  Aras.Client.Controls.Public
Syntax
JavaScript
Aras.Client.Controls.Public.TreeGridContainer = function();

Type.createClass(
	'Aras.Client.Controls.Public.TreeGridContainer');

The TreeGridContainer type exposes the following members.

Constructors
  NameDescription
Public methodTreeGridContainer
Top
Properties
  NameDescription
Public propertybgColor
The default cell bgcolor.
Public propertybgInvert
Enable background row color inverting when selected. Default is true.
Public propertyborderGColor
Cell border color.
Public propertydelimeter
The delimiter character.
Public propertyfont
The default text font.
Public propertyrowHeight
Specifies the default row height in pixels. Default is 26.
Top
Methods
  NameDescription
Public methodaddAllColumnsToDiffView
Public methodaddColumnToDiffView
Public methodaddRow
Public methodaddXMLRows
Adds new rows loading information from xml document.
Public methodcellIsCheckbox
Returns true if this cell contains a checkbox.
Public methodcells
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 methodcloseItem
Public methodcollapseAll
Collapses all the tree nodes.
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
Public methoddisableSortingByColumn
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: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 methodexpandAll
Expands all the tree nodes.
Public methodfindRowByLabel
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 methodgetCheckedItemIds
Public methodgetChildId
Public methodgetChildItemsCount
Public methodgetChildItemsId
Gets divided by separator string containing ID's of children rows for row with specified ID
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
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 methodgetOpenedItems
Returns the list of currently opened(expanded) items' IDs, delimited with this separator.
Public methodgetParentId
Get the ID of the parent row for this row; null if no parent.
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
Gets XML representation of the grid.
Public methodinitXML
Load this XML string/url into the grid.
Public methodinitXMLRows
Initialize rows from xml document.
Public methodinsertNewChild
Inserts a new row as a child row for the specified parent row (parentId).
Public methodinsertRoot
Inserts a new row at the root level.
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
Public methodisMultiselect
Returns true if multiselect is enabled.
Public methodloadBaselineXml
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
Public methodmoveRowUp
Public methodopenItem
Opens (expands) this item's children programmatically (same as if user double-clicks the item). If the item is already opened, nothing happens.
Public methodremoveAllColumnsFromDiffView
Public methodremoveAllRows
Remove all rows from grid.
Public methodremoveColumnFromDiffView
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
Enable/disable grid redrawing at runtime.
Public methodsetRowBgColor
Sets row background color.
Public methodsetRowIcons
Sets the icons for the specified row, for Collapsed and Expanded state respectively. If expandedIcon isn't specified collapsedIcon will be used as it.
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