Back to Devexpress

GridColumn.Visible Property

windowsforms-devexpress-dot-xtragrid-dot-columns-dot-gridcolumn-9a579253.md

latest7.7 KB
Original Source

GridColumn.Visible Property

Gets or sets whether the grid column is visible.

Namespace : DevExpress.XtraGrid.Columns

Assembly : DevExpress.XtraGrid.v25.2.dll

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

Declaration

csharp
[DefaultValue(false)]
[DXCategory("Appearance")]
[XtraSerializableProperty]
[XtraSerializablePropertyId(3)]
public virtual bool Visible { get; set; }
vb
<DXCategory("Appearance")>
<DefaultValue(False)>
<XtraSerializableProperty>
<XtraSerializablePropertyId(3)>
Public Overridable Property Visible As Boolean

Property Value

TypeDefaultDescription
Booleanfalse

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.

csharp
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
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

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.

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

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

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

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

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

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

winforms-grid-use-layoutview-as-master-view/CS/WindowsApplication3/MasterDetailHelper.cs#L86

csharp
GridColumn column = view.Columns.AddField("Detail");
column.Visible = true;
column.VisibleIndex = view.Columns.Count;

winforms-grid-multiple-row-selection-web-style-checkboxes/CS/E1271/CheckMarkSelection.cs#L118

csharp
column.OptionsColumn.AllowSort = DevExpress.Utils.DefaultBoolean.False;
column.Visible = true;
column.VisibleIndex = 0;

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

vb
Get
    Return MyBase.Visible
End Get

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

vb
' 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

vb
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-layoutview-as-master-view/VB/WindowsApplication3/MasterDetailHelper.vb#L96

vb
Dim column As GridColumn = view.Columns.AddField("Detail")
column.Visible = True
column.VisibleIndex = view.Columns.Count

winforms-grid-multiple-row-selection-web-style-checkboxes/VB/E1271/CheckMarkSelection.vb#L147

vb
column.OptionsColumn.AllowSort = Utils.DefaultBoolean.False
column.Visible = True
column.VisibleIndex = 0

See Also

VisibleIndex

AddVisible

GridColumn Class

GridColumn Members

DevExpress.XtraGrid.Columns Namespace