Column Object

compareCells

Compares two cells values according to the column's data type.

Object. First cell to compare.

Object. Second cell to compare.

0 if the cell values are equal. Less than 0 if the first cell's value is less than the second cell's value. Greater than 0 if the first cell's value is greater than the second cell's value.

compareRows

Compares two group by rows values according to the column's band group by settings.

Object. First row to compare.

Object. Second row to compare.

Undefined if one or both passed in rows are not the group by rows. 0 if the row values are equal. Less than 0 if the first row's value is less than the second row's value. Greater than 0 if the first row's value is greater than the second row's value.

find

Looks for a matching value among all cells of the column. The method targets text of the cells rather than value, that makes a difference when numeric cells reflect a text of its column's value list or WebCombo. The search starts from the top of the column.

Regular expression. The expression is used to find a cell with matching value. See more info on using regular expressions here: Regular expression.

Boolean. Optional. If true indicates backward search.

Object. The cell object containg matching value. Null if no matching values found. See the findNext method for more info.

findNext

Looks for the next matching value among all cells of the column. This method starts searching from the point where the find method or previous call of the findNext method stopped as a value was found.

Regular expression. The expression is used to find a cell with matching value. See more info on using regular expressions here: Regular expression.

Boolean. Optional. If true indicates backward search.

Object. The cell object containing matching value. Null if no matching values found.

The method can be used to iterate through all cell in the column that contain the pattern provided through a regular expression. Example:

var regExp=new RegExp("^a","i");
var cell=column.find(regExp);
while(cell!=null)
{
	alert(cell.getValue());
	cell=column.findNext(regExp);
}

getAllowUpdate

Gets the resolved AllowUpdate property of the column.

Number. Corresponds to the server side AllowUpdate enumeration: 0 - NotSet, 1 - Yes, 2 - No, 3 - RowTemplateOnly. If no setting on the column the band one is returned.

getFilterIcon

Indicates whether the column's header has a filter icon.

Boolean. Returns true if the column is currently displaying a FilterIcon and false if it isn't. Will always return false if HeaderIcon filtering is not enabled.

getFixed

Indicates if the column is fixed. If called when not in the fixed columns mode false is always returned.

Boolean. True if the column is fixed.

getFixedHeaderIndicator

Gets the resolved FixedHeaderIndicator property for the column.

Number. Resolved FixedHeaderIndicator for the column. If there is no setting on the column, the band's one is returned; if there is no setting on the band, the grid's one is returned. The value returned corresponds to the server side FixedHeaderIndicator enumeration: 0 - NotSet, 1 - None, 2 - Button.

getFooterClass

Gets the resolved CSS class name for the column's footer.

String. Resolved CSS class name for the column's footer. If there is no setting on the column the band's one is returned.

getFooterText

Gets the footer text of the column.

String. Returns the footer text of the column.

getHeadClass

Gets the resolved CSS class name for the column's header.

String. Resolved CSS class name for the column's header. If there is no setting on the column the band's one is returned.

getHidden

Indicates if the column is hidden.

Boolean. True if the column is hidden.

getLevel

Gets the level of the column. The column's level consists of the band's index and the column's index.

Boolean. True indicates that the level needs to be returned as a string where the band's and the column's indexes are separated by the underscore sign '_'. No value or false makes the method to return a two elements array of the indexes.

Object. Two elements array if no parameter or false is passed in. First element is the column's band index, second one is the columns index. String. Underscore sign separated string of the band's and column's indexes if the parameter passed into the method is true.

getNullText

Gets the resolved NullText property of the column.

String. Resolved NullText property of the column. If there is no setting on the column the band's one is returned.

getRealIndex

Not for public use. Returns HTML index of the column's cell within a specified row. The value can be different depending on merged cells in surrounding columns/rows.

Object. The row to get the cell's index from.

Number. The HTML index of the column's cell.

getSelClass

