Skip to main content
All docs
V24.2

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

VGridControl.IsInComparison(Int32) Method

Indicates whether a specific record is in the comparison collection.

Namespace: DevExpress.XtraVerticalGrid

Assembly: DevExpress.XtraVerticalGrid.v24.2.dll

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

#Declaration

public bool IsInComparison(
    int recordIndex
)

#Parameters

Name Type Description
recordIndex Int32

The index of the record to be tested.

#Returns

Type Description
Boolean

true if the record is in the comparison collection; otherwise, false

#Remarks

The VGridControl allows you to compare records if the AllowRecordComparison property is set to true.

The IsInComparison property returns true if a record is in the comparison collection.

To add records to the comparison, use the AddToComparison and AddSelectionToComparison methods.

#Example

The following example checks whether the focused record is in the comparison collection:

using DevExpress.XtraVerticalGrid;
private void btnCheckInComparison_ItemClick(object sender, DevExpress.XtraBars.ItemClickEventArgs e) {
  bool inComparison = vGridControl1.IsInComparison(vGridControl1.FocusedRecord);
}
See Also