Language
Edit

IDataCollectionItemPlacer.MoveRelative(Int32, Boolean) Method

Definition

Move visible data window by itemCount items forward or backward

public int MoveRelative(int itemCount, bool removeExitingObjectsNow = true);
abstract member MoveRelative : int * bool -> int
Public Function MoveRelative (itemCount As Integer, Optional removeExitingObjectsNow As Boolean = true) As Integer

Parameters

itemCount
Int32

THe number of items to scroll. Negative=previous. Positive=next.

removeExitingObjectsNow
Boolean

Remove no longer visible objects immediately and return back to object pool.

Returns

Actual number of items scrolled. Note: Always positive for previous or next.

Remarks

Note if objects are not removed immediately, they must be removed later using PurgeAllRemovableGameObjects() or PurgeRemovableGameObjectRange(Int32, Int32).

Applies to