Gets the resolved CSS class name for the column's selected cells.

String. Resolved CSS class name for the column's selected cells. If there is no setting on the column the band's one is returned.

getSortImplementation

Resolves and returns actual SortingImplementation value for the column.

Function. Value of resolved SortImplementation property. If the column's value is null the band's value is returned.

getSortingAlgorithm

Resolves and returns actual SortingAlgorithm value for the column.

Number. Value of resolved SortingAlgorithm property. If the column's value is NotSet the band's value is returned.

getTitleModeResolved

Gets the resolved TitleMode for this column, based on the TitleMode and HeaderTitleMode settings from the Column, Band and the Grid.

The resolved TitleMode for this column. 0 - NotSet, 1 - Always, 2 - OnOverflow, 3 - Never.

getValueFromString

Gets converted value from passed string according to the column's type.

String. The string value to convert to the column's data type.

The column's data type. The value converted to the column's data type..

getVisible

Indicates if the column is visible and it has cells.

Boolean. True if the column is visible and it has cells.

getWidth

Gets the column's width in pixels.

Number. The column's width in pixels.

hasCells

Indicates if the column has any cells.

Boolean. True if the column is rendered down to the client and its cells are accessible.

move

Moves the column within its columns collection.

Number. The index within the columns collection to move the column to.

setAllowUpdate

Sets the AllowUpdate property of the column.

Number. Corresponds to the server side AllowUpdate enumeration: 0 - NotSet, 1 - Yes, 2 - No, 3 - RowTemplateOnly.

setFilterIcon

Changes the visibility of the FilterIcons in the column headers. Calling this method will have no affect if row filtering using the HeaderIcon is not turned on.

Boolean. Passing true will make a filter icon in a column header visible and passing false will hide the icon. Changes in filter icon visibility will be automatically persisted to the server. It will change the visibility of all of the filter icons associated with the column if there are repeated column headers (child rows, group by rows).

setFixed

Sets the column's Fixed property. No action of actual fixing the column is performed by the method.

Boolean. New value of the Fixed property.

setFooterText

Sets the footer text for the column. If the column is on a band greater than 0, that is there are more than one footer belonging to the column, all footers are changed. To set a specific rows collection footer text use the Rows.setFooterText method.

String. The text to set on the column's footer.

Boolean. Optional. If true the value is converted to the column's data type and the column's mask is applied to it.

setHeaderText

Set the caption for this column header.

String. The new caption to set for this column header.

setHidden

Hides or shows the column from view.

Boolean. True to hide the column. False to show the column.

setWidth

Sets the column's width.

Number. A number value is interpreted as the number of pixels to set the column's width to.

Boolean. Indicates whether the width was set successfully. False is returned if the column's size change was canceled from within the BeforeColumnSizeChange event.

AllowColResizing

Number. Indicates whether the column can be resized. Corresponds to the server side AllowSizing enumeration: 0 - NotSet, 1 - Fixed, 2 - Free.

AllowGroupBy

Number. Indicates whether the column can be grouped by. Corresponds to the server side AllowGroupBy enumeration: 0 - NotSet, 1 - Yes, 2 - No.

AllowNull

Boolean. Indicates whether the column can contain null values.

AllowRowFiltering

Number. Indicates whether RowFiltering should be allowed on the column.

AllowUpdate

Number. Indicates whether the column can be edited. Corresponds to the server side AllowUpdate enumeration: 0 - NotSet, 1 - Yes, 2 - No, 3 - RowTemplateOnly.

Band

Object. The band reference.

ButtonClass

String. The CSS class name for the column's buttons.

ButtonStyle

String. Any additional style settings applied to the column's buttons. Changing the property on the client does not change the column's behavior and/or appearance, it is for informational purpose only.

Case

Number. Indicates if the column's data is converted to a certain case. Corresponds to the server side Case enumeration: 0 - Unchanged, 1 - Lower, 2 - Upper.

