SelectListObjectValuesAsync Method
Overloads
| SelectListObjectValuesAsync(String, IEnumerable<Int32>, Boolean, Boolean) |
Makes single selections in dimensions. The member Change returns the handles of the objects that are updated following the selections.
* The object contains invalid fields (fields that are not in the data model). * The selection applies to a locked field. * A range selection is performed and the parameter |
|
| SelectListObjectValuesAsync(AsyncHandle, String, IEnumerable<Int32>, Boolean, Boolean) |
Makes single selections in dimensions. The member Change returns the handles of the objects that are updated following the selections.
* The object contains invalid fields (fields that are not in the data model). * The selection applies to a locked field. * A range selection is performed and the parameter |
|
| SelectListObjectValuesAsync<T>(AsyncHandle, Func<Response, T>, String, IEnumerable<Int32>, Boolean, Boolean) |
Makes single selections in dimensions. The member Change returns the handles of the objects that are updated following the selections.
* The object contains invalid fields (fields that are not in the data model). * The selection applies to a locked field. * A range selection is performed and the parameter |
SelectListObjectValuesAsync(String, IEnumerable<Int32>, Boolean, Boolean)
Makes single selections in dimensions.
The member Change returns the handles of the objects that are updated following the selections.
qSuccess is set to true if the selections are successful and is set to false in the following cases:
- The object contains invalid fields (fields that are not in the data model).
- The selection applies to a locked field.
- A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.
Declaration
public Task<bool> SelectListObjectValuesAsync([QixName("qPath")] string path, [QixName("qValues")] IEnumerable<int> values, [QixName("qToggleMode")] bool toggleMode, [QixName("qSoftLock")] bool softLock = false)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | path |
Path to the definition of the object to be selected.
For example, |
| System.Collections.Generic.IEnumerable<System.Int32> | values |
Element numbers to select. You can select multiple values; the separator is the comma. |
| System.Boolean | toggleMode |
Set to true to toggle. |
| System.Boolean | softLock |
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Boolean> |
Implements
Remarks
This method applies to list objects only.
SelectListObjectValuesAsync(AsyncHandle, String, IEnumerable<Int32>, Boolean, Boolean)
Makes single selections in dimensions.
The member Change returns the handles of the objects that are updated following the selections.
qSuccess is set to true if the selections are successful and is set to false in the following cases:
- The object contains invalid fields (fields that are not in the data model).
- The selection applies to a locked field.
- A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.
Declaration
public Task<bool> SelectListObjectValuesAsync(AsyncHandle asyncHandle, [QixName("qPath")] string path, [QixName("qValues")] IEnumerable<int> values, [QixName("qToggleMode")] bool toggleMode, [QixName("qSoftLock")] bool softLock = false)
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.Collections.Generic.IEnumerable<System.Int32> | values |
Element numbers to select. You can select multiple values; the separator is the comma. |
| System.Boolean | toggleMode |
Set to true to toggle. |
| System.Boolean | softLock |
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Boolean> |
Implements
Remarks
This method applies to list objects only.
SelectListObjectValuesAsync<T>(AsyncHandle, Func<Response, T>, String, IEnumerable<Int32>, Boolean, Boolean)
Makes single selections in dimensions.
The member Change returns the handles of the objects that are updated following the selections.
qSuccess is set to true if the selections are successful and is set to false in the following cases:
- The object contains invalid fields (fields that are not in the data model).
- The selection applies to a locked field.
- A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.
Declaration
public Task<T> SelectListObjectValuesAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qPath")] string path, [QixName("qValues")] IEnumerable<int> values, [QixName("qToggleMode")] bool toggleMode, [QixName("qSoftLock")] bool softLock = false)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.Func<Response, T> | onResult |
Continuation function |
| System.String | path |
Path to the definition of the object to be selected.
For example, |
| System.Collections.Generic.IEnumerable<System.Int32> | values |
Element numbers to select. You can select multiple values; the separator is the comma. |
| System.Boolean | toggleMode |
Set to true to toggle. |
| System.Boolean | softLock |
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<T> |
Type Parameters
| Name | Description |
|---|---|
| T |
Implements
Remarks
This method applies to list objects only.