Version

GridModel Class Members

The following tables list the members exposed by GridModel.

Public Constructors
 NameDescription
Public ConstructorGridModel Constructorconstructor - initializes all values to their defaults, if the default value differs from the default for the type  
Public Fields
 NameDescription
Public FieldAVG_ROW_HEIGHTaverage row height in pixels (default), used primarily when virtualization is enabled  
Public FieldDEFAULT_RESPONSE_KEYdefault property name holding the data records in the response JSON  
Public FieldVIRTUALIZATION_THRESHOLDafter this value is exceeded, that is, after this number of rows have to be loaded at the same time, virtualization is automatically enabled  
Public Properties
 NameDescription
Public PropertyAccessibilityRenderingrenders ARIA attributes and other accessibility attributes IGridModel.AccessibilityRendering  
Public PropertyAdjustVirtualHeightsIGridModel.AdjustVirtualHeights  
Public PropertyAggregateTransactionsIGridModel.AggregateTransactions  
Public PropertyAlternateRowStylesIGridModel.AlternateRowStyles  
Public PropertyAnimationDurationexpand / collapse animation duration  
Public PropertyAutoAdjustHeightif false, Height will be directly set on the grid scrolling container, instead of the topmost DIV container IGridModel.AvgRowHeight  
Public PropertyAutoCommitIGridModel.AutoCommit  
Public PropertyAutofitLastColumnIGridModel.AutofitLastColumn  
Public PropertyAutoFormatIGridModel.AutoFormat  
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  
Public PropertyAutoGenerateLayoutsauto generates layouts from the Model's dataSource that's passed  
Public PropertyAvgColumnWidthIGridModel.AvgColumnWidth  
Public PropertyAvgRowHeightSets the average row height for rows (through CSS) IGridModel.AvgRowHeight  
Public PropertyCaptiontext description above the grid header (spans all columns ) IGridModel.Caption  
Public PropertyClientDataSourceTypetype of the ClientDataSource. See the ClientDataSourceType enum IGridModel.ClientDataSourceType  
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  
Public PropertyColumnLayouts  
Public PropertyColumnsthe grid columns  
Public PropertyColumnVirtualizationhorizontal virtualization IGridModel.ColumnVirtualization  
Public PropertyDataMemberdefines the table name in the dataset that contains data for the current layout  
Public PropertyDataSourcedata source - actual data (should implement IQueryable) IGridModel.DataSource  
Public PropertyDataSourceTypeIGridModel.DataSourceType  
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  
Public PropertyDataViewthe DataView property contains the filtered and transformed data records after data binding and all feature transformations have been applied /// IGridModel.DataView  
Public PropertyDefaultColumnWidthSets the defaultColumnWidth of the grid columns - px or just a number IGridModel.DefaultColumnWidth  
Public PropertyEnableHoverStylesIGridModel.EnableHoverStyles  
Public PropertyEnableResizeContainerCheckenables/disables check for resizing grid container  
Public PropertyEnableUTCDatesIGridModel.EnableUTCDates  
Public PropertyExpandCollapseAnimationsexpand/collapse animations  
Public PropertyExpandColWidthexpand column width  
Public PropertyExpandTooltipexpand tooltip  
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  
Public PropertyFeaturesa list of grid features  
Public PropertyFixedFootersfixed footer support IGridModel.FixedFooters  
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  
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  
Public PropertyGenerateCompactJSONResponseIGridModel.GenerateCompactJSONResponse  
Public PropertyHeightGets/sets the Height of the grid IGridModel.Height  
Public PropertyHtmlAttributesSets custom attributes of the div on which the Grid widget will be created.  
Public PropertyHtmlHelper  
Public PropertyIDSets the ID of the grid element that will contain all data rows when rendered IGridModel.ID  
Public PropertyInitialExpandDepthinitial expansion of rows  
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  
Public PropertyJsonpRequestWhen dataSource is string defines whether to set data source of type JSONP  
Public PropertyLanguageGets/sets Language the control (Inherited from Infragistics.Web.Mvc.Framework.LocalizationBaseModel)
Public PropertyLoadOnDemandload on demand support  
Public PropertyLocalea list of configurable and localized labels.  
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  
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  
Public PropertyODataIGridModel.OData  
Public PropertyPrimaryKeyoptional primary key . Mandatory if Editing is enabled IGridModel.PrimaryKey  
Public PropertyRegionalGets/sets the Regional of the control (Inherited from Infragistics.Web.Mvc.Framework.LocalizationBaseModel)
Public PropertyRenderCheckboxesIGridModel.RenderCheckboxes  
Public PropertyRequestTypeSpecifies the HTTP verb to be used to issue the requests to a remote data source.  
Public PropertyResponseContentTypeContent type of the response. See http://api.jquery.com/jQuery.ajax/ => contentType  
Public PropertyResponseDataKeyproperty in the response which holds the records array IGridModel.ResponseDataKey  
Public PropertyRestIGridModel.Rest  
Public PropertyRestSettingsIGridModel.RestSettings  
Public PropertyRowVirtualizationvertical virtualization IGridModel.RowVirtualization  
Public PropertyScrollSettingsSettings related to content scrolling IGridModel.ScrollSettings  
Public PropertyShowHeadershow/hide grid header IGridModel.ShowHeader  
Public PropertyTabIndextab index of the grid main container element IGridModel.TabIndex  
Public PropertyTemplatingEnginethe templating engine that will be used to render the grid and some specific parts of its ui  
Public PropertyUpdateUrlIGridModel.UpdateUrl  
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  
Public PropertyVirtualizationModeVirtualizationMode can be set to 'fixed' or 'continuous' IGridModel.Virtualization  
Public PropertyWidthGets/sets the Width of the grid IGridModel.Width  
Protected Properties
 NameDescription