CellButtonDisplay

Number. Indicates the column's button display. Corresponds to the server side CellButtonDisplay enumeration: 0 - OnMouseEnter, 1 - Always. Applicable only if the column's ColumnType property is set to 7 (Button). Changing the property on the client does not change the column's behavior and/or appearance, it is for informational purpose only.

CellMultiline

Boolean. Indicates whether the column's text editor allows multiline input.

ColumnType

Number. The column's type. Corresponds to the server side ColumnType enumeration: 0 - NotSet, 3 - CheckBox, 5 - DropDownList, 7 - Button, . Changing the property on the client does not change the column's behavior and/or appearance, it is for informational purpose only.

CssClass

String. The CSS class name for the column's cells.

DataType

Number. The column's data type. The data type is represented as a number. It corresponds to the server side type as following: System.SByte - 17; System.Int16 - 2; System.Int32 - 3; System.Int64 - 20; System.Byte - 16; System.UInt16 - 18; System.UInt32 - 19; System.UInt64 - 21; System.Single - 4; System.Double - 5; System.Decimal - 14; System.Boolean - 11; System.Char - 17; System.Object - 12; System.DateTime - 7; System.String and other unrecognizable types - 8.

DefaultFilterList

Object. A list of values that were passed down from the server to be used in the filter drop down.

DefaultValue

String. Default value of the column. Converted to the column's data type and set to newly added cells of the column.

EditorControlID

String. The ID of the control that is used to edit the column.

fId

String. The column footer's id.

FieldLength

Number. Indicates how many characters are allowed to be entered into the column.

FilterComparisonType

Number. Specifies whether the filtering is performed case-sensitive. Default is to perform filtering case-insensitive. Corresponds to the Infragistics.WebUI.UltraWebGrid.FilterComparisonType enumeration.

FilterOperatorDefaultValue

Number. Determines what type of filtering will be executed on a column by default.

Fixed

Boolean. Indicates if the column is fixed. Changing the property on the client does not change the column's behavior and/or appearance, it is for informational purpose only.

FixedHeaderIndicator

Number. Contains the FixedHeaderIndicator of the column. The value corresponds to the server side FixedHeaderIndicator enumeration: 0 - NotSet, 1 - None, 2 - Button. Changing the property on the client does not change the column's behavior and/or appearance, it is for informational purpose only.

FooterClass

String. The CSS class name of the column's footer.

FooterStyle

String. Any additional style settings applied to the column's footer. Changing the property on the client does not change the column's behavior and/or appearance, it is for informational purpose only.

FooterText

String. The text of the column's footer. Changing the property on the client does not change the column's behavior and/or appearance, it is for informational purpose only.

GatherFilterData

Number. Indicates if the Column should programmatically gather data when filter is dropped. 0 - NotSet, 1 - True, 2 - False. If the FitlerCollection is populated on the server, and the list is complete, then setting this to 2 (False) will prevent the control from gathering data for the filter. This can be used rather than canceling the BeforeFilterPopulated event.

HeaderClass

String. The CSS class name of the column's header.

HeaderClickAction

Number. Specifies what will happen when a user clicks on the column header. Corresponds to the server side HeaderClickAction enumeration: 0 - NotSet, 1 - Select, 2 - SortSingle, 3 - SortMulti. Changing the property on the client does not change the column's behavior and/or appearance, it is for informational purpose only.

HeaderImageAltText

String. The alternative text for the column's header image.

HeaderImageHeight

String. Height of the column's header image.

HeaderImageUrl

String. URL of the column's header image.

HeaderImageWidth

String. Width of the column's header image.

HeaderStyle

String. Any additional style settings applied to the column's header. Changing the property on the client does not change the column's behavior and/or appearance, it is for informational purpose only.

HeaderText

String. The column's header text.

HeaderTitleMode

Number. Behavior used for generating the HTML Title attribute of column headers. 0 - NotSet, 1 - Always, 2 - OnOverflow, 3 - Never.

