.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

XPBaseCollection.SkipReturnedObjects Property

Gets or sets the number of objects to exclude when populating the collection with objects from a data store.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v21.1.dll

Declaration

[DefaultValue(0)]
public int SkipReturnedObjects { get; set; }

Property Value

Type Description
Int32

An integer value that specifies the number of objects to exclude when populating the collection. 0 indicates that objects are not excluded.

Remarks

If the property value is greater than 0, then the collection skips the first SkipReturnedObjects objects which match the collection’s XPBaseCollection.Criteria, and retrieves the number of objects specified by the XPBaseCollection.TopReturnedObjects property. So, SkipReturnedObjects is applied before XPBaseCollection.TopReturnedObjects.

Note

Use the SkipReturnedObjects property to adjust an XPCollection‘s object retrieval options before it’s loaded. Once a collection is loaded, changing this property has no effect. To make the changes take effect, you need to manually reload the collection. When an XPCollection is created using a constructor with the criteriaEvaluationBehavior parameter, it is loaded immediately. So, changing the SkipReturnedObjects property will also have no effect.

See Also