[This is preliminary documentation and is subject to change.]
Moves an object upwards in an ordered collection, i.e. towards
the start.
Declaration Syntax
C# |
public bool MoveUp( IOrderable toMoveUp )
Parameters
- toMoveUp (IOrderable)
- The object to move up.
Return Value
True if the object was moved up, false if the object was already
the top (first) object in the collection.
Remarks
The object swaps position in the collection with the object before
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. |