Intersoft WebGrid Documentation
WebGridColumn
Send comments on this topic.
Intersoft WebGrid > Client-side References > WebGridColumn

Glossary Item Box

 WebGridColumn Properties

WebComboID Description
Gets the WebCombo.NET instance's ID associated with this column.

ValueType
string

Default Value
""
Name Description
Gets the name of the column.

ValueType
string

Default Value
-
Table Description
Gets the table object that owns this column.

ValueType
object (WebGridTable)

Default Value
-
AggregateFunction Description
Gets the aggregate function which result will be shown in total rows or group total rows for a column.

ValueType
string

Default Value
"None"
AllowGrouping Description
Gets or sets whether grouping this column is allowed.

ValueType
string

Default Value
"Default"
AllowSizing Description
Gets or sets whether resizing this column is allowed.

ValueType
string

Default Value
"Default"
AllowSorting Description
Gets or sets whether sorting this column is allowed.

ValueType
string

Default Value
"Default"
Bound Description
Gets a value that indicates whether the column is bound to data.

ValueType
boolean

Default Value
-
DataMember Description
Gets the DataMember name to which the column is bound.

ValueType
string

Default Value
-
DefaultValue Description
Gets the default value of the column when a new row is added.

ValueType
string

Default Value
-
Caption Description
Gets the caption of the column.

ValueType
string

Default Value
-
GroupEmptyString Description
Gets the text displayed in a group row when the grouped value is an empty string or null.

ValueType
string

Default Value
"(none)"
GroupRowValueFormatString Description
Gets the format string for the group row's value.

ValueType
string

Default Value
""
GroupRowInfoFormat Description
Gets the format string for the groupRow's info.

ValueType
string

Default Value
""
EditType Description
Gets the edit control type for the column.

ValueType
string

Default Value
"TextBox"
GroupInterval Description
Gets the value that determines how groups should be calculated.

ValueType
string

Default Value
"Value"
ColumnType Description
Gets the type of the column that control how the column content will be rendered.

ValueType
string

Default Value
"Text"
HeaderTooltip Description
Gets the tool tip text that will be displayed when the mouse is over column heading area.

ValueType
string

Default Value
""
NullText Description
Gets the text that will be displayed when a cell value is null or System.DBNull.

ValueType
string

Default Value
""
ShowInSelectColumns Description
Specifies whether the column will be shown in Select Columns menu.

ValueType
string

Default Value
"Yes"
IsGrouped Description
Indicates whether the column is grouped.

ValueType
boolean

Default Value
false
IsSorted Description
Indicates whether the column is sorted.

ValueType
boolean

Default Value
false
Position Description
Gets the position of the column.

ValueType
integer

Default Value
-
SortKeyField Description
Gets the sort key field for SortColumn.

ValueType
string

Default Value
""
FilterKeyField Description
Gets the filter key field for WebGridFilter object.

ValueType
string

Default Value
""
SortOrder Description
Gets the column's sort order if the column is sorted and exists in SortColumns collection.

ValueType
string

Default Value
"None"
Visible Description
Gets the value that indicates whether the column will be rendered.

ValueType
boolean

Default Value
true
DefaultVisible Description
Gets the value that indicates whether the grid is visible by default on the first load.

ValueType
boolean

Default Value
true
Width Description
Gets the width of the column in Unit.

ValueType
integer

Default Value
100
DataType Description
Gets the data type of the column.

ValueType
string

Default Value
-
TextboxMaxlength Description
Gets the maximum length of the TextBox Edit control.

ValueType
integer

Default Value
0
AllowMultiLine Description
Specifies whether the cells that belong to this column can display multiple lines of data.

ValueType
boolean

Default Value
false
DataFormatString Description
Gets the format string to use when rendering values.

ValueType
string

Default Value
""
DefaultText Description
Specifies the default text of this column when new row is added.

ValueType
string

Default Value
""
IsRowChecker Description
Gets whether this column should act as a row checker column.

ValueType
boolean

Default Value
false
IsAutoWidth Description
Gets whether this column is an auto width column.

ValueType
string

Default Value
false
FilterEditType Description
Gets the filter edit type for this column.

ValueType
string

Default Value
"SameAsEditType"
HyperlinkTarget Description
Gets the target of this hyperlink column.

ValueType
string

Default Value
"Blank"
ButtonAutoPostback Description
Gets whether postback should be automatically performed on button click.

ValueType
boolean

Default Value
false
ButtonPostbackMode Description
Gets whether the postback should be performed by using OnTheFly or FullPagePostback mode when a button is clicked.

ValueType
string

Default Value
"OnTheFly"
HyperlinkDisplayText Description
Gets the text used for the hyperlink's display.

ValueType
string

Default Value
""
HyperlinkFormatString Description
Gets the formatting string used to render the hyperlink's href.

ValueType
string

Default Value

CustomEditorName Description
Gets the name of the custom editor set for this column.

ValueType
string

Default Value
""
CustomEditorServerId Description
Gets the server ID of the custom editor set for this column.

ValueType
string

Default Value
""
CustomEditorProperties Description
Gets the properties of the custom editor set for this column.

ValueType
string

Default Value
""
ForceVisible Description
Gets the value that indicates whether the column is forced to visible.

ValueType
boolean

Default Value
false

 WebGridColumn Methods

GetGrid Description
Gets the WebGrid instance that owns this column.

Parameters
-

Remarks
-

Return Value

void

Samples
-
GetElement Description
Gets the html element that represents the column's header.

Parameters
-

Remarks
-

Return Value

void

Samples
-
Resize Description
Resize the column to the specified width in pixel.

Parameters
width
The width of the column in pixel.

Remarks
-

Return Value

int

Samples

ResizeBestFit Description
Resize the column to the best fit based on the longest text in the cell.

Parameters
-

Remarks
-

Return Value

void

Samples

GetFilterEditType Description
Gets the filter edit type of this column.

Parameters
-

Remarks
-

Return Value

void

Samples
-
GetWidth Description
Gets the width of this column in pixel.

Parameters
-

Remarks
-

Return Value

void

Samples
-
HideFromView Description
Hides the column from view. Both parameters are optional.

Parameters
mode

partOption

Remarks
-

Return Value

-

Samples

Show Description
Shows the column into view. PartOption parameter is optional.

Parameters
partOption

Remarks
-

Return Value
-

Samples
-

GetViewPosition Description
Gets the column position in the view.

Parameters
-

Remarks
-

Return Value

-

Samples

GetViewVisiblePosition Description
Gets the column position which takes account any hidden columns.

Parameters
-

Remarks
-

Return Value

-

Samples
-
GetScrollWidth Description
Gets the scroll width of this column.

Parameters
-

Remarks
-

Return Value

-

Samples
-
GetNewRowEditType Description
Gets the edit type for the new row of this column.

Parameters
-

Remarks
-

Return Value

-

Samples
-
IsPrimaryKey Description
Determines whether this column is primary key.

Parameters
-

Remarks
-

Return Value

-

Samples
-
ShowContextMenu Description
Shows the column's context menu. Provides the selected row to the parameter when this method is called in a child table.

Parameters
row
The row that shows the context menu.

Remarks
-

Return Value

-

Samples
-
©2012 Intersoft Solutions Corp. All Rights Reserved.