BeginSelectionsAsync Method
Overloads
| BeginSelectionsAsync(IEnumerable<String>) |
Begins the selection mode. The app enters the modal state. The specified object enters the selection mode and a modal window is opened. The selection mode can apply to only one object in an app at a time. When a visualization is in selection mode, selections can be made in this visualization. The visualization is not sorted until the selection mode is ended. Once the selection mode is ended and if the selections are accepted, the visualization is sorted according to the sort criteria. For more information about: * Ending the selection mode, see * The sort criteria, see ExampleA sheet contains a list object and a chart. If the list object is in selection mode then the chart cannot be in selection mode. No selection on the chart can be made until the list object exits the selection mode. |
|
| BeginSelectionsAsync(AsyncHandle, IEnumerable<String>) |
Begins the selection mode. The app enters the modal state. The specified object enters the selection mode and a modal window is opened. The selection mode can apply to only one object in an app at a time. When a visualization is in selection mode, selections can be made in this visualization. The visualization is not sorted until the selection mode is ended. Once the selection mode is ended and if the selections are accepted, the visualization is sorted according to the sort criteria. For more information about: * Ending the selection mode, see * The sort criteria, see ExampleA sheet contains a list object and a chart. If the list object is in selection mode then the chart cannot be in selection mode. No selection on the chart can be made until the list object exits the selection mode. |
BeginSelectionsAsync(IEnumerable<String>)
Begins the selection mode. The app enters the modal state. The specified object enters the selection mode and a modal window is opened. The selection mode can apply to only one object in an app at a time.
When a visualization is in selection mode, selections can be made in this visualization. The visualization is not sorted until the selection mode is ended. Once the selection mode is ended and if the selections are accepted, the visualization is sorted according to the sort criteria. For more information about:
- Ending the selection mode, see EndSelections Method.
- The sort criteria, see ListObjectDef or HyperCubeDef.
Example
A sheet contains a list object and a chart. If the list object is in selection mode then the chart cannot be in selection mode. No selection on the chart can be made until the list object exits the selection mode.
Declaration
Task BeginSelectionsAsync([QixName("qPaths")] IEnumerable<string> paths)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<System.String> | paths |
List of the paths to the definition of the objects to enter selection mode.
For example, |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
BeginSelectionsAsync(AsyncHandle, IEnumerable<String>)
Begins the selection mode. The app enters the modal state. The specified object enters the selection mode and a modal window is opened. The selection mode can apply to only one object in an app at a time.
When a visualization is in selection mode, selections can be made in this visualization. The visualization is not sorted until the selection mode is ended. Once the selection mode is ended and if the selections are accepted, the visualization is sorted according to the sort criteria. For more information about:
- Ending the selection mode, see EndSelections Method.
- The sort criteria, see ListObjectDef or HyperCubeDef.
Example
A sheet contains a list object and a chart. If the list object is in selection mode then the chart cannot be in selection mode. No selection on the chart can be made until the list object exits the selection mode.
Declaration
Task BeginSelectionsAsync(AsyncHandle asyncHandle, [QixName("qPaths")] IEnumerable<string> paths)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.Collections.Generic.IEnumerable<System.String> | paths |
List of the paths to the definition of the objects to enter selection mode.
For example, |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
Did this page help you?
If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!