Version 22.2

TreeGridModel Class Properties

For a list of all members of this type, see TreeGridModel members.

Public Properties
 NameDescription
Public PropertyAccessibilityRenderingrenders ARIA attributes and other accessibility attributes IGridModel.AccessibilityRendering (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyAdjustVirtualHeightsIGridModel.AdjustVirtualHeights (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyAggregateTransactionsIGridModel.AggregateTransactions (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyAlternateRowStylesIGridModel.AlternateRowStyles (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyAnimationDurationexpand / collapse animation duration (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyAutoAdjustHeightif false, Height will be directly set on the grid scrolling container, instead of the topmost DIV container IGridModel.AvgRowHeight (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyAutoCommitIGridModel.AutoCommit (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyAutofitLastColumnIGridModel.AutofitLastColumn (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyAutoFormatIGridModel.AutoFormat (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyAutoGenerateColumnsSets the value of autoGenerateColumns if false a columns collection should be specified if no columns collection is specified and the property is false, will try to auto-generate anyway IGridModel.AutoGenerateColumns (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyAutoGenerateLayoutsauto generates layouts from the Model's dataSource that's passed (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyAvgColumnWidthIGridModel.AvgColumnWidth (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyAvgRowHeightSets the average row height for rows (through CSS) IGridModel.AvgRowHeight (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyCaptiontext description above the grid header (spans all columns ) IGridModel.Caption (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyChildDataKeyProperty name of the array of child data in a hierarchical data source.  
Public PropertyClientDataSourceTypetype of the ClientDataSource. See the ClientDataSourceType enum IGridModel.ClientDataSourceType (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyClientEventsSet implementations of client events raised by a widget.

Event handler assumes 2 parameters: 1st parameter has name "evt" and 2nd parameter has name "ui". To get information about member variables available for "ui" parameter, please consult documentation of a widget and its events.

Examples:

1. Full implementation:

new Dictionary<string, string> { { "dropDownOpening", "function(evt,ui){alert('drop:'+ui.owner);}" } }

2. Content of inline function:

new Dictionary<string, string> { { "dropDownOpening", "alert('drop:'+ui.owner);" } }

3. Name of global function:

new Dictionary<string, string> { { "dropDownOpening", "nameOfGlobalFunction" } } Note:

Instead of explicit key-strings, which represent name of event exposed by a widget, the event-constants defined by a particular control can be used.

Example:

new Dictionary<string, string> { { ComboClientEvents.DropDownOpening, "nameOfGlobalFunction" } } (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Public PropertyCollapseTooltipcollapse tooltip (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyColumnLayouts (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyColumnsthe grid columns (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyColumnVirtualizationhorizontal virtualization IGridModel.ColumnVirtualization (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyDataMemberdefines the table name in the dataset that contains data for the current layout (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyDataSourcedata source - actual data (should implement IQueryable) IGridModel.DataSource (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyDataSourceSettingsGets or sets the data source settings.  
Public PropertyDataSourceTypeIGridModel.DataSourceType (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyDataSourceUrlURL that will be used to fetch data if DataSource is not defined, or for subsequent calls to paging, sorting, filtering, etc. IGridModel.DataSourceUrl (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyDataViewthe DataView property contains the filtered and transformed data records after data binding and all feature transformations have been applied /// IGridModel.DataView (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyDefaultColumnWidthSets the defaultColumnWidth of the grid columns - px or just a number IGridModel.DefaultColumnWidth (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyEnableHoverStylesIGridModel.EnableHoverStyles (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyEnableRemoteLoadOnDemandSpecifies to the tree grid if data is loaded on demand from a remote server. Default is false.  
Public PropertyEnableResizeContainerCheckenables/disables check for resizing grid container (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyEnableUTCDatesIGridModel.EnableUTCDates (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyExpandCollapseAnimationsexpand/collapse animations (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyExpandColWidthexpand column width (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyExpandTooltipexpand tooltip (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyFeatureChooserIconDisplayConfigures how the feature chooser icon should display on header cells - e.g. to display as gear icon or to not show gear icon but on click/tap the header cell to show the feature chooser (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyFeaturesa list of grid features (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyFixedFootersfixed footer support IGridModel.FixedFooters (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyFixedHeadersif fixed headers is enabled, all headers and features that have their logic rendered in the header, will be rendered in a separate table above the data records table IGridModel.FixedHeaders (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyFlatDataGetter for flat data(it is set after processing hierarchical data - e.g. ProcessHierarchicalData is called)  
Public PropertyFlatVisibleDataGetter for flat visible data - shows only (visible)expanded records (it is set after processing hierarchical data - e.g. ProcessHierarchicalData is called)  
Public PropertyForeignKeydefines the property in the child layout which holds the non-unique id that links the child layout to the parent. in cases of one to many relationships a foreign key will most probably *not* match the primary key of the child layout, so it will need to be defined. in one to one relationships the ForeignKey may be the same as the PrimaryKey. Note that when binding to flat data, the ChildDataKey option also needs to be set to an existing object that's of type ICollection (or a type that implements ICollection).  
Public PropertyForeignKeyRootValueSpecifies which item in the data source to treat as root row by its primaryKey value. Defaults to -1 (which includes the entire data source)  
Public PropertyGenerateCompactJSONResponseIGridModel.GenerateCompactJSONResponse (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyHeightGets/sets the Height of the grid IGridModel.Height (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyHtmlAttributesSets custom attributes of the div on which the Grid widget will be created. (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyHtmlHelper (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyIDSets the ID of the grid element that will contain all data rows when rendered IGridModel.ID (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyIndentationSpecifies the indentation (in pixels or percent) for a tree grid row. Nested indentation is achieved by calculating the level times the indentation value. Ex: '10px' or '5%'. Default is 30.  
Public PropertyInitialExpandDepthinitial expansion of rows (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyInitialIndentationLevelif initial indentation level is set then it is used to be calculated width of the data skip column(usually used when remote load on demand is enabled)  
Public PropertyIsDataSetTableSourceSets the original source type True, when the grid is bound to datatable/dataset False, when the grid is bound to any other source IGridModel.AutoGenerateColumns (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyJsonpRequestWhen dataSource is string defines whether to set data source of type JSONP (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyLanguageGets/sets Language the control (Inherited from Infragistics.Web.Mvc.Framework.LocalizationBaseModel)
Public PropertyListExpansionStatesGets or sets the list expansion states.  
Public PropertyListExpansionStatesKeyGets or sets key  
Public PropertyLoadOnDemandload on demand support (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyLocaleDefines locale specific options of igTreeGrid  
Public PropertyLocalSchemaTransformthis will be always seto to False in the MVC Wrapper. This means that the $.ig.DataSource Client control will not apply any schema locally ! IGridModel.LocalSchemaTransform (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyMergeUnboundColumnsIf true then the unbound columns are merged to the datasource at runtime - indeed DataSource is expanded with the new data and this could cause performance issues when dataSource is huge if false then the unbound data is sent to the client (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyODataIGridModel.OData (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyPrimaryKeyoptional primary key . Mandatory if Editing is enabled IGridModel.PrimaryKey (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyRecordsMetadataGets the records metadata.  
Public PropertyRegionalGets/sets the Regional of the control (Inherited from Infragistics.Web.Mvc.Framework.LocalizationBaseModel)
Public PropertyRenderCheckboxesIGridModel.RenderCheckboxes (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyRenderExpansionCellFunctionReference or name of a JavaScript function responsible for rendering the expansion indicator. This function is called ONLY if renderExpansionIndicatorColumn is set to true.  
Public PropertyRenderExpansionIndicatorColumnSpecifies whether or not to render the expansion indicated in its own column. Default is true.  
Public PropertyRenderFirstDataCellFunctiona reference or name of a javascript function which changes first data cell - renders indentation according to databound level  
Public PropertyRequestTypeSpecifies the HTTP verb to be used to issue the requests to a remote data source. (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyResponseContentTypeContent type of the response. See http://api.jquery.com/jQuery.ajax/ => contentType (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyResponseDataKeyproperty in the response which holds the records array IGridModel.ResponseDataKey (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyRestIGridModel.Rest (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyRestSettingsIGridModel.RestSettings (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyRowVirtualizationvertical virtualization IGridModel.RowVirtualization (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyScrollSettingsSettings related to content scrolling IGridModel.ScrollSettings (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyShowExpansionIndicatorSpecifies if rows(that have child rows) will have an expander image that will allow end users to expand and collapse them. This option can be set only at initialization.  
Public PropertyShowHeadershow/hide grid header IGridModel.ShowHeader (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyTabIndextab index of the grid main container element IGridModel.TabIndex (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyTemplatingEnginethe templating engine that will be used to render the grid and some specific parts of its ui (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyUpdateUrlIGridModel.UpdateUrl (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyVirtualizationEnables/disables virtualization. Virtualization can greatly enhance rendering performance. If enabled, the number of actual rendered rows (DOM elements) will be constant and related to the visible viewport of the grid. As the end user scrolls, those DOM elements will be dynamically reused to render the new data. IGridModel.Virtualization (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyVirtualizationModeVirtualizationMode can be set to 'fixed' or 'continuous' IGridModel.Virtualization (Inherited from Infragistics.Web.Mvc.GridModel)
Public PropertyWidthGets/sets the Width of the grid IGridModel.Width (Inherited from Infragistics.Web.Mvc.GridModel)
Protected Properties
 NameDescription
Protected PropertyStoreReturn the store with all of the options (Inherited from Infragistics.Web.Mvc.ModelBase)
See Also

View on GitHub