SelectListObjectAlternativeAsync Method
Overloads
| SelectListObjectAlternativeAsync(String, Boolean) |
Selects all alternative values in a specific field. The member Change returns the handles of the objects that are updated following the selections.
* The object contains some 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 |
|
| SelectListObjectAlternativeAsync(AsyncHandle, String, Boolean) |
Selects all alternative values in a specific field. The member Change returns the handles of the objects that are updated following the selections.
* The object contains some 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 |
|
| SelectListObjectAlternativeAsync<T>(AsyncHandle, Func<Response, T>, String, Boolean) |
Selects all alternative values in a specific field. The member Change returns the handles of the objects that are updated following the selections.
* The object contains some 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 |
SelectListObjectAlternativeAsync(String, Boolean)
Selects all alternative values in a specific field.
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 some 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
Task<bool> SelectListObjectAlternativeAsync([QixName("qPath")] string path, [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.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> |
Remarks
This method applies to list objects (objects with one dimension).
SelectListObjectAlternativeAsync(AsyncHandle, String, Boolean)
Selects all alternative values in a specific field.
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 some 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
Task<bool> SelectListObjectAlternativeAsync(AsyncHandle asyncHandle, [QixName("qPath")] string path, [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.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> |
Remarks
This method applies to list objects (objects with one dimension).
SelectListObjectAlternativeAsync<T>(AsyncHandle, Func<Response, T>, String, Boolean)
Selects all alternative values in a specific field.
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 some 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
Task<T> SelectListObjectAlternativeAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qPath")] string path, [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.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 |
Remarks
This method applies to list objects (objects with one dimension).