Version

GridColumn Class Members

The following tables list the members exposed by GridColumn.

Public Constructors
 NameDescription
Public ConstructorGridColumn ConstructorOverloaded.   
Public Properties
 NameDescription
Public PropertyColSpanSpecifies the colSpan of the cell in a multi-row-layout configuration. colSpan 0 is not supported and will be changed to 1 by the grid.  
Public PropertyColumnCssClassSets a space-separated list of CSS classes to be applied on the data cells of this column.  
Public PropertyColumnIndexSpecifies the column index of the cell in a multi-row-layout configuration. All columns must have this property set for the multi-row-layout mode to be enabled.  
Public PropertyDataTypedata type (number, string, date, bool)  
Public PropertyDateDisplayTypeDetermines the way in which Dates will be displayed in the Grid for this column.  
Public PropertyFormatformat for cells
  • If DataType is "date", then supported formats are following:

    "date", "dateLong", "dateTime", "time", "timeLong", "MM/dd/yyyy", "MMM-d, yy, h:mm:ss tt", "dddd d MMM", etc.
  • If DataType is "number" or not set, then supported numeric formats are following:

    "number", "currency", "percent", "int", "double", "0.00", "#.0####", "0", "#.#######", etc. The value of "double" will be similar to "number", but with unlimited maximum number of decimal places
  • If DataType is "string" or not set, then format is rendered as it is with replacement of possible "{0}" flag by value in cell

    Example, if format is set to "Name: {0}" and value in cell is "Bob", then value will appear as "Name: Bob"
  • If DataType is "bool", then supported format is "checkbox" which will override the RenderCheckboxes property of grid.
 
Public PropertyFormatterFunctionformatter function name to call on the client (JavaScript)  
Public PropertyGroupgroup of multicolumn headers  
Public PropertyGroupOptionsGroup options.  
Public PropertyHeaderCssClassSets a space-separated list of CSS classes to be applied on the header cell of this column  
Public PropertyHeaderTextheader text for the column  
Public PropertyHiddenInitial visibility of the column. A column can be hidden without the Hiding feature being enabled but there will be no UI for unhiding it. Columns can be defined as hidden in the options of the Hiding feature as well and those definitions take precedence.  
Public PropertyIsUnboundReturns whether column is unbound or not  
Public PropertyKeydata key for the column  
Public PropertyMapperReference to a client-side function (string) that can be used for complex data extraction from the data records, whose return value will be used for all data operations associated with this column.  
Public PropertyNavigationIndexSpecifies the navigation index of the cell for the TAB sequence in a MRL grid. Has no effect otherwise.  
Public PropertyRegionalregional setting of the column  
Public PropertyRowIndexSpecifies the row index of the cell in a multi-row-layout configuration. All columns must have this property set for the multi-row-layout mode to be enabled.  
Public PropertyRowSpanSpecifies the rowSpan of the cell in a multi-row-layout configuration. rowSpan 0 is not supported and will be changed to 1 by the grid.  
Public PropertyTemplateSets a template for an individual column. the contents of the template should be the HTML markup that goes inside the table cell, without any tags included in front and at the end. The syntax of the template, when referencing data keys and using conditional expressions is the same as the one for rowTemplate
and
 
Public PropertyWidthcolumn width in percentage, pixel or number  
Protected Properties
 NameDescription
Protected PropertyStoreReturn the store with all of the options (Inherited from Infragistics.Web.Mvc.ModelBase)
Public Methods
 NameDescription
Public MethodEquals  
Public MethodGetHashCode  
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 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 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 MethodJsonFromModelStoreSerializes the internal model store into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
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 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