Class ColumnBuilder<T>
Inheritance
Inherited Members
Namespace: Syncfusion.JavaScript
Assembly: Syncfusion.EJ.dll
Syntax
public class ColumnBuilder<T>
where T : classType Parameters
| Name | Description |
|---|---|
| T |
Constructors
ColumnBuilder(Grid<T>)
Initializes a new instance of the ColumnBuilder<T> class.
Declaration
public ColumnBuilder(Grid<T> grid)Parameters
| Type | Name | Description |
|---|---|---|
| Grid<T> | grid | The grid. |
Methods
Add()
It adds the current column value.
Declaration
public void Add()AllowEditing()
It sets the value that indicates whether to enable editing behavior for particular column.Gets or sets a value that indicates whether to enable editing behavior for particular column.
Declaration
public ColumnBuilder<T> AllowEditing()Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
AllowEditing(Boolean)
It sets the value that indicates whether to enable editing behavior for particular column.
Declaration
public ColumnBuilder<T> AllowEditing(bool allowEditing)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | allowEditing | It accepts the boolean value and enables or diables Editing |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
AllowFiltering()
It sets the value that indicates whether to enable dynamic filtering behavior for particular column.
Declaration
public ColumnBuilder<T> AllowFiltering()Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
AllowFiltering(Boolean)
It sets the value that indicates whether to enable dynamic filtering behavior for particular column.
Declaration
public ColumnBuilder<T> AllowFiltering(bool allowFiltering)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | allowFiltering | It accepts the boolean value and enables or disables grouping |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
AllowGrouping()
It sets the value that indicates whether to enable dynamic grouping behavior for particular column.
Declaration
public ColumnBuilder<T> AllowGrouping()Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
AllowGrouping(Boolean)
It sets the value that indicates whether to enable dynamic grouping behavior for particular column.
Declaration
public ColumnBuilder<T> AllowGrouping(bool allowGrouping)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | allowGrouping | It accepts the boolean value and enables or disables grouping |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
AllowResizing()
It sets the value that indicates whether to enable dynamic resizable for particular column.
Declaration
public ColumnBuilder<T> AllowResizing()Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
AllowResizing(Boolean)
It sets the value that indicates whether to enable dynamic resizable for particular column.
Declaration
public ColumnBuilder<T> AllowResizing(bool allowResizing)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | allowResizing |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
AllowSorting()
Gets or sets a value that indicates whether to enable dynamic sorting behavior for particular column.
Declaration
public ColumnBuilder<T> AllowSorting()Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
AllowSorting(Boolean)
It sets the value that indicates whether to enable dynamic sorting behavior for particular column.
Declaration
public ColumnBuilder<T> AllowSorting(bool allowSorting)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | allowSorting | It accepts the boolean value and enables or disables sorting |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
AllowTextWrap()
It sets the value that indicates whether to enable textwrap behavior for particular column.Gets or sets a value that indicates whether to enable textwrap behavior for particular column.
Declaration
public ColumnBuilder<T> AllowTextWrap()Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
AllowTextWrap(Boolean)
It sets the value that indicates whether to enable editing behavior for particular column.
Declaration
public ColumnBuilder<T> AllowTextWrap(bool allowTextWrap)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | allowTextWrap |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
ClipMode(ClipMode)
Sets the clip mode for Grid cell as ellipsis or clipped content(both header and content)
Declaration
public ColumnBuilder<T> ClipMode(ClipMode mode)Parameters
| Type | Name | Description |
|---|---|---|
| ClipMode | mode | It sets the clipmode |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
Commands(Action<CommandsBuilder<T>>)
It sets an object that indicates to define a command column in the grid.
Declaration
public ColumnBuilder<T> Commands(Action<CommandsBuilder<T>> commands)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<CommandsBuilder<T>> | commands | It displays the command column through lambda expression |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
Commands(List<Commands>)
It sets an object that indicates to define a command column in the grid.
Declaration
public ColumnBuilder<T> Commands(List<Commands> commands)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<Commands> | commands | It displays the list of command columns |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
CssClass(String)
It sets a value that indicates to provide custom CSS for an individual column.
Declaration
public ColumnBuilder<T> CssClass(string cssclass)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | cssclass | It accepts the string value and provide custom CSS for that column |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
CustomAttributes(Action<CustomAttributeBuilder<T>>)
It sets a value that indicates the attribute values to the td element of a particular column
Declaration
public ColumnBuilder<T> CustomAttributes(Action<CustomAttributeBuilder<T>> customAttributes)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<CustomAttributeBuilder<T>> | customAttributes | It displays the customized attributes to the specific element for that column |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
CustomAttributes(Dictionary<String, Object>)
It sets a value that indicates the attribute values to the td element of a particular column
Declaration
public ColumnBuilder<T> CustomAttributes(Dictionary<string, object> customAttributes)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.Dictionary<System.String, System.Object> | customAttributes | It accepts the string as key and object value passed to display the attribute value |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
DataSource(DataSource)
It sets a value that indicates to bind the external datasource to the particular column when column editType as dropdownedit and also it is used to bind the datasource to the foreign key column while editing the grid. //Where data is array of JSON objects of text and value for the drop-down and array of JSON objects for foreign key column.
Declaration
public ColumnBuilder<T> DataSource(DataSource datasource)Parameters
| Type | Name | Description |
|---|---|---|
| DataSource | datasource | It displays the list or collection of datasource |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
DataSource(Action<DataSourceBuilder>)
It sets a value that indicates to bind the external datasource to the particular column when column editType as dropdownedit and also it is used to bind the datasource to the foreign key column while editing the grid. //Where data is array of JSON objects of text and value for the drop-down and array of JSON objects for foreign key column.
Declaration
public ColumnBuilder<T> DataSource(Action<DataSourceBuilder> dataSource)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<DataSourceBuilder> | dataSource | It displays the list or collection of datasource through lambda expression |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
DataSource(List<String>)
It sets a value that indicates to bind the external datasource to the particular column when column editType as dropdownedit and also it is used to bind the datasource to the foreign key column while editing the grid. //Where data is array of JSON objects of text and value for the drop-down and array of JSON objects for foreign key column.
Declaration
public ColumnBuilder<T> DataSource(List<string> dataSource)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<System.String> | dataSource | It displays the list of external datasource to the particular column |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> |
DataSource(IEnumerable)
It sets a value that indicates to bind the external datasource to the particular column when column editType as dropdownedit and also it is used to bind the datasource to the foreign key column while editing the grid. //Where data is array of JSON objects of text and value for the drop-down and array of JSON objects for foreign key column.
Declaration
public ColumnBuilder<T> DataSource(IEnumerable dataSource)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.IEnumerable | dataSource | It displays the datasource with list or collection of type IEnumerable |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
DateEditOptions(DatePickerProperties)
It sets a value that indicates to customize ejDatePicker of an editable column.
Declaration
public ColumnBuilder<T> DateEditOptions(DatePickerProperties dateeditparams)Parameters
| Type | Name | Description |
|---|---|---|
| DatePickerProperties | dateeditparams | It displays the customized datepicker |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
DateTimeEditOptions(DateTimePickerProperties)
It sets a value that indicates to customize ejDateTimePicker of an editable column.
Declaration
public ColumnBuilder<T> DateTimeEditOptions(DateTimePickerProperties datetimeeditparams)Parameters
| Type | Name | Description |
|---|---|---|
| DateTimePickerProperties | datetimeeditparams | It displays the customized dateTimepicker |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
DefaultValue(Object)
It sets a value that indicates to display the specified default value while adding a new record to the grid
Declaration
public ColumnBuilder<T> DefaultValue(object defaultvalue)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | defaultvalue | It displays the default value based on the object value. |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
DisableHtmlEncode()
It sets the value that indicates to render the grid content and header with an HTML elements
Declaration
public ColumnBuilder<T> DisableHtmlEncode()Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> |
DisableHtmlEncode(Boolean)
It sets the value that indicates to render the grid content and header with an HTML elements
Declaration
public ColumnBuilder<T> DisableHtmlEncode(bool disableHtmlEncode)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | disableHtmlEncode | It accepts the boolean value and enables or disables the HTML elements |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
DisplayAsCheckbox()
It sets a value that indicates to display a column value as checkbox or string.
Declaration
public ColumnBuilder<T> DisplayAsCheckbox()Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
DisplayAsCheckbox(Boolean)
Gets or sets a value that indicates to display a column value as checkbox or string.
Declaration
public ColumnBuilder<T> DisplayAsCheckbox(bool displayAsCheckbox)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | displayAsCheckbox | It accepts the boolean value and displays the checkbox based on the value |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
DropDownEditOptions(DropDownListProperties)
Declaration
public ColumnBuilder<T> DropDownEditOptions(DropDownListProperties dropdowneditparams)Parameters
| Type | Name | Description |
|---|---|---|
| DropDownListProperties | dropdowneditparams |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> |
EditTemplate(EditTemplate)
It sets a template that displays a custom editor used to edit column values.
Declaration
public ColumnBuilder<T> EditTemplate(EditTemplate editTemplate)Parameters
| Type | Name | Description |
|---|---|---|
| EditTemplate | editTemplate | It displays the edit template column |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
EditTemplate(Action<EditTemplateOptionsBuilder<T>>)
It sets the template that displays a custom editor used to edit column values.
Declaration
public ColumnBuilder<T> EditTemplate(Action<EditTemplateOptionsBuilder<T>> editOption)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<EditTemplateOptionsBuilder<T>> | editOption | It displays the Edittemplate column through lambda expression |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
EditType(EditingType)
It sets the value that indicates to render the element(based on edit type) for editing the grid record.
Declaration
public ColumnBuilder<T> EditType(EditingType editingType)Parameters
| Type | Name | Description |
|---|---|---|
| EditingType | editingType | It displays the element based on the edit type. |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
EnableGroupByFormat()
It sets a value that indicates whether to group the column based on given format for particular column.
Declaration
public ColumnBuilder<T> EnableGroupByFormat()Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
EnableGroupByFormat(Boolean)
It sets a value that indicates whether to group the column based on given format for particular column.
Declaration
public ColumnBuilder<T> EnableGroupByFormat(bool enableGroupByFormat)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | enableGroupByFormat |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
Field(String)
It sets the value that indicates to display the columns in the grid mapping with column name of the dataSource.
Declaration
public ColumnBuilder<T> Field(string field)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | field | It accepts the string value and display the field for that columns |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
Field<TProperty>(Expression<Func<T, TProperty>>)
It sets the value that indicates to display the columns in the grid mapping with column name of the dataSource.
Declaration
public ColumnBuilder<T> Field<TProperty>(Expression<Func<T, TProperty>> field)Parameters
| Type | Name | Description |
|---|---|---|
| System.Linq.Expressions.Expression<System.Func<T, TProperty>> | field | It displays the field value through lambda expression |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
Type Parameters
| Name | Description |
|---|---|
| TProperty | It displays the property value through expression |
FilterBarTemplate(FilterBarTemplate)
It sets a template that displays a custom filter used to filter the column values.
Declaration
public ColumnBuilder<T> FilterBarTemplate(FilterBarTemplate filterBarTemplate)Parameters
| Type | Name | Description |
|---|---|---|
| FilterBarTemplate | filterBarTemplate | It displays the filterTemplate column |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
FilterBarTemplate(Action<FilterBarTemplateOPtionsBuilder<T>>)
It sets a template that displays a custom filter used to filter the column values.
Declaration
public ColumnBuilder<T> FilterBarTemplate(Action<FilterBarTemplateOPtionsBuilder<T>> filterBarOption)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<FilterBarTemplateOPtionsBuilder<T>> | filterBarOption | It displays the filterTemplate column through lambda expression |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
FilterOperator(FilterOperatorType)
It sets the value that specifies the grid to show the filterBar or filterMenu to the grid records.
Declaration
public ColumnBuilder<T> FilterOperator(FilterOperatorType filterOperator)Parameters
| Type | Name | Description |
|---|---|---|
| FilterOperatorType | filterOperator |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
FilterType(FilterOption)
It sets the value that specifies the grid to show the filterBar or filterMenu to the grid records.
Declaration
public ColumnBuilder<T> FilterType(FilterOption filterType)Parameters
| Type | Name | Description |
|---|---|---|
| FilterOption | filterType | It displays the type of filter used for filtering |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
ForeignKeyField(String)
It sets a value that indicates to define foreign key field name of the grid datasource.
Declaration
public ColumnBuilder<T> ForeignKeyField(string foreignKeyField)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | foreignKeyField | It accepts the string value and displays foreignkey field name of the datasource |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
ForeignKeyValue(String)
Gets or sets a value that indicates to bind the field which is in foreign column datasource based on the foreignKeyField
Declaration
public ColumnBuilder<T> ForeignKeyValue(string foreignKeyValue)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | foreignKeyValue | It accepts the string value and displays the foreign column datasource based on the value |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
Format(String)
It sets a value that indicates the format for the text applied on the column
Declaration
public ColumnBuilder<T> Format(string format)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | format | It accepts the string value and applies the format for that column |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
HeaderTemplateID(String)
It sets a value that indicates to add the template within the header element of the particular column.
Declaration
public ColumnBuilder<T> HeaderTemplateID(string headerTemplateId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | headerTemplateId | It accepts the string value and displays the headerTemplate for that column |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
HeaderText()
It sets the value that indicates to display the title of that particular column.
Declaration
public ColumnBuilder<T> HeaderText()Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
HeaderText(String)
It sets the value that indicates to display the title of that particular column.
Declaration
public ColumnBuilder<T> HeaderText(string headerText)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | headerText | It accepts the string value and displays the title for that column |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
HeaderTextAlign(TextAlign)
This defines the text alignment of a particular column header cell value.
Declaration
public ColumnBuilder<T> HeaderTextAlign(TextAlign textAlign)Parameters
| Type | Name | Description |
|---|---|---|
| TextAlign | textAlign | It displays the list of TextAlign values for header |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
HeaderTextAlign(TextAlign)
This defines the text alignment of a particular column header cell value.
Declaration
public ColumnBuilder<T> HeaderTextAlign(TextAlign textAlign)Parameters
| Type | Name | Description |
|---|---|---|
| System.Web.UI.WebControls.TextAlign | textAlign | It displays the list of TextAlign values for header in WebControls |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
HeaderTooltip(String)
Sets the template for Tooltip in Grid Columns(only for header)
Declaration
public ColumnBuilder<T> HeaderTooltip(string headerTooltip)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | headerTooltip | It accepts the string value and set the tooltip only for header |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
IsFrozen(Boolean)
You can use this property to freeze selected columns in grid at the time of scrolling
Declaration
public ColumnBuilder<T> IsFrozen(bool isFrozen)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | isFrozen | It accepts the booelan value and to freeze the column |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
IsIdentity(Boolean)
It sets a value that indicates the column has an identity in the database.
Declaration
public ColumnBuilder<T> IsIdentity(bool isIdentity)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | isIdentity | It accepts the boolean value and indicates the identity |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
IsPrimaryKey(Boolean)
It sets a value that indicates the column is act as a primary key(read-only) of the grid. The editing is performed based on the primary key column
Declaration
public ColumnBuilder<T> IsPrimaryKey(bool isPrimarykey)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | isPrimarykey | It accepts the boolean value and perform editing based on primary key |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
IsUnbound(Boolean)
Declaration
[Obsolete("IsUnbound property has been deprecated.")]
public ColumnBuilder<T> IsUnbound(bool isUnbound)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | isUnbound |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> |
NumericEditOptions(EditorProperties)
It sets a value that indicates to customize ejNumericTextbox of an editable column.
Declaration
public ColumnBuilder<T> NumericEditOptions(EditorProperties numericeditparams)Parameters
| Type | Name | Description |
|---|---|---|
| EditorProperties | numericeditparams | It displays the customized NumericTextbox |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
Priority(Int32)
Priority makes column to be visible or hidden based on the priority value and browser’s width to best accommodate the possible columns.These Priority values are from one to six.
Declaration
public ColumnBuilder<T> Priority(int priority)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | priority | It accepts the integer value and display or hide the columns based on priority |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
ShowInColumnChooser()
Used to hide the particular column in column chooser by giving value as false.
Declaration
public ColumnBuilder<T> ShowInColumnChooser()Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
ShowInColumnChooser(Boolean)
Used to hide the particular column in column chooser by giving value as false.
Declaration
public ColumnBuilder<T> ShowInColumnChooser(bool showInColumnChooser)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showInColumnChooser |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
Template(Boolean)
It sets the value that indicates whether to enables column template for a particular column.
Declaration
public ColumnBuilder<T> Template(bool template)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | template | It accepts the boolean value and enables or disables the template column |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
Template(String)
Gets or sets a value that indicates whether to enables column template for a particular column.
Declaration
public ColumnBuilder<T> Template(string template)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | template | It accepts the string value and enables or disables the template column |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
TemplateID(String)
Declaration
[Obsolete("TemplateID property is deprecated. Use Template property instead")]
public ColumnBuilder<T> TemplateID(string templateId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | templateId |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> |
TextAlign(TextAlign)
It sets a value that indicates to align the text within the column.
Declaration
public ColumnBuilder<T> TextAlign(TextAlign textAlign)Parameters
| Type | Name | Description |
|---|---|---|
| TextAlign | textAlign | It displays the list of TextAlign values |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
TextAlign(TextAlign)
It sets a value that indicates to align the text within the column.
Declaration
public ColumnBuilder<T> TextAlign(TextAlign textAlign)Parameters
| Type | Name | Description |
|---|---|---|
| System.Web.UI.WebControls.TextAlign | textAlign | It displays the list of TextAlign values in Webcontrols |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
Tooltip(String)
Sets the template for Tooltip in Grid Columns(both header and content)
Declaration
public ColumnBuilder<T> Tooltip(string tooltip)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | tooltip | It accepts the string and displays the tooltip |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
Type(ColumnType)
It sets the value that indicates to specify the data type of the specified columns.
Declaration
public ColumnBuilder<T> Type(ColumnType type)Parameters
| Type | Name | Description |
|---|---|---|
| ColumnType | type | It specifies the datatype for that column |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
Type(String)
It sets the value that indicates to specify the data type of the specified columns.
Declaration
public ColumnBuilder<T> Type(string type)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | type | It accepts the string value and specifies the datatype for that column |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
ValidationRules(Action<ValidationRuleBuilder<T>>)
It sets a value that indicates to define constraints for saving data to the database.
Declaration
public ColumnBuilder<T> ValidationRules(Action<ValidationRuleBuilder<T>> validationRule)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<ValidationRuleBuilder<T>> | validationRule | It define the constraints for saving data through lambda expression |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
ValidationRules(Dictionary<String, Object>)
It sets a value that indicates to define constraints for saving data to the database.
Declaration
public ColumnBuilder<T> ValidationRules(Dictionary<string, object> validationRule)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.Dictionary<System.String, System.Object> | validationRule | It accepts the string as key and object value passed to define the constraints for saving the data |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
Visible()
It sets a value that indicates whether this column is visible in the grid.
Declaration
public ColumnBuilder<T> Visible()Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
Visible(Boolean)
It sets a value that indicates whether this column is visible in the grid.
Declaration
public ColumnBuilder<T> Visible(bool visible)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | visible | It accepts the boolean value and displays the column based on the value |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |
Width(Object)
It sets a value that indicates to define the width for a particular column in the grid.
Declaration
public ColumnBuilder<T> Width(object width)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | width | It displays the column based on the object value passed. |
Returns
| Type | Description |
|---|---|
| ColumnBuilder<T> | ColumnBuilder |