You use Nesting.IsSeekerResultGrid to identify the grid that displays results from a Seeker when your seeker uses paged search results.
Purpose
A Seeker is a ViewModel used to search for objects in the database. A seeker page can contain more than one grid, such as a grid for search criteria and a grid for returned objects. The framework must know which grid displays the seeker result so that it can generate paging UI for that result.
Set the tagged value IsSeekerResultGrid to true on the Nesting of the grid that renders the Seeker result.
For example, if a seeker returns a collection in vSeekerResult and the page contains a grid showing that collection, add IsSeekerResultGrid=true to that grid's Nesting. Do not add the tag to a grid used only for criteria, reference selection, or unrelated data.
When to use it
Use this tagged value when all of the following are true:
- You have a Seeker that returns a collection of search results.
- You have configured seeker paging as described in Documentation:Search result pages.
- The page needs to tell the framework which grid receives the paged result.
The generated paging UI is available for seeker paging in the WPF client and Angular Turnkey client.
| Situation | Add IsSeekerResultGrid=true?
|
|---|---|
| A Seeker returns results in a grid and paging is configured. | Yes. Add it to the Nesting for the results grid. |
| A page has several grids, but only one displays the Seeker result. | Yes. Add it only to the result grid. |
| A grid displays search input, selected filters, or supporting data. | No. It is not the seeker result grid. |
| An AutoForms-generated seeker uses paging. | Usually no manual change is needed; AutoForms seekers add this tagged value. |
Configure the result grid
- Open the Seeker ViewModel in MDriven Designer.
- Locate the grid that displays the collection returned by the Seeker. In a standard seeker, this is commonly the collection variable named
vSeekerResult. - Select the Nesting for that grid.
- Add a tagged value named
IsSeekerResultGrid. - Set its value to
true. - Save the ViewModel and test the seeker in the target client.
Example
Assume a Seeker searches for Person objects. Its search logic returns matching persons in vSeekerResult. The ViewModel page contains these grids:
- A grid or layout for entering name and date criteria.
- A grid bound to
vSeekerResultthat shows each matching person. - A supporting grid that shows a selected person's related records.
Apply the tagged value to the Nesting of the vSeekerResult grid:
IsSeekerResultGrid=true
Do not apply it to the criteria or supporting grids. This identifies the vSeekerResult grid as the target for the paging controls generated by the seeker paging logic.
Relationship to paging
This tagged value identifies the UI target; it does not enable paging by itself. Configure the seeker paging variables and count query described in Documentation:Search result pages. In that setup:
vSeekerResultCountholds the total number of hits.vSeekerPageLengthspecifies the desired page length.vSeekerPageCountholds the number of available pages.vSeekerPageselects the page to fetch.
Use MaxFetch when you need to control the maximum number of rows returned by a search. MaxFetch is separate from the IsSeekerResultGrid tag.
Related grid behavior
This tag is specific to identifying the Seeker result grid. Configure other grid behavior separately. For example, Nesting.ClientSortable makes a table client sortable by default, while list selection and multi-select behavior are described in Documentation:Tables and Grids.
