StepCycleAsync Method
Overloads
| StepCycleAsync(String, Int32, Int32) |
You can use the StepCycle method with any object that contains a cyclic group as a dimension. This method allows you to move between different fields in a cyclic dimension. A hypercube will avoid field collisions with its other dimensions when cycling in this manner. If all other fields cause collisions then no cycling is performed. |
|
| StepCycleAsync(AsyncHandle, String, Int32, Int32) |
You can use the StepCycle method with any object that contains a cyclic group as a dimension. This method allows you to move between different fields in a cyclic dimension. A hypercube will avoid field collisions with its other dimensions when cycling in this manner. If all other fields cause collisions then no cycling is performed. |
StepCycleAsync(String, Int32, Int32)
You can use the StepCycle method with any object that contains a cyclic group as a dimension.
This method allows you to move between different fields in a cyclic dimension.
A hypercube will avoid field collisions with its other dimensions when cycling in this manner. If all other fields cause collisions then no cycling is performed.
Declaration
public Task StepCycleAsync([QixName("qPath")] string path, [QixName("qDimNo")] int dimNo, [QixName("qNbrSteps")] int nbrSteps)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | path |
Path to the definition of the object to be selected.
For example, |
| System.Int32 | dimNo |
Dimension number or index starting from 0. The default value is 0. |
| System.Int32 | nbrSteps |
Number of steps you want to cycle. Positive values cycle forwards while negative values cycle backwards. A value of 0 leads to no action being taken. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
Implements
StepCycleAsync(AsyncHandle, String, Int32, Int32)
You can use the StepCycle method with any object that contains a cyclic group as a dimension.
This method allows you to move between different fields in a cyclic dimension.
A hypercube will avoid field collisions with its other dimensions when cycling in this manner. If all other fields cause collisions then no cycling is performed.
Declaration
public Task StepCycleAsync(AsyncHandle asyncHandle, [QixName("qPath")] string path, [QixName("qDimNo")] int dimNo, [QixName("qNbrSteps")] int nbrSteps)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.String | path |
Path to the definition of the object to be selected.
For example, |
| System.Int32 | dimNo |
Dimension number or index starting from 0. The default value is 0. |
| System.Int32 | nbrSteps |
Number of steps you want to cycle. Positive values cycle forwards while negative values cycle backwards. A value of 0 leads to no action being taken. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |