Show / Hide Table of Contents

Method StepBack

| Edit this page View Source

StepBack(int)

Moves the slider position back by the specified number of time steps.

Declaration
public bool StepBack(int timeSteps = 1)
Parameters
Type Name Description
int timeSteps

The number of steps to advance the slider's position.

Returns
Type Description
bool

true if succeeded, false if the position could not be moved as requested.

Remarks

When the current time extent represents a time range and neither the start nor end time are pinned, then the number of time steps between the start and end time will always be preserved. In that case, a value of false will be returned if the extent could not be moved by the specified number of time steps without going beyond the start of the time slider's full extent. If the current time extent is a time instant and either the start or end time are pinned, then the method call will attempt to move the unpinned end of the time extent. In that case, the method will return false if the unpinned end could not be moved by the specified number of steps without going beyond the start of the full extent or the pinned end of the current extent. In all cases, when the method returns false, the time slider's current extent will be unchanged.

  • Edit this page
  • View Source
In this article
Back to top Generated by DocFX