DataCollectionItemPlacerGOBase.MoveRelative(Int32, Boolean) Method

Definition

Namespace:: MixedReality.Toolkit.Data

Assembly:: MixedReality.Toolkit.Data.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Scroll visible data window by itemCount items forward or backward

public int MoveRelative(int itemCount, bool purgeExitingObjectsNow = true);

abstract member MoveRelative : int * bool -> int
override this.MoveRelative : int * bool -> int

Public Function MoveRelative (itemCount As Integer, Optional purgeExitingObjectsNow As Boolean = true) As Integer

Parameters

itemCount: Int32

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

purgeExitingObjectsNow: Boolean

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

Returns

Int32

Actual number of items scrolled. This must always be positive for previous or next.

Implements

MoveRelative(Int32, Boolean)

Remarks

Note, if objects are not removed immediately, they must be removed later (such as after a transition effect) using PurgeAllRemovableGameObjects() or PurgeRemovableGameObjectRange(Int32, Int32).

Applies to