OrderedBagTRangeFrom Method |
Returns a View collection that can be used for enumerating a range of the items in the bag.
Only items that are greater than (and optionally, equal to) from are included.
The items are enumerated in sorted order. Items equal to from can be included
or excluded depending on the fromInclusive parameter.
Namespace: X3Platform.CollectionsAssembly: X3Platform.Support (in X3Platform.Support.dll) Version: 1.0.0.0 (2.0.0.0)
Syntaxpublic OrderedBagTView RangeFrom(
T from,
bool fromInclusive
)
public:
OrderedBagTView^ RangeFrom(
T from,
bool fromInclusive
)
Parameters
- from
- Type: T
The lower bound of the range. - fromInclusive
- Type: SystemBoolean
If true, the lower bound is inclusive--items equal to the lower bound will
be included in the range. If false, the lower bound is exclusive--items equal to the lower bound will not
be included in the range.
Return Value
Type:
OrderedBagTViewAn OrderedBag.View of items in the given range.
RemarksTypically, this method is used in conjunction with a foreach statement. For example:
foreach(T item in bag.RangeFrom(from, true)) {
}
If an item is added to or deleted from the bag while the View is being enumerated, then
the enumeration will end with an InvalidOperationException.
Calling RangeFrom does not copy the data in the tree, and the operation takes constant time.
See Also