Custom Query Search - Revision history

CWI at 15:28, 25 September 2025

2025-09-25T15:28:46Z

CWI: /* Example */

2025-09-22T11:04:54Z

‎Example

CWI at 12:14, 18 September 2025

2025-09-18T12:14:53Z

LKR: /* Application */

2024-12-12T12:26:50Z

‎Application

LKR: /* Parameters */

2024-12-12T10:04:07Z

‎Parameters

LKR at 09:57, 12 December 2024

2024-12-12T09:57:18Z

LKR at 06:58, 10 December 2024

2024-12-10T06:58:11Z

LKR at 06:57, 10 December 2024

2024-12-10T06:57:41Z

LKR: Created page with "{{UnderConstructionStart}} The custom query search uses a query provided via the customizing to define the context of the search. {{Version/WinXSince|4.9}}{{Version/XamarinSi..."

2024-12-05T05:25:22Z

Created page with "{{UnderConstructionStart}} The custom query search uses a query provided via the customizing to define the context of the search. {{Version/WinXSince|4.9}}{{Version/XamarinSi..."

New page

{{UnderConstructionStart}}

The custom query search uses a query provided via the customizing to define the context of the search. {{Version/WinXSince|4.9}}{{Version/XamarinSince|4.9}}

== Application ==
The custom query search is used when it is necessary to search within a defined subset of objects rather then the entire data structure. Additionally the custom query search does not include an offline search (in contrast to the [[Mobile_Free_Text_Search|free text search]]).

== Functionality ==
To use the custom query search it is necessary to customize the project as it is not part of the default UI. When the custom query search is added to the customizing it can be used to replace the standard UI's [[Mobile_Free_Text_Search|free text search]] field or added additionally.

When using the custom query search in the customizing of a project it is necessary to provide the UID of the query object that should be used to define the search context. When no UID is given the search will never provide results. How exactly the search term is interpreted and used to return a List of results is handled on the server side.

The custom query search utilizes the same result handling as the [[Mobile_Free_Text_Search|free text search]]. This means the results for both searches are represented in the same list, replacing each other.

=== Parameters ===
* SearchText: takes the string that should be used as search term for the search.
* QueryID: takes the UID of the query object that should be used as search context.
* NavigateOnSingleResult: if this is set to true and a search returns only a single result the app will automatically navigate to the found object.

== Example ==
<tabs>
<tab name="UWP">
<source lang = "xml">
<AutoSuggestBox
...
<interactivity:Interaction.Behaviors>
<behaviors:AutoSuggestBoxInputBehavior>
<core:InvokeCommandAction Command="{Binding CustomQuerySearchCommand}">
<core:InvokeCommandAction.CommandParameter>
<controls:KeyValueList>
<controls:KeyValueParameter Key="SearchText" Value="{Binding ElementName=Search, Path=Text}" />
<controls:KeyValueParameter Key="NavigateOnSingleResult" Value="true" />
<controls:KeyValueParameter Key="QueryID" Value="bab1c694-a5ad-421f-8c85-faa385891e4b" />
</controls:KeyValueList>
</core:InvokeCommandAction.CommandParameter>
</core:InvokeCommandAction>
</behaviors:AutoSuggestBoxInputBehavior>
</interactivity:Interaction.Behaviors>
</AutoSuggestBox>
</source>
</tab>

<tab name="Xamarin">
<source lang = "xml">
<SearchBar
...
<behaviors:EventHandlerBehavior EventName="SearchButtonPressed">
<behaviors:InvokeCommandAction Command="{Binding CustomQuerySearchCommand}">
<behaviors:InvokeCommandAction.CommandParameter>
<classes:KeyValueList>
<classes:KeyValueParameter Key="SearchText"
Value="{Binding Path=Text, Source={x:Reference SearchField}}" />
<classes:KeyValueParameter Key="NavigateOnSingleResult" Value="true" />
<classes:KeyValueParameter Key="QueryID" Value="bab1c694-a5ad-421f-8c85-faa385891e4b" />
</classes:KeyValueList>
</behaviors:InvokeCommandAction.CommandParameter>
</behaviors:InvokeCommandAction>
</behaviors:EventHandlerBehavior>
</SearchBar.Behaviors>
</SearchBar>
</source>
</tab>
</tabs>

