VGridControl.RemoveFromComparison(Int32) Method

Removes a specific record from the comparison collection.

Namespace: DevExpress.XtraVerticalGrid

Assembly: DevExpress.XtraVerticalGrid.v23.2.dll

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

Declaration

C#

public bool RemoveFromComparison(
    int recordIndex
)

VB.NET

Public Function RemoveFromComparison(
    recordIndex As Integer
) As Boolean

Parameters

Name	Type	Description
recordIndex	Int32	The index of the record to be removed from the comparison.

Returns

Type	Description
Boolean	true if the record was successfully removed from the comparison; otherwise, false.

Remarks

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

The RemoveFromComparison method removes a record from the comparison collection.

Example

The following example removes the focused record (FocusedRecord) from the comparison.

C#

using DevExpress.XtraVerticalGrid;

private void btnRemoveFromComparison_ItemClick(object sender, DevExpress.XtraBars.ItemClickEventArgs e){
  vGridControl1.RemoveFromComparison(vGridControl1.FocusedRecord);
}

VB.NET

Imports DevExpress.XtraVerticalGrid

Private  Sub btnRemoveFromComparison_ItemClick(ByVal sender As Object, ByVal e As DevExpress.XtraBars.ItemClickEventArgs)          
  vGridControl1.RemoveFromComparison(vGridControl1.FocusedRecord)
End Sub