DataSourceOptionsBase.SkipHiddenColumns Property

Gets or sets whether to include hidden columns into the binding range.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v19.1.Core.dll

Declaration

C#

public bool SkipHiddenColumns { get; set; }

VB.NET

Public Property SkipHiddenColumns As Boolean

Property Value

Type	Description
Boolean	true, to skip hidden columns; otherwise, false. Default is false.

Remarks

The SkipHiddenColumns and DataSourceOptionsBase.SkipHiddenRows properties operate differently depending on the data source type you use:

• External Data Source

  These properties specify whether data should be inserted into hidden rows and columns. Set these properties to true to skip hidden rows and columns in a target cell range when data is retrieved from a data source. Data is inserted into the next visible row or column.

• Cell Range as a Data Source

  These properties specify whether to take hidden columns and rows into account when data is extracted from a cell range. If the SkipHiddenColumns and DataSourceOptionsBase.SkipHiddenRows options are true, hidden columns and rows within a source range are skipped when a data source is created. The resulting data source contains only values originating from visible columns and rows. The unhide operation does not add columns and rows to the data source.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SkipHiddenColumns 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#

an-example-of-using-a-cell-range-as-a-data-source-t483776/CS/RangeDataSourceForSnap/Form1.cs#L38

}
options.SkipHiddenColumns = true;
rangeDS = dataRange.GetDataSource(options);

VB.NET

an-example-of-using-a-cell-range-as-a-data-source-t483776/VB/RangeDataSourceForSnap/Form1.vb#L41

End If
options.SkipHiddenColumns = True
rangeDS = dataRange.GetDataSource(options)