RowOperation.CanContinueIteration(BaseRow) Method
Returns a value indicating whether the iteration must be stopped.
Namespace: DevExpress.XtraVerticalGrid.Rows
Assembly: DevExpress.XtraVerticalGrid.v24.2.dll
Declaration
Parameters
Name | Type | Description |
---|---|---|
row | BaseRow | A BaseRow descendant representing the processed row. |
Returns
Type | Description |
---|---|
Boolean | true to continue iteration; false to stop iteration. |
Remarks
This method is called before the operation implemented in the RowOperation.Execute method is performed on the processed row. As implemented in the RowOperation class, the CanContinueIteration method returns true. This means that the iteration is stopped only after all rows have been processed. If this method returns false, the iteration process is stopped immediately. This can be useful when searching for a specific row as shown in the example below.
Example
The following sample code declares the FindRowItemByCaption method that searches the rows collection specified by the rows parameter for a row item with the specified caption. This method returns the first row item found.
The specified collection of rows and their children are traversed using the Rows Iterator‘s VGridRowsIterator.DoLocalOperation method. The operation performed on the row visited is specified by the FindRowItemOperation object. Once a row item with the specified caption is found, the operation’s RowOperation.CanContinueIteration
property is automatically set to false. This indicates that the operation must be stopped. The operation’s RowProperties property represents the row item with the specified caption. null (Nothing in Visual Basic) is returned if no item is found.
using DevExpress.XtraVerticalGrid;
using DevExpress.XtraVerticalGrid.Rows;
// ...
RowProperties prop = FindRowItemByCaption(vGridControl1, vGridControl1.Rows, "Name");
// searches the specified rows collection for a row item with the specified caption
private RowProperties FindRowItemByCaption(VGridControl vGrid, VGridRows rows ,
string caption){
FindRowItemOperation operation = new FindRowItemOperation(caption);
vGrid.RowsIterator.DoLocalOperation(operation, rows);
return operation.RowProperties;
}
// declares the operation calss
public class FindRowItemOperation : RowOperation {
string caption;
RowProperties props;
public FindRowItemOperation(string caption) : base() {
this.caption = caption;
this.props = null;
}
public override void Execute(BaseRow row) {
for(int i = 0; i < row.RowPropertiesCount; i++){
if(row.GetRowProperties(i).Caption == caption) {
props = row.GetRowProperties(i);
return;
}
}
}
public override bool CanContinueIteration(BaseRow row) {
return (RowProperties == null);
}
public RowProperties RowProperties {
get {
return props;
}
}
}