GridColumn.Visible Property

Gets or sets whether the grid column is visible.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v24.1.dll

NuGet Packages: DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(false)]
[DXCategory("Appearance")]
[XtraSerializableProperty]
[XtraSerializablePropertyId(3)]
public virtual bool Visible { get; set; }

VB.NET

<DXCategory("Appearance")>
<DefaultValue(False)>
<XtraSerializableProperty>
<XtraSerializablePropertyId(3)>
Public Overridable Property Visible As Boolean

Property Value

Type	Default	Description
Boolean	false	true if the column is visible; otherwise, false.

Remarks

The Visible and GridColumn.VisibleIndex properties specify the column’s visible state and position. When you hide/show the column with the Visible property, the GridColumn.VisibleIndex property automatically reflects the changes. Similarly, if you toggle the column’s visibility with the GridColumn.VisibleIndex property, the Visible property changes automatically. See GridColumn.VisibleIndex to learn more.

The code sample below illustrates how to change grid column visibility based on the user’s permissions.

C#

public class UserPermissions
{
    public bool canSeeProductId;
    public bool canSeeProductActions;
}

UserPermissions permissions = new UserPermissions();
permissions.canSeeProductId = false;
permissions.canSeeProductActions = false;

gridView1.Columns["productId"].Visible = permissions.canSeeProductId;
gridView1.Columns["productActions"].Visible = permissions.canSeeProductActions;

VB.NET

Public Class UserPermissions
    Public canSeeProductId As Boolean
    Public canSeeProductActions As Boolean
End Class

Private permissions As New UserPermissions()
permissions.canSeeProductId = False
permissions.canSeeProductActions = False

gridView1.Columns("productId").Visible = permissions.canSeeProductId
gridView1.Columns("productActions").Visible = permissions.canSeeProductActions

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Visible 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#

winforms-grid-implement-serializable-column-property/CS/Q242361/Grid.cs#L79

public override bool Visible {
    get { return base.Visible; }
    set {

winforms-grid-bind-lookup-column-to-entity-framework/CS/EntitiesLookupWithEditing/Form1.cs#L21

private void Form1_Load(object sender, EventArgs e) {
    gridView1.Columns.AddField("ProductName").Visible = true;
    GridColumn column = gridView1.Columns.AddField("Categories");

winforms-grid-copy-cells-in-biff8-format-using-excel-export-api/CS/gridCopyToClipboardExample/CopyToClipboardHelper.cs#L27

// Skip hidden column
if (!gridColumn.Visible)
    return;

winforms-mvvm-expenses-app/CS/MVVMExpenses/Views/Account/AccountsEditFormView.cs#L32

    ((GridView)gridControl1.MainView).OptionsBehavior.Editable = false;
    ((GridView)gridControl1.MainView).Columns["Account"].Visible = false;
}

winforms-grid-use-coloredit-to-edit-unbound-column-string-values/CS/ColorEditExample/Form1.cs#L29

gridControl2.DataSource = dt;
gridView1.Columns["ColorString"].Visible = false;

VB.NET

winforms-grid-implement-serializable-column-property/VB/Q242361/Grid.vb#L119

Get
    Return MyBase.Visible
End Get

winforms-grid-bind-lookup-column-to-entity-framework/VB/EntitiesLookupWithEditing/Form1.vb#L20

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs)
    gridView1.Columns.AddField("ProductName").Visible = True
    Dim column As GridColumn = gridView1.Columns.AddField("Categories")

winforms-grid-copy-cells-in-biff8-format-using-excel-export-api/VB/gridCopyToClipboardExample/CopyToClipboardHelper.vb#L30

' Skip hidden column
If Not gridColumn.Visible Then Return
Using column As IXlColumn = sheet.CreateColumn()

winforms-mvvm-expenses-app/VB/MVVMExpenses/Views/Account/AccountsEditFormView.vb#L30

    fluent.SetBinding(GridControl1, Function(gc) gc.DataSource, Function(x) x.AccountTransactionDetails.Entities)
    CType(GridControl1.MainView, DevExpress.XtraGrid.Views.Grid.GridView).Columns("Account").Visible = False
End Sub

winforms-grid-use-coloredit-to-edit-unbound-column-string-values/VB/ColorEditExample/Form1.vb#L23

gridControl2.DataSource = dt
gridView1.Columns("ColorString").Visible = False
Dim unboundColumn As GridColumn = gridView1.Columns.AddField("Color")