[This is preliminary documentation and is subject to change.]
Moves an object downwards in an ordered collection, i.e. towards
the end.
Declaration Syntax| C# |
public bool MoveDown( IOrderable toMoveDown )
Parameters- toMoveDown (IOrderable)
- The object to move down.
Return ValueTrue if the object was moved down, false if the object was already
the bottom (last) object in the collection.
Remarks The object swaps position in the collection with the object after
it. This latter object may be null. The Order property of the moved object(s) is set
appropriately.
Exceptions| Exception | Condition |
|---|---|
| ArgumentNullException | Thrown if the supplied object was
null. |
| InvalidOperationException | Thrown if this is not an
ordered collection |
| ArgumentException | Thrown if the supplied object was not
found at its appropriate position in the collection. |