HeaderWrap

Boolean. Indicates whether the header text of the column can be wrapped. Changing the property on the client does not change the column's behavior and/or appearance, it is for informational purpose only.

Hidden

Boolean. Indicates whether the column is hidden.

Id

String. The column's id.

Index

Number. The column's index within its columns collection.

IsGroupBy

Boolean. Indicates if the columns is grouped by. Changing the property on the client does not change the column's behavior and/or appearance, it is for informational purpose only.

Key

String. The column's key.

MaskDisplay

Boolean. Specifies the column's mask that is applied to newly added or updated cells. The recognizable symbols of the mask are limited. These are: '#' - optional number, '0' - mandatory number, '.' - local currency decimal separator, ',' - local currency group separator. All other characters are carried into the result as is. For more sophisticated mask input it is recommended to use the WebDataInput controls of the Infragistics NetAdvantage ASP.NET suite.

MergeCells

Boolean. Indicates if the column has automatic cell merging capability turned on on the server. Changing the property on the client does not change the column's behavior and/or appearance, it is for informational purpose only.

Node

Object. The XML node associated with the column if the XML rendering is enabled.

NullText

String. Text that replaces the null values in the column. It is also recognized when a new text value is set on a column's cell and replaced by null.

RowFilterMode

Number. The value that corresponds to the RowFilterMode on the server. 0 - NotSet, 1 - AllRowsInBand, 2 - SiblingRowsOnly

SelCellClass

String. The CSS class name for the column's selected cells.

Selected

Boolean. Indicates if the columns is selected. Changing the property on the client does not change the column's behavior and/or appearance, it is for informational purpose only.

SelHeadClass

String. The CSS class name for the column's selected header.

ServerOnly

Boolean. Indicates if the column is server only. Changing the property on the client does not change the column's behavior and/or appearance, it is for informational purpose only.

SortCaseSensitive

Boolean. Indicates whether to respect or ignore the capitalization of the values in the cells when sorting. Initially the property gets the same value as it's set on the server. Changing the value on the client will be respected within current client session. A post back will reset the property's value back to its server counterpart.

SortImplementation

Function. Reference to a function that implements custom sorting algorithm. Overrides band's setting. See detailed description on the same property off the grid object.

SortIndicator

Number. Indicates if the column is currently sorted. Corresponds to the server side SortIndicator enumeration: 0 - None, 1 - Ascending, 2 - Descending, 3 - Disabled. Changing the property on the client does not change the column's behavior and/or appearance, it is for informational purpose only.

SortingAlgorithm

Number. Defines sorting algorithm for the column. Overrides band's SortingAlgorithm. The value corresponds to the server side SortingAlgorithm enumeration.

Style

String. Any additional style settings applied to the column's cells. Changing the property on the client does not change the column's behavior and/or appearance, it is for informational purpose only.

TemplatedColumn

Number. Indicates if the column is templated. Its bits indicate which part of the column is templated. 0 - no templates used in the column, 1 - the column's header is templated, 2 - the column's cells are templated, 4 - the column's footer is templated. Any "or" combination of the bits can be present.

Type

String. Type of the client side object. That is "column" for the column object.

Validators

Object. An array of validators ids applied to the column.

ValueList

Object. A two dimensional array of the column's value list. The second dimension has two elements arrays containing: [DataValue, DisplayText].

ValueListClass

String. The CSS class name for the column's value list.

ValueListPrompt

String. The text that is considered to be the prompt of the column's value list. If that value is selected from the value list it is being ignored.

Width

Initially string, after first getWidth call - number. Contains the column's width. After it is accessed for the first time by the getWidth method gets converted to the pixel amount of the column's width.

Wrap

Boolean. Indicates whether the cell values of the column can be wrapped. Changing the property on the client does not change the column's behavior and/or appearance, it is for informational purpose only.