ASPxGridView.Columns Property

Provides access to a GridView’s column collection.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v19.1.dll

Declaration

C#

[DefaultValue(null)]
public GridViewColumnCollection Columns { get; }

VB.NET

<DefaultValue(Nothing)>
Public ReadOnly Property Columns As GridViewColumnCollection

Property Value

Type	Default	Description
GridViewColumnCollection	*null*	A GridViewColumnCollection object that represents a collection of columns within the ASPxGridView control.

Remarks

The Columns property stores a collection of GridViewColumn objects that represent columns. It provides methods that allow you to add new and remove existing columns. Individual columns can be accessed using indexed notation.

Concept

ASPxGridView Columns

Example

Declaratively:

ASPX

<dx:ASPxGridView ID="grid" ClientInstanceName="grid" runat="server" DataSourceID="SqlDataSource1" KeyFieldName="ProductID">
    <Columns>
        <dx:GridViewCommandColumn ShowSelectCheckbox="false" />
        <dx:GridViewDataColumn FieldName="ProductID" />
        <dx:GridViewDataColumn FieldName="ProductName" />
        <dx:GridViewDataColumn FieldName="UnitPrice" />
    </Columns>
</dx:ASPxGridView>

Programmatically:

C#

using DevExpress.Web;
...
protected void Page_Load(object sender, EventArgs e)  {
     ASPxGridView grid1 = new ASPxGridView();
     grid1.ID = "grid1";
     grid1.AutoGenerateColumns = false;
     grid1.DataSourceID = "SqlDataSource1";
     grid1.KeyFieldName = "ProductID";
     grid1.Columns.AddRange(new GridViewDataColumn[]{
          new GridViewDataColumn { FieldName="ProductID", ReadOnly = true, VisibleIndex = 0},
          new GridViewDataColumn() { FieldName = "ProductName", VisibleIndex = 1 },
          new GridViewDataColumn() { FieldName = "UnitPrice", VisibleIndex = 2 },
     });
     Page.Form.Controls.Add(grid1);
}

VB.NET

Imports DevExpress.Web
...
Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
    Dim grid1 As ASPxGridView = New ASPxGridView()
    grid1.ID = "grid1"
    grid1.AutoGenerateColumns = False
    grid1.DataSourceID = "SqlDataSource1"
    grid1.KeyFieldName = "ProductID"
    grid1.Columns.AddRange(New GridViewDataColumn() {
        New GridViewDataColumn With {
            .FieldName = "ProductID",
            .[ReadOnly] = True,
            .VisibleIndex = 0
        }, 
        New GridViewDataColumn() With {
            .FieldName = "ProductName",
            .VisibleIndex = 1
        }, 
        New GridViewDataColumn() With {
            .FieldName = "UnitPrice",
            .VisibleIndex = 2
        }
    })
    Page.Form.Controls.Add(grid1)
End Sub

Result:

Online Demos

ASPxGridView Demos

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Columns property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-use-cascading-comboboxes-in-an-inline-edit-mode-e1358/CS/MultiCombo/Default.aspx.cs#L31

ASPxComboBox combo2 = ((ASPxComboBox)grid.FindEditRowCellTemplateControl(
    grid.Columns["Category2ID"] as GridViewDataComboBoxColumn, "Cat2"));
combo2.Value = null;

instant-editing-of-boolean-field-value-using-two-columns-e1405/CS/BooleanRepresentation/Default.aspx.cs#L13

ASPxGridView grid = sender as ASPxGridView;
ASPxRadioButton discontinued = grid.FindRowCellTemplateControl(e.VisibleIndex, grid.Columns["Discontinued"] as GridViewDataColumn, "btnDiscontinued") as ASPxRadioButton;
ASPxRadioButton inproduction = grid.FindRowCellTemplateControl(e.VisibleIndex, grid.Columns["InProduction"] as GridViewDataColumn, "btnInProduction") as ASPxRadioButton;

aspxgridview-set-edit-form-values/CS/ASPxGridVIew/ServerSide.aspx.cs#L19