@@ Line 65: / Line 65: @@
 </tabs>
-[[Category:Mobile|Custom Query Search]]
-[[Category:Version 4.9|Custom Query Search]]
 == See also ==
 * [[SYSCLS_CUSTOMQUERYSEARCH]]
 [[Category:Mobile|Custom Query Search]]

@@ Line 43: / Line 43: @@
 </tab>
-<tab name="Xamarin">
+<tab name="Mobile(Xamarin)">
 <source lang = "xml">
 <SearchBar x:Name="SearchField"
@@ Line 64: / Line 64: @@
 </tab>
 </tabs>
 == See also ==

@@ Line 4: / Line 4: @@
 The custom query search is used when the [[Mobile_Free_Text_Search|free text search]] does not deliver the desired results and a customized online search based on the results of a query is desired. The custom query search does NOT include an offline search (in contrast to the [[Mobile_Free_Text_Search|free text search]]).
-[[Category:Version 4.9|Custom Query Search]]
 == Functionality ==
@@ Line 18: / Line 18: @@
 * (Optional) NavigateOnSingleResult: if this is set to true and a search returns only a single result the app will automatically navigate to the found object. By default its value is true.
-[[Category:Version 4.9|Custom Query Search]]
 == Example ==
@@ Line 69: / Line 69: @@
 [[Category:Version 4.9|Custom Query Search]]

@@ Line 62: / Line 62: @@
 </tab>
 </tabs>
 [[Category:Version 4.9|Custom Query Search]]

← Older revision		Revision as of 06:57, 10 December 2024
Line 62:		Line 62:
	</tab>		</tab>
	</tabs>		</tabs>
		+
		+	[[Category:Version 4.9\|Custom Query Search]]

@@ Line 2: / Line 2: @@
 == Application ==
-The custom query search is used when it is necessary to search within a defined subset of objects rather then the entire data structure. Additionally the custom query search does not include an offline search (in contrast to the [[Mobile_Free_Text_Search|free text search]]).
+The custom query search is used when the [[Mobile_Free_Text_Search|free text search]] does not deliver the desired results and a customized online search based on the results of a query is desired. The custom query search does NOT include an offline search (in contrast to the [[Mobile_Free_Text_Search|free text search]]).
 == Functionality ==

@@ Line 14: / Line 14: @@
 * SearchText: takes the string that should be used as search term for the search.
 * QueryID: takes the UID of the query object that should be used as search context.
-* (Optional) NavigateOnSingleResult: if this is set to true and a search returns only a single result the app will automatically navigate to the found object. By default its value is false.
+* (Optional) NavigateOnSingleResult: if this is set to true and a search returns only a single result the app will automatically navigate to the found object. By default its value is true.
 == Example ==

@@ Line 1: / Line 1: @@
 The custom query search uses a query provided via the customizing to define the context of the search. {{Version/WinXSince|4.9}}{{Version/XamarinSince|4.9}}
@@ Line 16: / Line 14: @@
 * SearchText: takes the string that should be used as search term for the search.
 * QueryID: takes the UID of the query object that should be used as search context.
-* NavigateOnSingleResult: if this is set to true and a search returns only a single result the app will automatically navigate to the found object.
+* (Optional) NavigateOnSingleResult: if this is set to true and a search returns only a single result the app will automatically navigate to the found object. By default its value is false.
 == Example ==
@@ Line 22: / Line 20: @@
 <tab name="UWP">
 <source lang = "xml">
-<AutoSuggestBox
+<AutoSuggestBox x:Name="Search"
 ...
      <interactivity:Interaction.Behaviors>
@@ Line 43: / Line 41: @@
 <tab name="Xamarin">
 <source lang = "xml">
-<SearchBar
+<SearchBar x:Name="SearchField"
     ...
          <behaviors:EventHandlerBehavior EventName="SearchButtonPressed">