Protected PropertyStoreReturn the store with all of the options (Inherited from Infragistics.Web.Mvc.ModelBase)
Public Methods
 NameDescription
Public MethodAddClientEventAdds javascript function to process client event of widget. (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Public MethodDataBindOverloaded. performs data binding and calls TransformDataSource on all features after that, sets the resulting IQueryable to the DataView property  
Public MethodGetDataOverloaded. first performs data binding and generates the JsonResult object  
Public MethodGetDataColumnsGet grid data columns - it is useful when multicolumnheaders are enabled  
Public MethodGetUnboundColumnsGet list of unbound columns  
Public MethodHasUnboundColumnsReturns whether the grid has unbound columns  
Public Methodstatic (Shared in Visual Basic)JsonStringToDateTimeGets the JSON string and returns it as a valid System.DateTime.  
Public MethodLoadTransactions<T>loads a list of transactions from the POST data, in case saveChanges() is invoked in the client side and UpdateUrl is set to a valid controller action (GridUpdating)  
Public MethodSetUnboundValuesOverloaded. This method set unbound values for the specified column key. It should be called after unbound columns with the specified key is set. It should be set mapping between key of the dictionary and primary key  
Public MethodToJsonSerializes the object to JSON. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected Methods
 NameDescription
Protected MethodCamelizeConverts the provided string to camel case. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodEnsureClientEventsAdds client events to Serializes the internal model store into json. (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Protected MethodGetBoolGets the value of a bool property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetCharSets the value of a char property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetDateTimeGets the value of a DateTime property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetDoubleGets the value of a double property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetIEnumerable<T>Gets the value of an IEnumerable property of the model. If the value is null a new IEnumerable of type T will be created. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetIntGets the value of an int property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetJSLiteralSets the value of a literal property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetLongGets the value of a long property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetModel<T>Gets the value of an IModel property of the model. If the value is null a new model of type T will be created. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetStringGets the value of a string property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetStringEnum<T>Gets the value of a string property whose values are the lowercase values of an Enum. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetValue<T>Gets a property value of arbitrary type. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetValueFastget value using cached compiled linq expressions  
Protected MethodGetValueModel<T>Gets the value of an IModel property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromBoolSerializes a bool object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromDateTimeSerializes a DateTime object into json Date object. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromDoubleSerializes a double object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromFloatSerializes a float object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromIDictionarySerializes an IDictionary of objects into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromIEnumerableSerializes an IEnumerable object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromIntSerializes an int object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromModelStoreOverridden. ModelBase.JsonFromModelStore  
Protected MethodJsonFromObjectSerializes an arbitrary object in json using the typed serialization methods. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromStringSerializes a string object into json string, escaping all single quotes. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodProcessDataToJsonResultProcesses the data to JSON result.  
Protected MethodSetBoolSets a value to a bool property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetBrush (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetCamelizedStringEnum<T>Sets the value of a string property whose values are the lowercase values of an Enum. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetCharGets the value of a char property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetDateTimeSets a value to a DateTime property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetDoubleSets a value to a double property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetIEnumerable<T>Sets a value to an IEnumerable property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetIntSets a value to an int property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetJSLiteralGets the value of a literal property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetLongSets a value to a long property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetModel<T>Sets a value to an IModel property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetStringSets a value to a string property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetStringEnum<T>Sets the value of a string property whose values are the lowercase values of an Enum. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetValue<T>Sets a property value of arbitrary type. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodTransformDataTransforms the data. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodValidValueType<T>Checks type for value of existing property. Returns false as well if non existing property. (Inherited from Infragistics.Web.Mvc.ModelBase)
See Also

View on GitHub