ASPxGridView grid = (ASPxGridView)sender;
ASPxSpinEdit unitPriceEditor = (ASPxSpinEdit)grid.FindEditRowCellTemplateControl(((GridViewDataColumn)grid.Columns["UnitPrice"]), "UnitPriceEditor");
ASPxSpinEdit unitsInStockEditor = (ASPxSpinEdit)grid.FindEditRowCellTemplateControl(((GridViewDataColumn)grid.Columns["UnitsInStock"]), "UnitsInStockEditor");

how-to-implement-custom-behavior-for-an-expand-button-of-group-rows-e398/CS/ExpandRecursiveProgrammatically/Default.aspx.cs#L20

if(!IsPostBack && !IsCallback) {
    ASPxGridView1.GroupBy(ASPxGridView1.Columns["Group"]);
    ASPxGridView1.GroupBy(ASPxGridView1.Columns["Subgroup"]);

how-to-show-an-error-text-for-editors-in-the-editformtemplatecontainer-e1264/CS/WebApplication12/Default.aspx.cs#L32

{
    GridViewDataColumn col = ((ASPxGridView)sender).Columns["CategoryName"] as GridViewDataColumn;
    e.Errors.Add(col, "The name is too long");

VB.NET

how-to-use-cascading-comboboxes-in-an-inline-edit-mode-e1358/VB/MultiCombo/Default.aspx.vb#L30

Session("Cat1ID") = combo1.Value
Dim combo2 As ASPxComboBox = (CType(grid.FindEditRowCellTemplateControl(TryCast(grid.Columns("Category2ID"), GridViewDataComboBoxColumn), "Cat2"), ASPxComboBox))
combo2.Value = Nothing

instant-editing-of-boolean-field-value-using-two-columns-e1405/VB/BooleanRepresentation/Default.aspx.vb#L15

Dim grid As ASPxGridView = TryCast(sender, ASPxGridView)
Dim discontinued As ASPxRadioButton = TryCast(grid.FindRowCellTemplateControl(e.VisibleIndex, TryCast(grid.Columns("Discontinued"), GridViewDataColumn), "btnDiscontinued"), ASPxRadioButton)
Dim inproduction As ASPxRadioButton = TryCast(grid.FindRowCellTemplateControl(e.VisibleIndex, TryCast(grid.Columns("InProduction"), GridViewDataColumn), "btnInProduction"), ASPxRadioButton)

aspxgridview-set-edit-form-values/VB/ASPxGridVIew/ServerSide.aspx.vb#L21

Dim grid As DevExpress.Web.ASPxGridView = CType(sender, DevExpress.Web.ASPxGridView)
Dim unitPriceEditor As ASPxSpinEdit = CType(grid.FindEditRowCellTemplateControl((CType(grid.Columns("UnitPrice"), GridViewDataColumn)), "UnitPriceEditor"), ASPxSpinEdit)
Dim unitsInStockEditor As ASPxSpinEdit = CType(grid.FindEditRowCellTemplateControl((CType(grid.Columns("UnitsInStock"), GridViewDataColumn)), "UnitsInStockEditor"), ASPxSpinEdit)

how-to-implement-custom-behavior-for-an-expand-button-of-group-rows-e398/VB/ExpandRecursiveProgrammatically/Default.aspx.vb#L22

If (Not IsPostBack) AndAlso (Not IsCallback) Then
    ASPxGridView1.GroupBy(ASPxGridView1.Columns("Group"))
    ASPxGridView1.GroupBy(ASPxGridView1.Columns("Subgroup"))

how-to-show-an-error-text-for-editors-in-the-editformtemplatecontainer-e1264/VB/WebApplication12/Default.aspx.vb#L29

If e.NewValues("CategoryName").ToString().Length > 16 Then
    Dim col As GridViewDataColumn = TryCast((CType(sender, ASPxGridView)).Columns("CategoryName"), GridViewDataColumn)
    e.Errors.Add(col, "The name is too long")