VGridControl.RemoveFromComparison(Int32[]) Method

Removes records from the comparison collection.

Namespace: DevExpress.XtraVerticalGrid

Assembly: DevExpress.XtraVerticalGrid.v24.2.dll

Declaration

C#

public bool RemoveFromComparison(
    int[] recordIndices
)

VB.NET

Public Function RemoveFromComparison(
    recordIndices As Integer()
) As Boolean

Parameters

Name	Type	Description
recordIndices	Int32[]	An array of integer values that specify the indices of the records to be removed from the comparison.

Returns

Type	Description
Boolean	true if the records were 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 records from the comparison collection.

Example

The following example removes the selected records (GetSelectedRecords) from the comparison.

C#

using DevExpress.XtraVerticalGrid;

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

VB.NET

Imports DevExpress.XtraVerticalGrid

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