SetActiveFieldAsync Method
Overloads
| SetActiveFieldAsync(String, Int32, Int32) |
You can use the SetActiveField method with any object that contains a cyclic group as a dimension. This method allows you to jump to a specific field in a cyclic dimension. If NewIndex is out-of-bounds of the dimension's fields then no action is taken. A hypercube will avoid field collisions with its other dimensions when setting the active field in this manner. If there are any collisions then no action is performed. |
|
| SetActiveFieldAsync(AsyncHandle, String, Int32, Int32) |
You can use the SetActiveField method with any object that contains a cyclic group as a dimension. This method allows you to jump to a specific field in a cyclic dimension. If NewIndex is out-of-bounds of the dimension's fields then no action is taken. A hypercube will avoid field collisions with its other dimensions when setting the active field in this manner. If there are any collisions then no action is performed. |
SetActiveFieldAsync(String, Int32, Int32)
You can use the SetActiveField method with any object that contains a cyclic group as a dimension.
This method allows you to jump to a specific field in a cyclic dimension. If NewIndex is out-of-bounds of the dimension's fields then no action is taken.
A hypercube will avoid field collisions with its other dimensions when setting the active field in this manner. If there are any collisions then no action is performed.
Declaration
public Task SetActiveFieldAsync([QixName("qPath")] string path, [QixName("qDimNo")] int dimNo, [QixName("qNewIndex")] int newIndex)
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 | newIndex |
Index of the field to jump to. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
Implements
SetActiveFieldAsync(AsyncHandle, String, Int32, Int32)
You can use the SetActiveField method with any object that contains a cyclic group as a dimension.
This method allows you to jump to a specific field in a cyclic dimension. If NewIndex is out-of-bounds of the dimension's fields then no action is taken.
A hypercube will avoid field collisions with its other dimensions when setting the active field in this manner. If there are any collisions then no action is performed.
Declaration
public Task SetActiveFieldAsync(AsyncHandle asyncHandle, [QixName("qPath")] string path, [QixName("qDimNo")] int dimNo, [QixName("qNewIndex")] int newIndex)
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 | newIndex |
Index of the field to jump to. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |