GetFieldValuesExAsync Method
Overloads
| GetFieldValuesExAsync(String, Boolean, BookmarkStateFieldPages) |
Retrieves the values of a field per state. FieldvaluePlease refer to Engine API reference for table definition. |
|
| GetFieldValuesExAsync(AsyncHandle, String, Boolean, BookmarkStateFieldPages) |
Retrieves the values of a field per state. FieldvaluePlease refer to Engine API reference for table definition. |
|
| GetFieldValuesExAsync<T>(AsyncHandle, Func<Response, T>, String, Boolean, BookmarkStateFieldPages) |
Retrieves the values of a field per state. FieldvaluePlease refer to Engine API reference for table definition. |
GetFieldValuesExAsync(String, Boolean, BookmarkStateFieldPages)
Retrieves the values of a field per state.
Fieldvalue
Please refer to Engine API reference for table definition.
Declaration
Task<IEnumerable<StateFieldValues>> GetFieldValuesExAsync([QixName("qField")] string field, [QixName("qGetExcludedValues")] bool getExcludedValues, [QixName("qDataPages")] BookmarkStateFieldPages dataPages)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | field |
Name of the field. |
| System.Boolean | getExcludedValues |
When to true, only NOT-selected values are returned. |
| BookmarkStateFieldPages | dataPages |
Range of returned values per state, an empty array will return the values of all states. Only one page without a state name returns the values for all states, using the start and end indices of the first page. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<StateFieldValues>> |
GetFieldValuesExAsync(AsyncHandle, String, Boolean, BookmarkStateFieldPages)
Retrieves the values of a field per state.
Fieldvalue
Please refer to Engine API reference for table definition.
Declaration
Task<IEnumerable<StateFieldValues>> GetFieldValuesExAsync(AsyncHandle asyncHandle, [QixName("qField")] string field, [QixName("qGetExcludedValues")] bool getExcludedValues, [QixName("qDataPages")] BookmarkStateFieldPages dataPages)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.String | field |
Name of the field. |
| System.Boolean | getExcludedValues |
When to true, only NOT-selected values are returned. |
| BookmarkStateFieldPages | dataPages |
Range of returned values per state, an empty array will return the values of all states. Only one page without a state name returns the values for all states, using the start and end indices of the first page. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<StateFieldValues>> |
GetFieldValuesExAsync<T>(AsyncHandle, Func<Response, T>, String, Boolean, BookmarkStateFieldPages)
Retrieves the values of a field per state.
Fieldvalue
Please refer to Engine API reference for table definition.
Declaration
Task<T> GetFieldValuesExAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qField")] string field, [QixName("qGetExcludedValues")] bool getExcludedValues, [QixName("qDataPages")] BookmarkStateFieldPages dataPages)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.Func<Response, T> | onResult |
Continuation function |
| System.String | field |
Name of the field. |
| System.Boolean | getExcludedValues |
When to true, only NOT-selected values are returned. |
| BookmarkStateFieldPages | dataPages |
Range of returned values per state, an empty array will return the values of all states. Only one page without a state name returns the values for all states, using the start and end indices of the first page. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<T> |
Type Parameters
| Name | Description |
|---|---|
| T |
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!