DataGridViewColumnCollection.GetPreviousColumn Method (DataGridViewColumn, DataGridViewElementStates, DataGridViewElementStates)

 

Gets the last column prior to the given column in display order that meets the given filter requirements.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public DataGridViewColumn GetPreviousColumn(
	DataGridViewColumn dataGridViewColumnStart,
	DataGridViewElementStates includeFilter,
	DataGridViewElementStates excludeFilter
)

Parameters

dataGridViewColumnStart
Type: System.Windows.Forms.DataGridViewColumn

The column from which to start searching for the previous column.

includeFilter
Type: System.Windows.Forms.DataGridViewElementStates

A bitwise combination of the DataGridViewElementStates values that represent the filter to apply for inclusion.

excludeFilter
Type: System.Windows.Forms.DataGridViewElementStates

A bitwise combination of the DataGridViewElementStates values that represent the filter to apply for exclusion.

Return Value

Type: System.Windows.Forms.DataGridViewColumn

The previous column that meets the given filter requirements, or null if no column is found.

Exception Condition
ArgumentNullException

dataGridViewColumnStart is null.

ArgumentException

At least one of the filter values is not a valid bitwise combination of DataGridViewElementStates values.

The previous column in display order is the column with the highest DisplayIndex value lower than the DisplayIndex value of the specified column, regardless of whether the column is actually visible on the screen.

This method lets you determine the first column before the current column that fits the given criteria without having to compare index values directly.

.NET Framework
Available since 2.0
Return to top
Show: