UBIK Wiki Test / Augmensys - User contributions [en]

Version 3.8 (WinX)

2021-08-09T11:17:42Z

CWU:

= Release Notes =

== Version 3.8.?? (2021-06-??) ==
* Fixed an occasional crash when the property list gets reloaded (ListToBindableVectorAdapter.EnsureIndexInt32 exceptions).
* Fixed an issue where the content creation button might be incorrectly disabled after the context object gets edited.
* Multi line drawings are now supported in UBIKPdfViewer
* Fixed an issue, that would cause a corruption of the profile

== Version 3.8.42 (2021-05-25/2021-06-30) {{key press|Store Beta}}/{{key press|Store}} ==
* The auto branch download feature is now disabled by default and can be enabled in the Content settings.
* Supports the scanning of color inverted 2D codes. It is an option that can be turned on/off in the Camera settings.

== Version 3.8.38 (2021-05-18) {{key press|DevOps}} ==
* PDFViewer now supports multi language use.
* PDFViewer now supports customizable toolbar/button color.
* Fixed issues where text highlight/underline/strike-through did not work in PDFViewer.

== Version 3.8.36 (2021-04-23) {{key press|Store}} ==
=== Feature highlight ===
* The client can now receive [[Login_View#Login_details|detailed information]] about the current user as well as other users.
* Users can now [[XAML#CaptureMediaCommand|record audios]] (in addition to videos and photos) as {{UBIK}} documents.
* Data customizers can now configure whether & how UBIK content should be [[Branch_Download#Automatic_Download|automatically downloaded]] to the clients.
* The DeviceID is now unique and independent of network hardware changes.
* Profile settings are now automatically saved when users leave the settings page.
* UBIKDetailsQueryArea is now fully customizable.
* Added basic [[Time_Zone_Support_(Client)|time zone support]].
* Re-implemented the annotation feature to unify it with the upcoming platform releases on Android and iOS
** On PDFs, an annotation can be edited as long as it's not merged into the document, but only by the user who created it
* The [[XAML#UBIKImageEditor|UBIKImageEditor]] provides the possibility to customize the following in XAML.
** The visibility of the image toolbar;
** Whether annotations should be saved separately in the annotation properties or "burnt into" the original images.
* The CreateChildItemCommand now supports specifying the owner (by its UID) under which the object should be created.
* Added a thumbnail indicator and a more helpful text header in the document flip view.
* Made the client aware of map overlays even when they are not a part of the infrastructure.
* Supports [[AR-Marker#Grouped_AR_Marker|grouping of AR markers]] (like for geo POIs) to overcome the limitation of the maximum 1024 unique Aruco markers.
* ContentViewModel.PropertyItems can now be filtered using the ListCollectionView.

=== Bugfixes ===
* Fixed an issue where the geo editor misbehaved for newly created objects (or those without original server values).
* Fixed an issue where changes to geo property values were lost in offline/manual mode.
* Fixed an issue where scanning did not work when the search box is customized away from the login page.
* Fixed an issue where the bottom menu item for creating child items stopped working.
* Fixed an issue where the POIs are sometimes not shown (when navigating from the map page to the POI page).
* Fixed an issue where content list items sometimes stopped responding to user interactions after content updates.
* Empty signatures can now not be confirmed anymore.
* Fixed an issue where single content updates did not cause the XAML filters to re-evaluate, resulting in content in filtered lists where it didn't belong.
* Fixed an issue, where the HotSpotClassification was needed to annotate an object.
* After entering/exiting a POI group, the correct Geo POIs are now displayed.
* Fixed some issues that prevented certain members from being displayed in the type browser of the developer mode.
* Fixed an issue where scanning might not work under certain circumstances (namely when the default search box is customized away from the login page).
* Fixed a bug where mass editing did not correctly apply its initial selection on all items.
* Fixed an issue where newly created document files could not be played until they are saved.
* Fixed missing commits if committing many objects at once.
* Fixed an issue where the first child document is not loaded when you navigate to a details page.
* Fixed an issue where the app freezes for seconds when displaying a large list of [[UBIK_WinX_Client_Basics#Properties_with_value_records|property values records]].
* Fixed missing previous/next buttons in the document flipview when a URL/linked document is presented.
* The profile browser now displays the path of the subfolders relative to the root folder for better readability.
* Fixed an issue where redlining didn't work when configured to navigate to the created documents upon finishing.
* Fixed an issue where root & infrastructure objects were not updated after users switch online manually and the app detects new meta definitions.
* Fixed an issue where the app might repeatedly update meta definitions and other data until users confirm the warning dialog about outdated meta definitions.
* Fixed an issue where it's not possible to enter/exit POI groups/buildings in the POI page.
* Fixed an issue where property lists become empty after multiple updates (in quick succession) on the same content.
* Fixed an issue where the app displayed no error message when failing to contact the content service right after login.
* Fixed an issue where the app displayed wrong versions of document files in certain cases (e.g. when apps such as OneDrive are syncing the pictures folder).
* Fixed an issue where the root page and the settings page displayed the wrong headers.
* Fixed an issue where the app gets stuck during offline logins when there are open/unprocessed pushes.
* Fixed an issue where Aruco POIs are not displayed when they are referenced by marker objects but are not marker objects themselves (without [[SYSCLS_ARMARKER]]).
* Fixed an issue where profiles are duplicated when their <Name> tags don't match their file names or when they are placed under sub folders.
* Fixed an issue where the setting to use Geo locations from scanned results is not persisted/restored.

== Known issues ==
* Sometimes, list items might stop responding to clicks after online content updates. A refresh/reopening of the page solves the problem.
* Project specific resources defined in UBIKThemes might not take effect immediately after switching profiles. Restarting the app solves the problem.
* If a device has multiple cameras of exactly the same model (e.g. Microsoft HD 3000), the wrong one might be used during remote support calls.
* The AR Marker related features are resource intense and can cause the app to slow down on weaker tablets.
* Sometimes after an external bluetooth RFID scanner is disconnected, the app still incorrectly recognizes it as available.
<br />

= XAML Notes =

== UBIKMediaPlayerElement ==
This control is introduced to replace the old MediaElement we used for playing video/audio files. Because the old one had an issue that newly created document files can not be played until they are saved.
If this issue is relevant, you should update those XAML files that use MediaElement. See below.

<tabs>
<tab name="New">
<source lang = "xml">
<Grid xmlns:controls="using:UBIK.WinX.Controls">
<controls:UBIKMediaPlayerElement
...
SourceExt="{Binding DocumentViewModel.LocalURI}" />
</Grid>
</source>
</tab>
<tab name="Old">
<source lang = "xml">
<Grid>
<MediaElement
...
Source="{Binding DocumentViewModel.LocalURI}" />
</Grid>
</source>
</tab>
</tabs>

If this issue is irrelevant or does not bother your users, you can skip updating the XAMLs since the old MediaElement still works for the most part.

<headertabs />

{{Category/Version2|{{PAGENAME}}}}

[[Category:Client|Version 3.8 (WinX)]]
[[Category:Version 3.8|Version 3.8 (WinX)]]
[[Category:WinX|Version 3.8 (WinX)]]

Version 1.2 (Xamarin)

2021-07-28T13:09:08Z

CWU:

= Release Notes =

== Release ==

=== 1.2.?? on 2021-??-?? ===
* XAML customizers can now specify expressions for [[Property_Based_Content_Filters#UpdatePropertyFiltersCommand|property based filtering]].
* Disabled Android app data backup for UBIK due to customer concerns on security.
* Multi line drawings are now supported in UBIKPdfViewer.
* The app no longer unnecessarily update online content when reapplying property based filtering.
* Fixed an issue where PickerExt doesn’t properly show selected items with pre-defined item sources.
* Fixed an issue where scroll positions were not remembered in some lists after content updates.
* Fixed an issue where loading of a big amount of POIs was blocking the UI
* Fixed an issue where POIs were not clickable

=== 1.2.42 on 2021-07-20 {{key press|Android: Store}} {{key press|iOS: App Center}} {{key press|UWP: App Center}} ===
* Enabled the color styling of the app/navigation bar.
* Fixed an issue where the content creation button might be incorrectly disabled after the context object gets edited.
* Fixed an issue where sharing of .xamlx and .profile files with UBIK didn't work anymore (iOS).
* Added preview versions of new customizing behaviors and actions {{key press|Preview}}
** EventChangedBehavior
** DataChangedBehavior
** InvokeCommandAction
** InvokeMethodAction
** SetPropertyAction
** ScaleAction
** RotateAction
** TranslateAction
** FadeAction
* Annotations are now correctly reverted, when triggering revert in offline mode.
* Multi line drawings are now supported in PDF annotations (UBIKPdfViewer).

=== 1.2.29 on 2021-05-31 {{key press|Android: Store}} {{key press|iOS: Store}} {{key press|UWP: App Center}} ===
* This is the same version as the 1.2.29 beta.

== Beta ==

=== 1.2.29 on 2021-05-21 {{key press|Android: Store Beta}} {{key press|iOS: App Center}} {{key press|UWP: App Center}} ===
* The auto branch download feature is now disabled by default and can be enabled in the settings.
* Supports the scanning of color inverted 2D codes. It is an option that can be turned on/off in the AR settings.

=== 1.2.28 on 2021-05-07 {{key press|Android: Store Beta}} {{key press|iOS: App Center}} ===
* Fixed the broken iOS packages in 1.2.23 and 1.2.24.
* Fixed the orientations of photos taken in the app (iOS).
* Search for content by scanning RFID tags (now also on iOS).

=== 1.2.23/24 on 2021-05-06 {{key press|iOS: App Center}} ===
* '''There is an installation issue of the iOS app due to an updated Apple account configuration. We apologize for the confusion caused and please skip these two versions.'''

=== 1.2.22 on 2021-05-06 {{key press|Android: Store Beta}} {{key press|iOS: App Center}} {{key press|UWP: App Center}} ===
* Added a button in the settings to open the Readme document.
* Profile specific XAML customizings are now supported.

=== 1.2.18 on 2021-05-03 {{key press|Android: Store Beta}} {{key press|iOS: App Center}} {{key press|UWP: App Center}} ===
* Fixed the orientations of photos taken in the app (except iOS).

=== 1.2.17 on 2021-04-29 {{key press|Android: Store Beta}} {{key press|iOS: App Center}} {{key press|UWP: App Center}} ===
* Removed the preview toast upon app startup since we are in beta now.

== Preview ==

=== 1.2.15 on 2021-04-28 {{key press|Android: App Center}} {{key press|iOS: App Center}} {{key press|UWP: App Center}} ===
* The property based content filtering can now receive criterion values from the [[Property_Based_Content_Filters#UpdatePropertyFiltersCommand|UpdatePropertyFiltersCommand]] and can be use in setups with more complex bindings.
* The Device ID now stays constant when network hardware changes.
* The client can now receive [[Login_View#Login_details|detailed information]] about the current user as well as other users.
* Data customizers can now configure whether & how UBIK content should be [[Branch_Download#Automatic_Download|automatically downloaded]] to the clients.
* Users can now [[XAML#CaptureMediaCommand|record audios and videos]] (in addition to photos) as {{UBIK}} documents.
* Search for content by scanning RFID tags (except iOS).
* Objects can now be unlocked in the new [[Optical_code#Unlock_mode|unlock mode]] without involving the search UI (result list or auto navigating to the objects).
* Fixed an issue where the app crashed on some iOS devices when loading annotated PDF documents.
* Fixed an issue where the app crashed on some iOS devices when selecting PDF annotations.
* Fixed an issue where edited content sometimes ended up in the wrong filtered lists.
* Fixed an issue where edited content list items changed their positions in the lists.

== Known issues ==
* Branch download might be paused if the device goes into sleep mode without a power source attached and will only resume if the device screen is unlocked again. We are aware of this issue and will improve it in the future versions.
* When editing the value of a double property in landscape mode characters other then numbers are not displayed but still remain in the string.
* In rare cases, a query page appears blank without list content after navigating back from another query page. In such cases, a workaround is to reopen it or pull the list area to refresh.
* [https://www.syncfusion.com/support/directtrac/incidents/301168 A memory leak] in general page navigation is present in this release and will be addressed soon in a patch.
* In rare cases, selection of PDF annotations might misbehave on iOS.

= XAML changes =

No major changes.

<headertabs />

[[Category:Client|Version 1.2 Xamarin]]
[[Category:Version 1.2|Version 1.2 Xamarin]]
[[Category:Xamarin|Version 1.2 Xamarin]]

Version 3.8 (WinX)

2021-07-20T09:03:35Z

CWU:

= Release Notes =

== Version 3.8.?? (2021-06-??) ==
* Fixed an occasional crash when the property list gets reloaded (ListToBindableVectorAdapter.EnsureIndexInt32 exceptions).
* Fixed an issue where the content creation button might be incorrectly disabled after the context object gets edited.
* Multi line drawings are now supported in UBIKPdfViewer

== Version 3.8.42 (2021-05-25/2021-06-30) {{key press|Store Beta}}/{{key press|Store}} ==
* The auto branch download feature is now disabled by default and can be enabled in the Content settings.
* Supports the scanning of color inverted 2D codes. It is an option that can be turned on/off in the Camera settings.

== Version 3.8.38 (2021-05-18) {{key press|DevOps}} ==
* PDFViewer now supports multi language use.
* PDFViewer now supports customizable toolbar/button color.
* Fixed issues where text highlight/underline/strike-through did not work in PDFViewer.

== Version 3.8.36 (2021-04-23) {{key press|Store}} ==
=== Feature highlight ===
* The client can now receive [[Login_View#Login_details|detailed information]] about the current user as well as other users.
* Users can now [[XAML#CaptureMediaCommand|record audios]] (in addition to videos and photos) as {{UBIK}} documents.
* Data customizers can now configure whether & how UBIK content should be [[Branch_Download#Automatic_Download|automatically downloaded]] to the clients.
* The DeviceID is now unique and independent of network hardware changes.
* Profile settings are now automatically saved when users leave the settings page.
* UBIKDetailsQueryArea is now fully customizable.
* Added basic [[Time_Zone_Support_(Client)|time zone support]].
* Re-implemented the annotation feature to unify it with the upcoming platform releases on Android and iOS
** On PDFs, an annotation can be edited as long as it's not merged into the document, but only by the user who created it
* The [[XAML#UBIKImageEditor|UBIKImageEditor]] provides the possibility to customize the following in XAML.
** The visibility of the image toolbar;
** Whether annotations should be saved separately in the annotation properties or "burnt into" the original images.
* The CreateChildItemCommand now supports specifying the owner (by its UID) under which the object should be created.
* Added a thumbnail indicator and a more helpful text header in the document flip view.
* Made the client aware of map overlays even when they are not a part of the infrastructure.
* Supports [[AR-Marker#Grouped_AR_Marker|grouping of AR markers]] (like for geo POIs) to overcome the limitation of the maximum 1024 unique Aruco markers.
* ContentViewModel.PropertyItems can now be filtered using the ListCollectionView.

=== Bugfixes ===
* Fixed an issue where the geo editor misbehaved for newly created objects (or those without original server values).
* Fixed an issue where changes to geo property values were lost in offline/manual mode.
* Fixed an issue where scanning did not work when the search box is customized away from the login page.
* Fixed an issue where the bottom menu item for creating child items stopped working.
* Fixed an issue where the POIs are sometimes not shown (when navigating from the map page to the POI page).
* Fixed an issue where content list items sometimes stopped responding to user interactions after content updates.
* Empty signatures can now not be confirmed anymore.
* Fixed an issue where single content updates did not cause the XAML filters to re-evaluate, resulting in content in filtered lists where it didn't belong.
* Fixed an issue, where the HotSpotClassification was needed to annotate an object.
* After entering/exiting a POI group, the correct Geo POIs are now displayed.
* Fixed some issues that prevented certain members from being displayed in the type browser of the developer mode.
* Fixed an issue where scanning might not work under certain circumstances (namely when the default search box is customized away from the login page).
* Fixed a bug where mass editing did not correctly apply its initial selection on all items.
* Fixed an issue where newly created document files could not be played until they are saved.
* Fixed missing commits if committing many objects at once.
* Fixed an issue where the first child document is not loaded when you navigate to a details page.
* Fixed an issue where the app freezes for seconds when displaying a large list of [[UBIK_WinX_Client_Basics#Properties_with_value_records|property values records]].
* Fixed missing previous/next buttons in the document flipview when a URL/linked document is presented.
* The profile browser now displays the path of the subfolders relative to the root folder for better readability.
* Fixed an issue where redlining didn't work when configured to navigate to the created documents upon finishing.
* Fixed an issue where root & infrastructure objects were not updated after users switch online manually and the app detects new meta definitions.
* Fixed an issue where the app might repeatedly update meta definitions and other data until users confirm the warning dialog about outdated meta definitions.
* Fixed an issue where it's not possible to enter/exit POI groups/buildings in the POI page.
* Fixed an issue where property lists become empty after multiple updates (in quick succession) on the same content.
* Fixed an issue where the app displayed no error message when failing to contact the content service right after login.
* Fixed an issue where the app displayed wrong versions of document files in certain cases (e.g. when apps such as OneDrive are syncing the pictures folder).
* Fixed an issue where the root page and the settings page displayed the wrong headers.
* Fixed an issue where the app gets stuck during offline logins when there are open/unprocessed pushes.
* Fixed an issue where Aruco POIs are not displayed when they are referenced by marker objects but are not marker objects themselves (without [[SYSCLS_ARMARKER]]).
* Fixed an issue where profiles are duplicated when their <Name> tags don't match their file names or when they are placed under sub folders.
* Fixed an issue where the setting to use Geo locations from scanned results is not persisted/restored.

== Known issues ==
* Sometimes, list items might stop responding to clicks after online content updates. A refresh/reopening of the page solves the problem.
* Project specific resources defined in UBIKThemes might not take effect immediately after switching profiles. Restarting the app solves the problem.
* If a device has multiple cameras of exactly the same model (e.g. Microsoft HD 3000), the wrong one might be used during remote support calls.
* The AR Marker related features are resource intense and can cause the app to slow down on weaker tablets.
* Sometimes after an external bluetooth RFID scanner is disconnected, the app still incorrectly recognizes it as available.
<br />

= XAML Notes =

== UBIKMediaPlayerElement ==
This control is introduced to replace the old MediaElement we used for playing video/audio files. Because the old one had an issue that newly created document files can not be played until they are saved.
If this issue is relevant, you should update those XAML files that use MediaElement. See below.

<tabs>
<tab name="New">
<source lang = "xml">
<Grid xmlns:controls="using:UBIK.WinX.Controls">
<controls:UBIKMediaPlayerElement
...
SourceExt="{Binding DocumentViewModel.LocalURI}" />
</Grid>
</source>
</tab>
<tab name="Old">
<source lang = "xml">
<Grid>
<MediaElement
...
Source="{Binding DocumentViewModel.LocalURI}" />
</Grid>
</source>
</tab>
</tabs>

If this issue is irrelevant or does not bother your users, you can skip updating the XAMLs since the old MediaElement still works for the most part.

<headertabs />

{{Category/Version2|{{PAGENAME}}}}

[[Category:Client|Version 3.8 (WinX)]]
[[Category:Version 3.8|Version 3.8 (WinX)]]
[[Category:WinX|Version 3.8 (WinX)]]

Version 1.2 (Xamarin)

2021-07-20T09:03:18Z

CWU:

= Release Notes =

== Release ==

=== 1.2.?? on 2021-??-?? ===
* XAML customizers can now specify expressions for [[Property_Based_Content_Filters#UpdatePropertyFiltersCommand|property based filtering]].
* Disabled Android app data backup for UBIK due to customer concerns on security.
* Multi line drawings are now supported in UBIKPdfViewer

=== 1.2.42 on 2021-07-20 {{key press|Android: Store}} {{key press|iOS: App Center}} {{key press|UWP: App Center}} ===
* Enabled the color styling of the app/navigation bar.
* Fixed an issue where the content creation button might be incorrectly disabled after the context object gets edited.
* Fixed an issue where sharing of .xamlx and .profile files with UBIK didn't work anymore (iOS).
* Added preview versions of new customizing behaviors and actions {{key press|Preview}}
** EventChangedBehavior
** DataChangedBehavior
** InvokeCommandAction
** InvokeMethodAction
** SetPropertyAction
** ScaleAction
** RotateAction
** TranslateAction
** FadeAction
* Annotations are now correctly reverted, when triggering revert in offline mode.
* Multi line drawings are now supported in PDF annotations (UBIKPdfViewer).

=== 1.2.29 on 2021-05-31 {{key press|Android: Store}} {{key press|iOS: Store}} {{key press|UWP: App Center}} ===
* This is the same version as the 1.2.29 beta.

== Beta ==

=== 1.2.29 on 2021-05-21 {{key press|Android: Store Beta}} {{key press|iOS: App Center}} {{key press|UWP: App Center}} ===
* The auto branch download feature is now disabled by default and can be enabled in the settings.
* Supports the scanning of color inverted 2D codes. It is an option that can be turned on/off in the AR settings.

=== 1.2.28 on 2021-05-07 {{key press|Android: Store Beta}} {{key press|iOS: App Center}} ===
* Fixed the broken iOS packages in 1.2.23 and 1.2.24.
* Fixed the orientations of photos taken in the app (iOS).
* Search for content by scanning RFID tags (now also on iOS).

=== 1.2.23/24 on 2021-05-06 {{key press|iOS: App Center}} ===
* '''There is an installation issue of the iOS app due to an updated Apple account configuration. We apologize for the confusion caused and please skip these two versions.'''

=== 1.2.22 on 2021-05-06 {{key press|Android: Store Beta}} {{key press|iOS: App Center}} {{key press|UWP: App Center}} ===
* Added a button in the settings to open the Readme document.
* Profile specific XAML customizings are now supported.

=== 1.2.18 on 2021-05-03 {{key press|Android: Store Beta}} {{key press|iOS: App Center}} {{key press|UWP: App Center}} ===
* Fixed the orientations of photos taken in the app (except iOS).

=== 1.2.17 on 2021-04-29 {{key press|Android: Store Beta}} {{key press|iOS: App Center}} {{key press|UWP: App Center}} ===
* Removed the preview toast upon app startup since we are in beta now.

== Preview ==

=== 1.2.15 on 2021-04-28 {{key press|Android: App Center}} {{key press|iOS: App Center}} {{key press|UWP: App Center}} ===
* The property based content filtering can now receive criterion values from the [[Property_Based_Content_Filters#UpdatePropertyFiltersCommand|UpdatePropertyFiltersCommand]] and can be use in setups with more complex bindings.
* The Device ID now stays constant when network hardware changes.
* The client can now receive [[Login_View#Login_details|detailed information]] about the current user as well as other users.
* Data customizers can now configure whether & how UBIK content should be [[Branch_Download#Automatic_Download|automatically downloaded]] to the clients.
* Users can now [[XAML#CaptureMediaCommand|record audios and videos]] (in addition to photos) as {{UBIK}} documents.
* Search for content by scanning RFID tags (except iOS).
* Objects can now be unlocked in the new [[Optical_code#Unlock_mode|unlock mode]] without involving the search UI (result list or auto navigating to the objects).
* Fixed an issue where the app crashed on some iOS devices when loading annotated PDF documents.
* Fixed an issue where the app crashed on some iOS devices when selecting PDF annotations.
* Fixed an issue where edited content sometimes ended up in the wrong filtered lists.
* Fixed an issue where edited content list items changed their positions in the lists.

== Known issues ==
* Branch download might be paused if the device goes into sleep mode without a power source attached and will only resume if the device screen is unlocked again. We are aware of this issue and will improve it in the future versions.
* When editing the value of a double property in landscape mode characters other then numbers are not displayed but still remain in the string.
* In rare cases, a query page appears blank without list content after navigating back from another query page. In such cases, a workaround is to reopen it or pull the list area to refresh.
* [https://www.syncfusion.com/support/directtrac/incidents/301168 A memory leak] in general page navigation is present in this release and will be addressed soon in a patch.
* In rare cases, selection of PDF annotations might misbehave on iOS.

= XAML changes =

No major changes.

<headertabs />

[[Category:Client|Version 1.2 Xamarin]]
[[Category:Version 1.2|Version 1.2 Xamarin]]
[[Category:Xamarin|Version 1.2 Xamarin]]

XAML

2021-05-19T11:32:46Z

CWU:

The WinX User Interface can be vastly customized using XAML. Starting with Version 3.2, this customizing experience can be largely controlled with the new [[Developer Mode]].

== Templates ==
The UI is controlled by several predefined XAML templates which are loaded into the App at startup. There is a set of default template deployed with the App at installation, however, each of them can be overridden by placing the respective file in the folder [AppInstallPath]\''LocalState\XAML''
For further information see ''[[ UBIK Templates]]''.

=== General ===
* [[UBIKThemes.xaml]]
Controls the overall styling and behavior of the App, like standard Brushes (Colors) and Fonts.

==== AuthenticationPage ====
[[File:AuthenticationPage.PNG|thumb|AuthenticationPage]]
* [[UBIKSplashArea.xaml]]
* UBIKPageNavigation.xaml -> Deprecated and changed to UBIKHomePageButtons.xaml {{Version/WinXSince|3.0.0}}
* UBIKProfileItem.xaml
{{clear}}

=== Content Pages ===
* UBIKObjectIcon.xaml
* UBIKObjectIconSmall.xaml

==== RootPage ====
[[File:MainPage.PNG|thumb|RootPage]]
* UBIKMainLeftArea.xaml
* UBIKMainItem.xaml
* UBIKMainItemSmall.xaml
{{clear}}

==== ChildPage ====
[[File:ChildPageNew.PNG|thumb|ChildPage]]
* UBIKChildItem.xaml
* UBIKChildItemSmall.xaml
* UBIKChildArea.xaml
* UBIKChildAreaSmall.xaml
* UBIKChildAction.xaml
* UBIKPriorityPropertyItem.xaml
{{clear}}

==== DetailsPage ====
* UBIKDocumentItem.xaml
* UBIKDocumentItemSmall.xaml

== Specific {{UBIK}} Controls ==
=== Basic ===
==== CoolGridSplitter (UBIK.WinX.Controls) ====
Allows to make rows or columns of a grid user-resizable

Example:
<source lang = "xml">
<uc:CoolGridSplitter
x:Name="ChildAreaGridSplitter"
Height="10"
HorizontalAlignment="Center" VerticalAlignment="Bottom"
Background="Transparent"
Foreground="White"
ResizeBehavior="CurrentAndNext" ResizeDirection2="Rows"/>
</source>

==== UBIKImageEditor ====
<tabs>
<tab name="UWP">
It's essentially the [https://help.syncfusion.com/uwp/image-editor/overview SfImageEditor] from Syncfusion. Theoretically, customizability mentioned in their official documentations should be supported in {{UBIK}} out of the box.
One example is to customize the visibility of the toolbar of such an image editor. The following example hides the toolbar.
<source lang = "xml">
xmlns:ctrls="using:UBIK.WinX.UI.Controls"
<ctrls:UBIKImageEditor ...
xmlns:sfImageEditor="using:Syncfusion.UI.Xaml.ImageEditor">
<sfImageEditor:SfImageEditor.ToolbarSettings>
<sfImageEditor:ToolbarSettings IsToolbarVisiblity="False"/>
</sfImageEditor:SfImageEditor.ToolbarSettings>
</ctrls:UBIKImageEditor>
</source>
</tab>

<tab name="Xamarin">
It's essentially the [https://help.syncfusion.com/xamarin/image-editor/overview SfImageEditor] from Syncfusion. Theoretically, customizability mentioned in their official documentations should be supported in {{UBIK}} out of the box.
One example is to customize the visibility of the toolbar of such an image editor. The following example hides the toolbar.
<source lang = "xml">
xmlns:ctrls="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL"
<ctrls:UBIKImageEditor ...
xmlns:sfImageEditor="clr-namespace:Syncfusion.SfImageEditor.XForms;assembly=Syncfusion.SfImageEditor.XForms">
<sfImageEditor:SfImageEditor.ToolbarSettings>
<sfImageEditor:ToolbarSettings IsVisible="false" />
</sfImageEditor:SfImageEditor.ToolbarSettings>
</ctrls:UBIKImageEditor>
</source>
</tab>
</tabs>

The MergeAnnotationsOnSave property allows to configure whether annotations should be shared through the {{UBIK}} property from the respective Annotation classification (''false'', default), or if they should be merged directly into the original file (''true''): {{Version/WinXSince|3.8.0}} {{Version/XamarinSince|1.2.0}}
<source lang = "xml">
<ctrls:UBIKImageEditor MergeAnnotationsOnSave="true" 
...
</ctrls:UBIKImageEditor>
</source>

==== UBIKPdfViewer ====
<tabs>
<tab name="UWP">
* The Top-Toolbar can be customized by setting: UBIKAppBarBackgroundThemeBrush
* The Annotation-Toolbar can be customized by setting: UBIKPdfAnnotationToolbarBackgroundThemeBrush
* The color of the buttons in the toolbar is defined by: UBIKAppBarButtonForegroundThemeBrush
* The Save / Annotation Buttons can be hidden with SaveButtonVisibility="Collapsed" and AnnotationButtonVisibility="Collapsed" in XAML
</tab>
</tabs>

=== Advanced ===
==== [[EvalExpression]] ====
Allows to evaluate a C# expression in XAML, using any amount of [[EvalExpression#Parameters|EvalExpressionParameters]]

== Converters ==
These are classes in our code used to convert one form of data into another (For example: string to color, bool to string, color to string…). We are using it often on Data Bindings, so we can simply ‘change’ the data that got provided by the model. Mostly, in our environment, we use the Converters for the Visibility Property, Background Property or the Source Property (converting Byte to an Image).

Initialization of a converter in a XAML file:
<source lang = "xml"> <converters:ItemCountLesserThanToVisibilityConverter
x:Key="ItemCountLesserThanToColConverter"
EqualOrBiggerThan="Visible"
LesserThan="Collapsed" />

</source>
<br>
Using the ItemCountLesserThanToVisiblity in a visibility attribute:
<source lang = "xml"> <Visibility="{Binding Source={StaticResource RootListFilter}, Path=Count, Converter={StaticResource ItemCountLesserThanToColConverter }, ConverterParameter=13, FallbackValue=Collapsed}"/>

</source>
<br>
Example of an EqualToVisConverter being used in order to set the visibility of a grid:
<source lang = "xml"> <Grid Visibility="{Binding Values [MP_SCOPECHANGE], Converter={StaticResource EqualToVisConverter}, ConverterParameter=30}">
</Grid>

</source>
<br>
Example of a StringFormatConverter, which converts a value into a string and also accepts a parameter, in this case the GlobalDateTimeFormat, which ‘tells’ the converter how to format the string:
<source lang = "xml"> <TextBlock Grid.Row="1" Text="{Binding Values [MP_LATE_START_MATAP], Converter={StaticResource StringFormatConverter}, ConverterParameter={StaticResource GlobalDateTimeFormat} }"/>
</source>

=== List of all converters ===
For a complete and up-to-date list of all converters, please refer to the [[Developer_Mode#Browsing_the_ViewModel.2FContext|developer mode]].

=== Advanced ===
* [[StringFormatConverter]]
Returns a formatted string where placeholders will be filled with values supplied to its parameter properties (''Param0, Param1, Param2'').

Example:
<source lang = "xml">
<StackPanel Orientation="Horizontal">
<StackPanel.Resources>

<converters:StringFormatConverter x:Key="URIConverter" Param0="{Binding ElementName=SkypeQuery, Path=QueryText}" />
</StackPanel.Resources>

<SearchBox
x:Name="SkypeQuery"
Width="240" Height="40"
FontSize="18"
PlaceholderText="Call Skype">
<Interactivity:Interaction.Behaviors>
<Core:EventTriggerBehavior EventName="QuerySubmitted">
<Core:InvokeCommandAction
Command="{Binding NavigateToURICommand}"
CommandParameter="{Binding ElementName=SkypeQuery, Path=QueryText, Converter={StaticResource URIConverter},
ConverterParameter=skype\:\{0\}\?call }" />
</Core:EventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</SearchBox>
</StackPanel>
</source>

* [[EvalExpressionConverter]]
Evaluates a C# expression with 3 optional variables (''Param0, Param1, Param2'') and returns the result. The object fed into the converter can be referenced in the expression as ''Context''.

Example:
<source lang = "xml">
<Grid>
<Grid.Resources>

<converters:EvalExpressionConverter x:Key="CodeConverter" Context="{Binding}" Param0="{Binding ElementName=ChildListView, Path=Name}" />
</Grid.Resources>
<StackPanel Orientation="Horizontal">

<TextBox
x:Name="CodeQuery"
MinWidth="240" Height="40"
FontSize="18"
PlaceholderText="Expression">
</TextBox>

<TextBlock Text="{Binding ElementName=CodeQuery, Path=Text, Converter={StaticResource CodeConverter}}" />
</StackPanel>
</Grid>
</source>

* [[CollectionToViewConverter]]
Outdated and replaced by the [[XAML_Changes_in_UBIK_WinX_3.5#Filtering_by_expressions|ListCollectionView]].

* [[ChildItemTemplateSelectorSuffixConverter]]
Converts a template selector to use templates with a certain suffix (e.g. "_Grid" to use "UBIKChildItem_Grid.xaml" instead of "UBIKChildItem.xaml"). The small template file name will be combined as <TemplateName><Suffix>Small.xaml (e.g. "UBIKChildItem_GridSmall.xaml").

Example:
<source lang = "xml">
<Grid>
<Grid.Resources>

<tpl:ChildItemTemplateSelector x:Key="ChildItemTemplateSelector" />
<tpl:ChildItemTemplateSmallSelector x:Key="ChildItemTemplateSmallSelector" />
<converters:ChildItemTemplateSelectorSuffixConverter x:Key="ChildItemTemplateSelectorSuffixConv" TemplateSelector="{Binding Source={StaticResource ChildItemTemplateSelector}}" TemplateSmallSelector="{Binding Source={StaticResource ChildItemTemplateSmallSelector}}"/>
</Grid.Resources>


<StackPanel>
<CheckBox Grid.Column="0">
<Interactivity:Interaction.Behaviors>
<Core:EventTriggerBehavior EventName="Checked">

<Core:InvokeCommandAction Command="{Binding StoreProfileParameterCommand}" CommandParameter="ChildItemsViewMode=_Grid"/>
</Core:EventTriggerBehavior>
<Core:EventTriggerBehavior EventName="Unchecked">
<Core:InvokeCommandAction Command="{Binding StoreProfileParameterCommand}" CommandParameter="ChildItemsViewMode=_List"/>
</Core:EventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</CheckBox>
<ListView
x:Name="ChildListView"
HorizontalContentAlignment="Stretch"
ItemTemplateSelector="{Binding Path=StoredProfileParameters[ChildItemsViewMode], Converter={StaticResource ChildItemTemplateSelectorSuffixConv}, ConverterParameter=Normal, FallbackValue=List}"
ItemsPanel="{StaticResource ChildPageItemsPanelTemplate}"
ItemsSource="{Binding Children.Items}"
ScrollViewer.VerticalScrollBarVisibility="Auto" SelectionMode="None">
<ListView.ItemContainerStyle>
<Style TargetType="ListViewItem">
<Setter Property="HorizontalContentAlignment" Value="Stretch" />
<Setter Property="Padding" Value="0" />
<Setter Property="Margin" Value="0,0,16,0" />
</Style>
</ListView.ItemContainerStyle>
<ListView.ItemContainerTransitions>
<TransitionCollection>
<EntranceThemeTransition FromHorizontalOffset="400" />
</TransitionCollection>
</ListView.ItemContainerTransitions>
</ListView>
</StackPanel>
</Grid>
</source>

== Properties ==
{{Hint|The previously listed available properties for binding is removed from here. Since it's more accurate and up-to-date to use the [[Developer Mode]] to inspect them in your version of the clients.}}

== Commands ==
{{Hint|The previously listed available commands for binding is removed from here. Since it's more accurate and up-to-date to use the [[Developer Mode]] to inspect them in your version of the clients.}}

=== Examples for commands with complex parameters ===

==== CaptureMediaCommand ====
<tabs>
<tab name="UWP">
<source lang = "xml">
<Button
...
xmlns:controls="using:UBIK.WinX.Controls"
Command="{Binding CaptureMediaCommand}">
<Button.CommandParameter>
<controls:KeyValueList>
<controls:KeyValueParameter Key="MediaCaptureMode" Value="Video" />
<controls:KeyValueParameter Key="ChildMetaDefUid" Value="6170a068-2314-4444-ad62-0da99769a048" />
</controls:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>

<tab name="Xamarin">
<source lang = "xml">
<Button
...
xmlns:classes="clr-namespace:UBIK.CPL.Classes;assembly=UBIK.CPL"
Command="{Binding CaptureMediaCommand}">
<Button.CommandParameter>
<classes:KeyValueList>
<classes:KeyValueParameter Key="MediaCaptureMode" Value="Video" />
<classes:KeyValueParameter Key="ChildMetaDefUid" Value="6170a068-2314-4444-ad62-0da99769a048" />
</classes:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>
</tabs>

{{Hint|The KeyValueList parameter is supported only {{Version/WinXSince|3.8}}{{Version/XamarinSince|1.2}}. In previous versions, simple string parameters were supported.}}
{{Attention|Whether the creation succeeds also depends on the server configuration. For example, if "*.mp4" is not included as a selective list item in the [[SYSCLS_FILEDOCUMENT|file type]] meta property, video document creation will not be possible.}}

* MediaCaptureMode: Photo, Video, Audio. Defaults to Photo if unspecified;
* ChildMetaDefUid: The Guid of the child meta definition to be used for creating the captured media document. If unspecified, the client will simply pick the first child meta definition that is of media type and is allowed under the current context/parent object.

== Differences between Xamarin and UWP ==

As you maybe already noticed we have two different clients, one is WinX UWP and the other one Xamarin, which is used to develop clients for three different platforms namely iOS, Android and new UWP (-> it doesn’t really differentiate from the previously mentioned UWP except it’s developed in a different framework which is Xamarin in this case). The customizing stays the same in case of the syntax, but there are some differences in the naming of controls and attributes. Unfortunately, there is no decent documentation of these differences, but the Microsoft documentation and in general the internet can support you when searching e.g. for a control in Xamarin that you used in UWP.
More specific documentations about Xamarin Customizing can be found under [[Xamarin XAML]].

== Namespace changes ==

Starting from the UBIK UWP client{{Version/WinXSince|3.0.0}}, we have restructured & renamed some of our outdated or inaccurate namespaces. This means modifications are necessary for any previous XAML customizing code that refers to these changed namespaces. The complete list of such changes is documented below.

{| class="wikitable" | width = "75%"
|-
! !!style="text-align:left;"|V.2.6!!style="text-align:left;"|V.3.0
|-
|rowspan="13" style="text-align:center;"|Name-<br/>space<br/>prefix
|''UBIK.Win8''||''UBIK.WinX''
|-
|''UBIK.WinX.UI''||''UBIK.UI''
|-
|''UBIK.WinX.Utility''||''UBIK.Utility''
|-
|''UBIK.WinX.Library''||''UBIK.Library''
|-
|''UBIK.WinX.DataProvider''||''UBIK.DataProvider''
|-
|''UBIK.WinX.SyncHandler''||''UBIK.SyncHandler''
|-
|''UBIK.WinX.DatabaseConnector''||''UBIK.DatabaseConnector''
|-
|''UBIK.WinX.ContentDatabase''||''UBIK.ContentDatabase''
|-
| ''UBIK.WinX.MRO''||''UBIK.MRO''
|-
| ''UBIK.WinX.Coding''||''UBIK.Coding''
|-
| ''UBIK.WinX.DataService''||''UBIK.DataService''
|-
| ''UBIK.WinX.Redlining''||''UBIK.Redlining''
|-
| ''UBIK.WinX.Positioning''||''UBIK.Positioning''
|-
|}

Take the namespace ''UBIK.Win8'' for example, it is now changed to ''UBIK.WinX''. A few affected XAML namespace references are e.g.
* ''using:UBIK.Win8.Views'' -> ''using:UBIK.WinX.Views''
* ''using:UBIK.Win8.GART.Controls'' -> ''using:UBIK.WinX.GART.Controls''

'''Important notes''' on the namespace ''UBIK.WinX.UI'':
* One exception is the namespace '''''UBIK.WinX.UI.CollectionView'''''. It is '''not''' changed since the content is indeed WinX specific.
* For namespaces that are changed from ''UBIK.Win8.UI'' such as '''''UBIK.Win8.UI.Controls''''', '''do not''' further '''remove the ''WinX''''' segment even though the results are something like '''''UBIK.WinX.UI.Controls'''''.

== Further information regarding XAML ==
* [[Developer Mode]] <br>
* [[Xamarin XAML]] <br>
* [[XAML Basics]] <br>
* [[XAML Best practices]]

[[Category:WinX|XAML]]
[[Category:XAML|XAML]]

Rfid

2021-05-11T08:48:11Z

CWU:

In order for the users to find objects more efficiently, one can mark {{UBIK}} objects with [[#Technical_background|certain properties]]. Whenever a user scans a RFID tag with the {{UBIK}} client, the resulting ID value can be used to find all matching objects, namely objects that have the right property.

== Introduction: RFID & NFC ==

[http://en.wikipedia.org/wiki/Near_field_communication NFC] stands for "Near Field Communication" and is a set of ideas and technologies for data transfer between devices, typically in close distances.
Technically, it is based on [http://en.wikipedia.org/wiki/Radio-frequency_identification RFID] ("Radio-Frequency Identification"), which describes specific technical solutions.

Amongst the use cases for NFC, there is communication between smartphones and other devices, but also the scanning of RFID tags.

The {{UBIK}} RFID scanning feature specifically is the ability to scan RFID tags in order to identify {{UBIK}} objects.

== Supported RFID Tags ==
The client uses NDEF (NFC Data Exchange Format) for maximum compatibilty between NFC devices, tag types, and operating systems.

== Supported Devices ==
When your client supports NFC, you can see this by opening the side menu. If NFC is supported, a button for enabling/disabling NFC is shown on the top.

== Search modes ==

{{UBIK}} provides two modes for searching objects: [[Sync Mode#Possible sync modes|online and offline]].

=== Searching offline ===

In any case (regardless of the network connection and [[Sync Mode|sync mode]]), {{UBIK}} always goes through all the objects currently available on the device and find the ones that match the scanned results.

=== Searching online ===

When the Internet is avaiable and {{UBIK}} is not running under offline mode, the search result is enhanced by online search. This means any objects that match the scanned results can be found even if they don't yet exist locally.

== Search result ==
If the device is placed near an NFC Tag (and NFC is turned on), a search is triggered automatically. The side menu will open up and show the results. If there is exactly one result, the client automatically navigates to that object, if there are more results, the user can select the object out of the list.

== Classifications ==

In order for objects to be identifiable through RFID, they have to carry the [[SYSCLS OBJECTWITHRFIDTAG]] classification.

The service query used for online searching is [[SYSCLS RFIDTAGSCANQUERY]].

{{Clear}}

== See also ==
* [[SYSCLS OBJECTWITHRFIDTAG]]
* [[SYSCLS RFIDTAGSCANQUERY]]

{{Category/Version|2.4.2}}
{{Category/Version|2.4.5}}

[[Category:2.4.1|Rfid]]
[[Category:2.4.2|Rfid]]
[[Category:2.4.5|Rfid]]
[[Category:Xamarin|Rfid]]

Category:Xamarin 1.2

2021-05-11T08:45:33Z

CWU: Created blank page

UBIK WinX Client Basics

2021-03-22T09:48:46Z

CWU: /* Fit Mode{{Version/WinXSince|3.5}} */

{{UBIK}} Client is the mobile application for viewing and modifying data, showing documents, starting navigation, visualizing POIs and much more.

Client applications are available for Android and WinX, however the features available on each of the platform dependent applications might differ. An overview of the available features can be found in the [[Client_Feature_Table|feature comparison table]].

== Login ==
Users need to login in order to access confidential data, this can be done in the [[Login View]].

=== Confirm login ===
{{Version/WinXSince|3.6}}
Certain pages might require to confirm the login data, even if the user is already logged in. This can be done in the following way: The CheckUserOfflineCommand needs to be called with the username and password as parameter, if the login was valid, the CheckUserOfflineSuccess boolean property is set to true, which causes the text "Login confirmed" to appear in the example.

<source lang = "xml">
<TextBox
x:Name="Sign01User"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}"
PlaceholderText="User"
Text="{Binding UserName}" />
<PasswordBox
x:Name="Sign01PW"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}"
PlaceholderText="Password" />
<Button
Command="{Binding CheckUserOfflineCommand}"
Content="Confirm login"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="UserName" Value="{Binding ElementName=Sign01User, Path=Text}" />
<uc:KeyValueParameter Key="Password" Value="{Binding ElementName=Sign01PW, Path=Password}" />
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
<TextBlock Text="Login confirmed" Visibility="{Binding AuthenticationViewModel.CheckUserOfflineSuccess, Source={StaticResource Locator}, FallbackValue=false, Converter={StaticResource BoolToVisConverter}}" />
</source>

== Profiles ==
Profiles are used to store connection information for {{UBIK}} services. It specifies the location where to find the service along with other useful informations. Profiles are stored by UBIK whenever the user created connection information and stored it in the settings. However, profiles can also be created and edited with any text editor. Possible settings to be defined are:
* InternalConnectionSettings: Connections settings how to connect to the Content and the USAM service that has been set up.
** Application: the [[APPLICATION]] to use with the service
** AuthenticationPort: Port Number of the authentication (USAM) service (default: 777)
** AuthenticationProtocol: Protocol of the authentication service (default: https)
** AuthenticationServer: the ip address of the authentication server
** AuthenticationService: the path to the authentication service
** ContentPort: Port Number of the content service (default: 777)
** ContentProtocol: Protocol of the content service (default: https)
** ContentServer: the ip address of the content server
** ContentService: the path to the content service
** Context: the [[CONTEXT]] to use with the service
** SyncMode: the used sync mode (Online [= Auto], Manual, Offline; default:Online)
* IsDefault: true, if the profile should be the default profile
* Name: the name of the profile (will also be used to identify the database)
** If the profile name contains invalid characters like: /, ", <, >, ... they will be replaced with %_
* Project: the project name. Use this to share a single project name with more than one profile. If the project is defined, all profile with the same project will share one database.
* Customizing: the XAML subfolder to use for customized UI. This parameter can be used to share one single XAML customizing folder for multiple profiles.
* ShowHiddenSettings: show hidden settings (feault: false)

Example:
<source lang = "xml">
<?xml version="1.0" encoding="utf-8"?>
<Profile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UBIK.WinX.Settings">
<Customizing>MYAPPLICATIONUI</Customizing>
<Description i:nil="true" />
<InternalConnectionSettings>
<Application>APP_DEMO</Application>
<AuthenticationPort>777</AuthenticationPort>
<AuthenticationProtocol>https</AuthenticationProtocol>
<AuthenticationServer>80.243.175.50</AuthenticationServer>
<AuthenticationService>UBIK/DBG/AUG/DEMO.250/USAM/USAM.svc</AuthenticationService>
<ContentPort>777</ContentPort>
<ContentProtocol>https</ContentProtocol>
<ContentServer>80.243.175.50</ContentServer>
<ContentService>UBIK/DBG/AUG/DEMO.250/CONTENT/UBIKContent.svc</ContentService>
<Context>CXT_DEMO</Context>
<SyncMode>Online</SyncMode>
</InternalConnectionSettings>
<IsDefault>true</IsDefault>
<Name>DEMO.250.AT</Name>
<Project>DEMO.250</Project>
<ShowHiddenSettings>false</ShowHiddenSettings>
</Profile>
</source>

== Content Browser ==
Allows to navigate through the entire data model in a hierarchical manner, as it is published by the server.

Initially, a list of objects ("root objects") is shown. Upon selecting an object, a new browser is opened for that object, showing details about it. When an object is selected in the content browser, it is called the browser's context. For such a contextual object, child objects and selected properties are shown. Also, there is a context menu providing actions related to the currently selected object.

=== Status Bar ===
[[File:UI_WinX_DbSavingIndicator.PNG|300 px|thumb|border|alt=Saving Symbol|Saving Symbol]]
{{Version/WinXSince|2.5.4}}Whenever content is being saved into the local database (for example, after a branch is downloaded from the server), there will be a blinking symbol indicating the saving activity is happening in the background.
During that time, the user is advised to not logout or close the app because the content might be lost otherwise. However, it is okay to undertake other tasks such as browsing, editing or downloading branches.

=== Child Page ===

[[File:ChildPage.PNG|400 px|thumb|border|alt=Child Page|Child Page]]

The child page shows the context of a selected object.

The global status bar shows the icon, the name and the description of the selected object. An arrow on the left side allows the user to navigate back to the parent object. On the right side the currently logged-in user is indicated. By clicking on the username one is able to navigate back to the home screen or log off.

The right side of the child page shows child objects of the current object. Each child object is represented by an icon, a name and a description.

On the left side of the child page the current object´s high priority properties are shown. By clicking on a live value property, the live value details dialog opens. By clicking on an editable [[UBIK_WinX_Client_Basics#High_priority_properties| high priority property]], an editor opens {{Version/WinXSince|2.5.4}}. If a property was edited a save button is shown in the lower left corner, allowing the user to commit the changes. If a property of a query object was edited an evaluate button is shown in the lower left corner, allowing the user to run the query with the changed propery.

=== Details Page ===

=== Context Menu ===

=== Objects ===

==== Root objects vs child objects ====

The first entry point in the ''Content Browser'' is the list of root objects.

==== Task objects ====

==== Query objects ====

==== Safety relevant objects ====

==== Commissioning objects ====

==== Locked objects ====

=== Properties ===

==== Live value properties ====

==== High priority properties ====
High priority properties are properities having a priority higher than the [[Settings#Content |priority threshold]].

==== Selective List Properties ====

==== Properties with value records {{Version/WinXSince|2.5.4}} ====
[[File:UI_WinX_PropertyWithValueRecords.png|thumb|A property with value records]]
[[File:UI_WinX_PropertyValueRecords.png|thumb|Property value records dialog]]
In addition to its value, a property might also bring along a series of value records showing "who changed the value at what time".

When such records exist, the property row shows a special symbol on the right side. After a right click (with mouse) or a long tap (with touch) on the property row, a dialog will be shown to present these records (sorted by their time, recent ones on top).

{{Clear}}

==== Editors ====

===== Geo Editor & Teach In =====

==== Guid editor ====
[[File:Guid_property_dialog.PNG|thumb|border|alt=Guid property editor dialog|Guid property editor dialog]]

To edit Guid properties (that do not have a selective list available), we have implemented a special system. Since a Guid property always just contains the Guid as a reference to another object, we can use a query to find the object we want to assign to this property.

When the Guid property has a FilterQuery datamember (which should contain the guid of a query), it will become editable through this query. Note that this FilterQuery guid will not actually be visible in the client. All this should be setup in the backend, the client has no control over this.

When clicking an editable Guid property, you will see a dialog with up to 3 extra buttons added (see image):

;View Object
:This button will be enabled when there is a valid guid assigned to the property. Clicking this button will immediately navigate to the referenced object.
;Edit Property
:If the property has a valid FilterQuery assigned to it, clicking this button will launch that query. If no FilterQuery is assigned, this button will be invisible.
;Clear Property Value
:If the property has a guid assigned, the user can press this button to reset the value back to empty.

Additionally, if a valid FilterQuery is assigned, the user will see the results of that query ''inline'', if the query delivers 200 results or fewer. The user can select an item from this horizontally scrollable list, and press "OK" to assign the UID of the selected object to the Guid property. This is useful for cases where the user does not want to jump into the full query to be able to select an object.

If the user does choose to launch the full query page (or if the query returns over 200 objects), they can click any of the displayed items in the query's child list. When clicking one of them, it will immediately be set as the reference in the original Guid property. To cancel selecting an item (and stop editing the property), simply navigate to any other page (by pressing back, using navigation bar, etc).

{{hint|'''Skipping the dialog'''
If editing the property in a query page without having to go through the dialog is desired, one can customize the boolean variable "SkipQueryDialog" in UBIKThemes.xaml. If none can be found, simply add the following line into its "Default" ResourceDictionary.
<source lang = "xml"><x:Boolean x:Key="SkipQueryDialog">True</x:Boolean></source>
}}

=== Documents ===
UBIK supports and displays document objects and a bunch of actions related to them (editing, redlining, creation, thumbnails, ...).

==== Fit Mode{{Version/WinXSince|3.5}} ====
By default, documents are displayed in their original dimensions. But administrators can also [[SYSCLS_DOCUMENT_FITMODE|configure different fit modes]] for each document. The following demonstrates how documents can look under different fit modes.

{| class="wikitable" | width = "100%" style="text-align: center;"
|-
! Unspecified / Unscaled / Default !! Fit to container !! Fit to width !! Fit to height
|-
| [[File:UI_WinX_FitMode_Unspecified_Small.png|240x225px]] || [[File:UI_WinX_FitMode_Container_Small.png|240x225px]] || [[File:UI_WinX_FitMode_Width_Small.png|240x225px]] || [[File:UI_WinX_FitMode_Height_Small.png|240x225px]]
|-
| [[File:UI_WinX_FitMode_Unspecified_Large.png|240x225px]] || [[File:UI_WinX_FitMode_Container_Large.png|240x225px]] || [[File:UI_WinX_FitMode_Width_Large.png|240x225px]] || [[File:UI_WinX_FitMode_Height_Large.png|240x225px]]
|}

{{Attention|When using a FlipView for documents in your customized XAMLs, you need to additionally [[XAML_Tips#Fit_mode|apply the fit mode]] by yourself. }}
{{Attention|This feature currently only works for PDFs (it is not supported for Images). }}
{{Hint|Double tapping on a document toggles the display between "Fit to width" and the fit mode that document is configured with.}}

[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

==== Customizing Possibilities ====

==== Editing{{Version/WinXSince|2.5.4}} ====
[[File:UI_WinX_EditDocumentButton.png|thumb|Button to edit a document]]
For [[SYSCLS_EDITABLEDOCUMENT|editable documents]], there is an {{key press|edit}} button in the bottom app bar. It allows the user to edit a document file using the default app of the OS. If a file is changed during the edit, the same {{key press|save}} button appears just like it does for content with changed properties.
{{Hint|Similar to saving, other app features also apply on edited documents. For example, reverting local changes for an edited document will throw away the changed document file and restore it to the server version.}}
[[File:UI_WinX_EditDocumentOverlayButton.png|thumb|Edit button in thumbnail overlay]]
An alternative way to start editing is to right click on a document's thumbnail, which brings up an overlay of buttons, and then select the {{key press|edit}} button. The difference here is that there is no {{key press|save}} button and any changes are automatically saved (and committed if in online mode).
{{Clear}}

==== Offline availability ====
When a user selects a branch to bring offline, files of all document objects underneath are downloaded in principle. However, they can also be selectively configured to be ignored with a [[SYSCLS_OFFLINE_AVAILABLE_DOCUMENT|classification]] on the server-side. Once a document is classified as offline available, the document file will not be removed when the storage for already synchronized document files is cleared.
{{Hint|This is not to be confused with the accessibility related to [[User_Rights|user rights]]. The logic here is "some documents '''do not have to''' be downloaded", not "some documents '''can not''' be downloaded/accessed". In other words, a user can browse to and open the document regardless of this configuration.}}

==== Clear Online Documents ====
By clearing the online documents, it is possible to free up system memory if needed. It can be triggered by pressing the button "Clear online documents" in the general settings tab. Online documents are documents already uploaded to the server. They can be downloaded anytime agian when the client is connected to the server. However, documents classified as offline available will not be affected and will always stay on the device.

== AR Features ==

=== POI View ===
Brings up the POI View|Augmented Reality view and displays Points of Interest (POI's) related to the current location of the mobile device.

=== Markerless ===

=== Map View ===
Opens the Map View and displays Points of Interest (POI's) related to the current location of the mobile device.

== Positioning ==
{{UBIK}} clients use a [[Location_Manager|Location Manager]] in order to gain knowledge about their position, so it can help the user navigate to his/her target.

The user can choose one of different positioning modes optimized for different environments.
Most of them incorporate multiple technologies for calculating positions or checking their reliability.

=== Positioning modes ===

* ''Use all'' - uses all available position sources
* ''LLA only mode'' - used for positioning using markers only
* ''Beacon Proximity mode'' - uses iBeacon proximity and LLA only

=== Technologies ===

==== GPS ====
GPS is used as a primary positioning input source for outdoor areas. Its precision depends on the environment and satellite availability. With good circumstances, the accuracy varies between 1 and 10 meters.

==== LLA markers ====
LLA markers basically are QR codes with location data encoded into them - which can be used for positioning when they are scanned.

==== Object Proximity Positioning ====
The location of nearby Geo-Objects can be used for positioning.

The position of a Geo-Object can be used manually by pushing the button {{key press|Use Location}} in the [[UBIK_WinX_Client_Basics#Context_Menu|Context Menu]].

The geo information of an object gets used automatically if exactly one single object is found through scanning. If more objects are found, their geo information doesn´t get used. Scanning includes [[UBIK Client Basics#Bar Code|Bar Code]], [[UBIK Client Basics#QR Code|QR Code]], [[UBIK Client Basics#OCR|OCR]] and [[UBIK Client Basics#RFID|RFID]]. The automatic use of Geo-Object´s location can be turned off by disabling the "EnableObjectProximityPositioning" setting.

==== Beacon-Proximity Positioning ====
The Beacon Proximity Mode detects if the user is in the proximity of a beacon. The proximity region is defined by a proximity distance which creates a sphere around the beacon. Whenever the calculated distance to a beacon is smaller than the proximity distance, the user is supposed to be at the position of the beacon. If multiple regions intersect the user is supposed to be at the position of the nearest beacon.
In order to use Beacon Proximity as a Positioning System, Bluetooth Low Energy has to be available and enabled on the mobile device. If a new environment should be equipped with iBeacon-Positioning, an expert has to mount iBeacons on known positions and calibrate the propagation factor of these beacons. Proximity beacons can be configured using [[SYSCLS_PROXIMITY_BEACON]]. {{Version/WinXSince|UWP}}

== Finding Objects ==
=== Free Text Search ===

=== ID Marker ===

=== QR Code ===

=== Bar Code ===

=== RFID Code ===
Provides a fast and convenient way for users to find objects that are identifiable through [[RFID tags|RFID tags]].

=== OCR ===

== Linked objects ==
{{Version/WinXSince|3.6}}
It is possible to display values of linked objects by using the "LinkedLevel" property. An example can be seen here, where Items[0] is a Guid property linking to another object. The ItemsControl then binds to the Properties of the linked object.

<source lang = "xml">
<Grid DataContext="{Binding Properties.Items[0].LinkedLevel}">
<ItemsControl ItemsSource="{Binding Properties.AllItems}" />
</Grid>
</source>

[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

== See also ==
* [[Client_Feature_Table]]

[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

Rfid

2021-02-23T10:59:24Z

CWU: /* Search result */

In order for the users to find objects more efficiently, one can mark {{UBIK}} objects with [[#Technical_background|certain properties]]. Whenever a user scans a RFID tag with the {{UBIK}} client, the resulting ID value can be used to find all matching objects, namely objects that have the right property.

== Introduction: RFID & NFC ==

[http://en.wikipedia.org/wiki/Near_field_communication NFC] stands for "Near Field Communication" and is a set of ideas and technologies for data transfer between devices, typically in close distances.
Technically, it is based on [http://en.wikipedia.org/wiki/Radio-frequency_identification RFID] ("Radio-Frequency Identification"), which describes specific technical solutions.

Amongst the use cases for NFC, there is communication between smartphones and other devices, but also the scanning of RFID tags.

The {{UBIK}} RFID scanning feature specifically is the ability to scan RFID tags in order to identify {{UBIK}} objects.

== Supported RFID Tags ==
The client uses NDEF (NFC Data Exchange Format) for maximum compatibilty between NFC devices, tag types, and operating systems.

== Supported Devices ==
When your client supports NFC, you can see this by opening the side menu. If NFC is supported, a button for enabling/disabling NFC is shown on the top.

== Search modes ==

{{UBIK}} provides two modes for searching objects: [[Sync Mode#Possible sync modes|online and offline]].

=== Searching offline ===

In any case (regardless of the network connection and [[Sync Mode|sync mode]]), {{UBIK}} always goes through all the objects currently available on the device and find the ones that match the scanned results.

=== Searching online ===

When the Internet is avaiable and {{UBIK}} is not running under offline mode, the search result is enhanced by online search. This means any objects that match the scanned results can be found even if they don't yet exist locally.

== Search result ==
If the device is placed near an NFC Tag (and NFC is turned on), a search is triggered automatically. The side menu will open up and show the results. If there is exactly one result, the client automatically navigates to that object, if there are more results, the user can select the object out of the list.

[[Category:2.4.1|Rfid]]
[[Category:2.4.2|Rfid]]
[[Category:2.4.5|Rfid]]

== Classifications ==

In order for objects to be identifiable through RFID, they have to carry the [[SYSCLS OBJECTWITHRFIDTAG]] classification.

The service query used for online searching is [[SYSCLS RFIDTAGSCANQUERY]].

{{Clear}}

== See also ==
* [[SYSCLS OBJECTWITHRFIDTAG]]
* [[SYSCLS RFIDTAGSCANQUERY]]

{{Category/Version|2.4.2}}
{{Category/Version|2.4.5}}

[[Category:2.4.1|Rfid]]
[[Category:2.4.2|Rfid]]
[[Category:2.4.5|Rfid]]

Rfid

2021-02-23T10:50:52Z

CWU:

In order for the users to find objects more efficiently, one can mark {{UBIK}} objects with [[#Technical_background|certain properties]]. Whenever a user scans a RFID tag with the {{UBIK}} client, the resulting ID value can be used to find all matching objects, namely objects that have the right property.

== Introduction: RFID & NFC ==

[http://en.wikipedia.org/wiki/Near_field_communication NFC] stands for "Near Field Communication" and is a set of ideas and technologies for data transfer between devices, typically in close distances.
Technically, it is based on [http://en.wikipedia.org/wiki/Radio-frequency_identification RFID] ("Radio-Frequency Identification"), which describes specific technical solutions.

Amongst the use cases for NFC, there is communication between smartphones and other devices, but also the scanning of RFID tags.

The {{UBIK}} RFID scanning feature specifically is the ability to scan RFID tags in order to identify {{UBIK}} objects.

== Supported RFID Tags ==
The client uses NDEF (NFC Data Exchange Format) for maximum compatibilty between NFC devices, tag types, and operating systems.

== Supported Devices ==
When your client supports NFC, you can see this by opening the side menu. If NFC is supported, a button for enabling/disabling NFC is shown on the top.

== Search modes ==

{{UBIK}} provides two modes for searching objects: [[Sync Mode#Possible sync modes|online and offline]].

=== Searching offline ===

In any case (regardless of the network connection and [[Sync Mode|sync mode]]), {{UBIK}} always goes through all the objects currently available on the device and find the ones that match the scanned results.

=== Searching online ===

When the Internet is avaiable and {{UBIK}} is not running under offline mode, the search result is enhanced by online search. This means any objects that match the scanned results can be found even if they don't yet exist locally.

== Search result ==
If the phone is placed near an NFC Tag, a search is triggered automatically. The side menu will open up and show the results. If there is exactly one result, the client automatically navigates to that object, if there are more results, the user can select the object out of the list.

== Classifications ==

In order for objects to be identifiable through RFID, they have to carry the [[SYSCLS OBJECTWITHRFIDTAG]] classification.

The service query used for online searching is [[SYSCLS RFIDTAGSCANQUERY]].

{{Clear}}

== See also ==
* [[SYSCLS OBJECTWITHRFIDTAG]]
* [[SYSCLS RFIDTAGSCANQUERY]]

{{Category/Version|2.4.2}}
{{Category/Version|2.4.5}}

[[Category:2.4.1|Rfid]]
[[Category:2.4.2|Rfid]]
[[Category:2.4.5|Rfid]]

AddChildCommand

2021-02-08T06:54:26Z

CWU: Created page with "Opens a file selection dialog, to add documents under the current object.In the standard case this command does not need any parameters. If the dialog should allow multi file..."

Opens a file selection dialog, to add documents under the current object.In the standard case this command does not need any parameters. If the dialog should allow multi file selection, the command should be used as follows:

<source lang = "xml">
<ToolbarItem
Name="MenuAdd"
Command="{Binding AddChildCommand}"
Text="Add">
<ToolbarItem.CommandParameter>
<classes:KeyValueList>
<classes:KeyValueParameter Key="MultipleChildItems" Value="true" />
</classes:KeyValueList>
</ToolbarItem.CommandParameter>
</ToolbarItem>
</source>

Version 1.1 (Xamarin)

2020-12-10T09:36:41Z

CWU:

= Release Notes =

== Releases ==

=== 1.1.xx ===
* Implemented Scan-to-input for String properties

=== 1.1.85 on 2020-12-03 ===
* It's now possible to use the UBIKContentView with a explicitly specified custom template (its "Content").

=== 1.1.84 on 2020-11-24 ===
* Fixed an issue where buttons (triggering commands) might be enabled/disabled incorrectly when navigating back to a page.

=== 1.1.83 on 2020-11-19 {{key press|store version}} ===
* Fixed an issue where XAML based filtering doesn't work for changed items.
* Fixed memory leaks caused by images and glyphs

=== 1.1.81 on 2020-11-18 ===
* Fixed an issue where root objects were loaded from the server on every navigation step.
* Fixed an issue where added PDF annotations could not be removed or edited anymore.

=== 1.1.80 on 2020-11-17 ===
* Fixed an issue where a page refresh triggered by property based list filtering causes the app to pause (as if stuck at the previous page).
* Fixed a crash related to list views on iOS.

=== 1.1.78 on 2020-11-16 {{key press|store version}} ===
* Fixed a performance issue when navigating.
* Fixed a crash on some devices when navigating away from a PDF page.

=== 1.1.76 on 2020-11-12 {{key press|store version}} ===
* Fixed an issue where query results are sometimes not displayed in a Guid editor when it’s first opened.
* Fixed bug that caused cascaded work packages to not update their status properly when navigating back.
* Improved infrastructure document Files download behaviour.

== Previews ==

=== 1.1.64 on 2020-10-16 ===
* Updated some app icons.
* Added a hamburger button and a back button to full screen pages where the navigation/title bar is not available (POI, map, scan).
* Made the client aware of map overlays even when they are not a part of the infrastructure.
* Fixed an issue where old routing arrows from previous sessions were incorrectly displayed.
* Fixed an issue where list items sometimes changed their appearing positions and caused strange UI issues (e.g. unclickable, outdated texts, etc.).
* Fixed a bug where the app would not navigate back after creating a new Object.
* Fixed an issue where documents created offline are not uploaded after a restart or a new login.
* Fixed an issue where archived UI customizings were not properly unpacked.
* Fixed an issue where the delete option in the context menu didn't always work.
* The swipe gesture is now disabled when looking at documents so that panning/zooming is not conflicted.
* Ensured that every device can enter a decimal separator in a numeric field.
* Updated some localized text resources.
* Improved the speed of loading profiles & XAML resources.
* Fixed a crash when opening the settings page on iOS14.
* Fixed an issue where pulling the list didn't refresh query results.
* Fixed an issue where resetting query criteria didn't update the result list.
* Fixed an issue where the app didn't navigate to tapped query results.
* Fixed an issue where items stopped responding to tapping after back navigations from queries.

=== 1.1.62 on 2020-09-22 ===
* Fixed a potential crash when going to the settings page upon app startup.
* Fixed an issue where the app didn’t navigate to newly created objects for property editing.

=== 1.1.61 on 2020-09-22 ===
* Fixed an app hanging issue during login on iOS14.
* Updated localized resources.
* Fixed an issue where file picking stopped working on Android X.

=== 1.1.59 on 2020-09-18 ===
* Added basic [[Time_Zone_Support_(Client)|time zone support]].
* Added a teach in button in the Geo property editor to easily use the device location as input.
* Redesigned the in-app PDF annotation feature to support basic traceability.
* Fixed a bug, that caused the property editing to fail in certain situations.
* Fixed misaligned POIs when scanning OCR codes.
* Reduced the memory pressure of the app when scanning is active.
* The map now supports displaying of shape files.

=== 1.1.45 on 2020-06-26 ===
* Supports grouping of AR markers (like for geo POI's) to overcome the limitation of the maximum 1024 unique Aruco markers.
* Initial implementation of the basic map feature using MapsUI (instead of Syncfusion).
* Fixed an issue where AR items (e.g. POIs, map pins) are not correctly updated after switching POI groups.

=== 1.1.41 on 2020-05-04 ===
* Improved the AR routing feature;
* Fixed some issues in the AR views caused by the different screen densities;
* Fixed some flickering issues in the AR views;
* Fixed an issue where the chosen resolution is too high and leads to a poor performance and heavy stuttering in the AR views.
=== 1.1.36 on 2020-04-03 ===
* Fixed an issue where the geo POI's are horizontally mirrored when compared to their real world positions.
=== 1.1.35 on 2020-04-03 ===
* Basic Aruco Marker implementation (Landscape mode only)
* Basic AR Navigation implementation (Route from the Demo plant only)
=== 1.1.9 on 2020-02-06 ===
* Added scroll views in the settings page so that all entries are accessible on smaller devices.
* Added some missing Spanish and Portuguese translations.
* Enabled annotating/redlining for PDF's and images.
=== 1.1.8 on 2019-12-03 ===
* Fixed a bug where importing of XAML customizings from zip files didn't work anymore.
=== 1.1.7 on 2019-11-27 ===
* Enabled QR- and OCR-based POIs.
* Fixed Geo-POIs for portrait and landscape orientations.
=== 1.1.6 on 2019-11-14 ===
* Added OCR scanning in ScanPage and POI Page.
* Added first set of Geo AR and Maps features in POI page.

== Known issues ==
* Branch download might be paused if the device goes into sleep mode without a power source attached and will only resume if the device screen is unlocked again. We are aware of this issue and will improve it in the future versions.
* When editing the value of a double property in landscape mode characters other then numbers are not displayed but still remain in the string.
* In rare cases, a query page appears blank without list content after navigating back from another query page. In such cases, a workaround is to reopen it or pull the list area to refresh.
* [https://www.syncfusion.com/support/directtrac/incidents/301168 A memory leak] in general page navigation is present in this release and will be addressed soon in a patch.

= XAML changes =

== Chlld list item tap behavior ==
Previously, the tap behavior to navigate to child items is included by default in the <code>ContentListView</code> style definition. Due to technical reasons, that is no longer the case.

If you have customized certain templates before and they contain child lists, it's now necessary to enable the navigation behavior like the following.

<source lang = "xml">
<DataTemplate ...
xmlns:behaviors="clr-namespace:UBIK.CPL.Behaviors;assembly=UBIK.CPL"
xmlns:controls="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL">
...
<controls:SfListViewExt ...
ItemsSource="{Binding Children.Items}"
Style="{DynamicResource ContentListView}">
<controls:SfListViewExt.Behaviors>
<behaviors:EventToCommandBehavior
Command="{Binding NavigateToChildrenCommand}"
Converter="{StaticResource ItemTappedEventArgsToViewModelConverter}"
EventName="ItemTapped" />
</controls:SfListViewExt.Behaviors>
</controls:SfListViewExt>
</DataTemplate>
</source>

== Editor templates ==
Previously, the property editor templates (of different types) did not include certain parts such as the header and the generic confirm/reset/cancel buttons.

Starting from this version, you can customize the entire editor area (top app bar aside) in these templates.

<headertabs />

[[Category:Client|Version 1.1 Xamarin]]
[[Category:Version 1.1|Version 1.1 Xamarin]]
[[Category:Xamarin|Version 1.1 Xamarin]]

EditPropertyValueCommand

2020-12-10T06:59:41Z

CWU: Created page with "== EditPropertyValueCommand == This command is used to open a dialog for editing a property. == Command Properties == * ID: String. The ID of the property to be edited. * Sca..."

== EditPropertyValueCommand ==
This command is used to open a dialog for editing a property.

== Command Properties ==
* ID: String. The ID of the property to be edited.
* ScanToInput: bool. If this is false (default) a textbox for editing is shown. If true, a scan dialog appears, that allows to scan a barcode.

Example:
<source lang = "xml">
<Button Command="{Binding EditPropertyValueCommand}" Text="ScanToEdit">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="ID" Value="TEXT_READWRITE" />
<uc:KeyValueParameter Key="ScanToInput" Value="true" />
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
</source>

Version 3.7 (WinX)

2020-11-11T13:11:01Z

CWU: /* Build History */

= Initial Release =

=== New features ===
* The UBIK client can now automatically use UI customizings deployed from the server. Details can be found [[Deploy_UI_Customizings_(Client)|here]].

=== Enhancements ===
* [[SYSCLS_UNLOCK_GROUP_BY_SCAN|Unlock group by scan]] feature no longer locks items that don't have an UNLOCK_CODE set.

=== Bugfixes ===
* Fixed a memory leak issue when viewing 3D models in the app.
* Fixed an issue where created content is not automatically committed if the navigation is skipped.
* Fixed an issue where unwanted values are assigned during the data/template replications.
* Fixed the not working template selection button in the default XAML template.

=== Known issues ===
* Project specific resources defined in UBIKThemes might not take effect immediately after switching profiles. Restarting the app solves the problem.
* If a device has multiple cameras of exactly the same model (e.g. Microsoft HD 3000), the wrong one might be used during remote support calls.
* The AR Marker related features are resource intense and can cause the app to slow down on weaker tablets.
* Sometimes after an external bluetooth RFID scanner is disconnected, the app still incorrectly recognizes it as available.
* It's not possible to interact with an online document in a flip view. This will be fixed in the next build. Until then, a workaround is to customize the default UBIKDetailsArea template. Find the one and only Canvas control in it and change its Visibility property value to <code>"{Binding DataContext.HotSpotViewModel.DocumentScanMode, ElementName=ChildFlipView, Converter={StaticResource BoolToVisConverter}, FallbackValue=Collapsed}"</code>
<br />

= Build History =
* 3.7.3 on 2020-03-27
** Initial release.
* 3.7.6 on 2020-04-16
** Improved the precision of remembered list view scroll positions and fixe an issue where it sometimes stops working.
* 3.7.10 on 2020-06-30
** Fixed an issue where AR items (e.g. POIs, map pins) are not correctly updated after switching POI groups.
** Fixed an issue where scanning sometimes does not work until toggling the scan switches.
** Fixed an issue where live values are sometimes not received on the clients (when the live value attributes are configured as null).
** Fixed an issue where users could not swipe across documents in the gallery/flipview using gestures.
** Fixed an issue where documents in the gallery/flipview was contantly moving slightly up and down.
* 3.7.11 on 2020-07-02
** RootPage is now fully customizable via UBIKRootArea.xml.
* 3.7.13 on 2020-07-07 {{key press|Internal on DevOps}}
** Fixed an issue where sometimes tapping on Aruco POIs is not recognized.
** Fixed a crash caused by a XAML compatibility issue (introduced in the last build for the "fully customizable UBIKRootArea").
* 3.7.14 on 2020-07-29
** Fixed an issue where the client sometimes fails to unpack server deployed UI customizings. See [[Deploy UI Customizings (Client)#Known_Issues| known issues]].
* 3.7.15 on 2020-07-30 {{key press|Internal on DevOps}}
** Fixed an issue where online/linked documents in the gallery/flipview were not usable.
* 3.7.16 on 2020-09-23 {{key press|Internal on DevOps}}
** Fixed an issue where the geo editor misbehaved for newly created objects (or those without original server values).
** Fixed an issue where changes to geo property values were lost in offline/manual mode (after a restart of the app).
*3.7.x on xxx {{key press|Internal on DevOps}}
** Added CreateChildItemsCommand, to support uploading of multiple documents at once.

<headertabs />

{{Category/Version2|{{PAGENAME}}}}

[[Category:Client|Version 3.7 (WinX)]]
[[Category:Version 3.7|Version 3.7 (WinX)]]
[[Category:WinX|Version 3.7 (WinX)]]

XAML Tips

2020-11-11T12:58:32Z

CWU: /* Content creation */

== Functionality related ==

=== Attachable behaviors ===
It's quite often that you need to attach behaviors to certain XAML elements. For example, on a Grid, you want to attach a behavior which executes a command upon a Tapped event, or you want to execute a command when a certain property on a UBIK object changes.

Notice that in the following examples, "Interactivity" and "Core" are both namespaces and you have to make sure that they are defined at the root of your XAMLs:

<source lang = "xml">
<DataTemplate
...
xmlns:Core="using:Microsoft.Xaml.Interactions.Core"
xmlns:Interactivity="using:Microsoft.Xaml.Interactivity">
...
</DataTemplate>
</source>

==== Event Triggered ====
With an EventTriggerBehavior, you can react on changes/events of UI Elements:

<source lang = "xml">
<Grid>
<Interactivity:Interaction.Behaviors>
<Core:EventTriggerBehavior EventName="Tapped">
<Core:InvokeCommandAction Command="{Binding NavigateToChildrenCommand}" />
</Core:EventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</source>

==== Data Triggered ====
If you want to react on changes of the underlying data (ViewModel), you can use DataTriggerBehavior instead. The following example, when used in the ''UBIKSplashArea'' template, automatically navigates to the root objects once the login process is finished and the user was successfully authenticated:

<source lang = "xml">
<Grid>
<Interactivity:Interaction.Behaviors>
<Core:DataTriggerBehavior Binding="{Binding IsLoggedIn}" Value="True">
<Core:InvokeCommandAction Command="{Binding NavigateToRootPageCommand}" />
</Core:DataTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</source>

=== Fit mode ===
If you are using the standard app without XAML customizings, the [[UBIK_WinX_Client_Basics#Fit_Mode|fit mode]] feature should work out of the box.
However, when using a FlipView for displaying documents in your customized XAMLs, you must make sure to include the following binding to the FlipView's ItemTemplate so that the fit modes are properly applied.

<source lang = "xml">
<DataTemplate
...
xmlns:hs="using:UBIK.WinX.HotSpotting.Document">
...
<Grid.Resources>
...
<DataTemplate x:Key="FlipDocItemTemplate">
...
<hs:Document
...
FitMode="{Binding DocumentViewModel.FitMode}" />
</DataTemplate>
</Grid.Resources>
</DataTemplate>
</source>

=== Content creation ===
{{Version/WinXSince|3.5.5}}
To directly create an object on a child of the current object, you can define a Button as follows. The method "Item.IsTypeCreationAllowed" used in the expression gets the uid of the type that should be created below a child, if a child does not allow the creation of that type underneath it, the child will be hidden in the selection dialog. To actually create the object, the "CreateChildItemCommand" needs to be passed a KeyValueList with two parameters: The Parent-key is the UID or the ContentViewModel of the child underneath the object should be created, the Type-key is the type of object which should be created--this should match the uid passed to the "Item.IsTypeCreationAllowed" method.

<source lang = "xml">
xmlns:uc="using:UBIK.WinX.Controls"
xmlns:cv="using:UBIK.WinX.UI.CollectionView"
</source>

<source lang = "xml">
<x:String x:Key="PlantMap">Item.IsTypeCreationAllowed("21fc990a-d064-4bee-8d48-3293351f827a")</x:String>
<cv:ListCollectionView x:Key="PlantMapView" Expression="{StaticResource PlantMap}" ItemsSource="{Binding Children.Items}" />

<AppBarButton>
<AppBarButton.Flyout>
<Flyout Placement="Full">
<ListView ItemsSource="{Binding Source={StaticResource PlantMapView}}">
<ListView.ItemTemplate>
<DataTemplate>
<Button Content="{Binding Header}" Command="{Binding CreateChildItemCommand}" x:Name="CreateButton" Tag="{Binding}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Parent" Value="6D733909-1742-4110-8619-237849BFE453"/>
<uc:KeyValueParameter Key="Type" Value="21fc990a-d064-4bee-8d48-3293351f827a"/>
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</Flyout>
</AppBarButton.Flyout>
</AppBarButton>
</source>

<source lang = "xml">
<x:String x:Key="PlantMap">Item.IsTypeCreationAllowed("21fc990a-d064-4bee-8d48-3293351f827a")</x:String>
<cv:ListCollectionView x:Key="PlantMapView" Expression="{StaticResource PlantMap}" ItemsSource="{Binding Children.Items}" />

<AppBarButton>
<AppBarButton.Flyout>
<Flyout Placement="Full">
<ListView ItemsSource="{Binding Source={StaticResource PlantMapView}}">
<ListView.ItemTemplate>
<DataTemplate>
<Button Content="{Binding Header}" Command="{Binding CreateChildItemCommand}" x:Name="CreateButton" Tag="{Binding}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Parent" Value="{Binding Tag, ElementName=CreateButton}"/>
<uc:KeyValueParameter Key="Type" Value="21fc990a-d064-4bee-8d48-3293351f827a"/>
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</Flyout>
</AppBarButton.Flyout>
</AppBarButton>
</source>

<br/>
Additionally, the following optional parameters can be added as well.
* CreateOnly (optional, defaults to false): When set to true, the client will not automatically navigate to the created content, rather automatically save and commit it. If set to true, this overrides the following parameters;
* AutoNavigate (optional, defaults to true): When set to false, the client will not automatically navigate to the created content;
* AutoCommit (optional, defaults to false): When set to true, the change(s) will be saved to the local cache and the database, and then committed to the server.

=== Creating multiple documents ===
To upload multiple documents at once, the CreateChildItemsCommand can be used. The AutoNavigate will always be set to false (does not need to be specified) and the AutoCommit will always be set to true (also does not need to be specified).

<source lang = "xml">
<Button
Command="{Binding CreateChildItemsCommand}"
Content="Create multiple documents">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Type" Value="6170a068-2314-4444-ad62-0da99769a048" />
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
</source>

[[Category:Client|XAML Tips]]
[[Category:WinX|XAML Tips]]

=== Disable FilloutCriteria ===
{{Version/WinXSince|3.5}}
To enable/disable the automatic filtering of a query based on the ParentObject, there is the possibility to specify EnableFillOutCriteria--if it is not set, it defaults to false. Additionaly "SkipDialog" can be set to true, to not display a dialog.

<source lang="xml">
<Grid x:Name="selectionGrid" Tag="{Binding MetaUID}">
<Interactivity:Interaction.Behaviors>
<Core:EventTriggerBehavior EventName="Tapped">
<Core:InvokeCommandAction Command="{Binding ElementName=ChildAreaGrid, Path=DataContext.AddTemplatableDataCommand}" >
<Core:InvokeCommandAction.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Uid" Value="{Binding Tag,ElementName=selectionGrid}"/>
<uc:KeyValueParameter Key="EnableFillOutCriteria" Value="false"/>
<uc:KeyValueParameter Key="SkipDialog" Value="false"/>
</uc:KeyValueList>
</Core:InvokeCommandAction.CommandParameter>
</Core:InvokeCommandAction>
</Core:EventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</source>

=== Hotspotting ===
{{Attention|To use a binding in the KeyValueParameter, it has to be applied like in the example provided here: [[KeyValueList]]}}
The hotspotting command is used for hotspotting as well as for annotating, to configure the button for hotspotting, the commandparameter "Mode" should be set to "HotSpotting", for annotating the "Mode" should be "Annotate". The parameter commit is optional, if set to true, the changes get automatically persisted when leaving the editing mode.

<source lang = "xml">
<AppBarToggleButton
IsChecked="{Binding EditingAnnotation, Mode=TwoWay}"
IsEnabled="{Binding IsAnnotatable}"
Command="{Binding HotSpottingCommand}">
<AppBarToggleButton.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Mode" Value="Annotate"/>
<uc:KeyValueParameter Key="Commit" Value="true"/>
</uc:KeyValueList>
</AppBarToggleButton.CommandParameter>
</AppBarToggleButton>
</source>

=== Remember scroll positions of list views ===

==== Version 3.7 & later {{Version/WinXSince|3.7}} ====
Starting from this version,
* The precision of scroll position remembering is improved(by pixel offsets instead of by items);
* It also works for other scrollable lists (instead of just for content object lists).
<br />
To enable this feature, you should make sure the following.
* The SelectionBoundListView is used instead of the standard ListView. Its {{UBIK}} namespace is <code>UBIK.WinX.Controls</code>;
* The SelectionBoundListView's <code>RememberScrollPosition</code> property is not set to "false"; (It's "true" by default.)
* The SelectionBoundListView's <code>x:Name</code> property value is unique.

==== Version 3.6 {{Version/WinXSince|3.6}} ====
The UBIK-Client does include a function to remember the position in a list (ListView) when navigating away from it. This function is only available when the list (ListView) has a unique name as a property (x:Name). When browsing back to the previously visited list UBIK scrolls back to the last position. The function does not save scroll positions over different sessions.
Implementing the function to remember the scroll position in a ListView one has to consider that the list elements (Children) could depend on a other UI-element. If the list elements do depend on a other UI-elemente, this element has to be created above the ListView in the XAML.

<source lang = "xml">
<DataTemplate xmlns:behaviors="using:UBIK.WinX.Behaviors" xmlns:uc="using:UBIK.WinX.Controls">
...
<uc:SelectionBoundListView x:Name="ChildListView">
<Interactivity:Interaction.Behaviors>
<behaviors:FirstVisibleItemPersistenceBehavior FirstVisibleItems="{Binding ScrollItems}" />
</Interactivity:Interaction.Behaviors>
</uc:SelectionBoundListView>
</DataTemplate>
</source>

=== MultiBinding {{Version/WinXSince|3.6}} ===
Very often we want to display some UI elements (e.g. a Grid) depending on whether multiple criteria are met. It's much easier to achieve this by using a MultiBindingBehavior like the following.
<source lang = "xml">
<DataTemplate
xmlns:Interactivity="using:Microsoft.Xaml.Interactivity"
xmlns:behaviors="using:UBIK.WinX.Behaviors">
...
<Grid>
<Interactivity:Interaction.Behaviors>
<behaviors:MultiBindingBehavior Converter="{StaticResource VisLogicAndConverter}" PropertyName="Visibility">
<behaviors:MultiBindingItem Value="{Binding MassEditViewModel, Converter={StaticResource NullToVisConverter}}" />
<behaviors:MultiBindingItem Value="{Binding Documents.Items.Count, Converter={StaticResource ItemCountToVisConverter}}" />
</behaviors:MultiBindingBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</DataTemplate>
</source>
The behavior makes sure the container Grid is set to Visibile only if the mass editing mode is not turned on (MassEditViewModel is null) and the context object has child document(s) (Documents.Items.Count is greater than 0. You can combine any number of binding results (MultiBindingItem) using the VisLogicAndConverter (the name should be self explanatory).

=== InvokeOnItemsCommand {{Version/WinXSince|3.6}} ===
Available on all ListViewModels, this command allows executing a specified command on a collection of list items. It can be used in combination with features such as [[Mass_Edit_(UBIK_WinX)|mass editing]] and [[XAML_Changes_in_UBIK_WinX_3.5#After_3.5|expression based collection filtering]]. Examples for both combinations are provided below.

{{Attention|The command specified through the "Command" parameter is executed on list items and, therefore, must be available in the list item contexts (view models). If in doubt, the [[Developer_Mode|developer mode]] can be used to inspect if a command is available in a certain context.}}

{{Hint|Parameter "Command" and "SelectedItemsOnly" are specific to the InvokeOnItemsCommand. What other parameters to define or whether to define them at all depends on the type of command to be executed on the items.}}

==== Invoke on selected items ====
{{Attention|To use a binding in the KeyValueParameter, it has to be applied like in the example provided here: [[KeyValueList]]}}
This example demonstrates how you can use the mass editing feature to select certain objects from the child list and then execute the SetPropertyValueCommand for those selected.
* The example code assumes that the child objects have an editable property called "VALUE" and tries to set 50 as their value;
* You should insert the following code snippet into the default UBIKChildArea template;
* If the parameter "SelectedItemsOnly" is missed or set to "False", the command will be executed on all child items;
* To enable selection, click on the "Mass Edit" button below the property list.
<br />
<source lang = "xml">
<AppBarButton
xmlns:example="using:UBIK.WinX.Controls"
Command="{Binding Children.InvokeOnItemsCommand}"
Icon="AllApps"
Label="Set to 50%"
Style="{ThemeResource UBIKActionAppBarButton}">
<AppBarButton.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="Command" Value="SetPropertyValueCommand" />
<example:KeyValueParameter Key="SelectedItemsOnly" Value="True" />
<example:KeyValueParameter Key="PropertyName" Value="VALUE" />
<example:KeyValueParameter Key="PropertyValue" Value="50" />
</example:KeyValueList>
</AppBarButton.CommandParameter>
</AppBarButton>
</source>

==== Invoke on filtered results ====

{{Attention|To use a binding in the KeyValueParameter, it has to be applied like in the example provided here: [[KeyValueList]]}}

First, you need to setup a filtered list (ListCollectionView) in the Resources section of a UI element (e.g. Grid).
* This list is only available/visible within that UI element (the Grid in this case);
* The ItemsSource uses Children.Items. Use the [[Developer_Mode|developer mode]] if necessary to find out if this is available where you intend to define the list;
* The example expression filters for any items that don't contain the text "EXAMPLE" in their Title texts. You can filter differently by altering the expression.
<br />
<source lang = "xml">
<Grid xmlns:CV="using:UBIK.WinX.UI.CollectionView">
<Grid.Resources>
<CV:ListCollectionView
x:Key="Filtered"
Expression="!Item.Title.Contains("EXAMPLE")"
ItemsSource="{Binding Children.Items}" />
</Grid.Resources>
...
</Grid>
</source>
<br />
With the filtered list configured, you can then insert the following code snippet to execute the SetPropertyValueCommand for the filtered result items.
* The example code assumes that the child objects have an editable property called "VALUE" and tries to set 50 as their value;
* The "Filtered" refers to the ListCollectionView configured above.
<br />
<source lang = "xml">
<AppBarButton
xmlns:example="using:UBIK.WinX.Controls"
Command="{Binding Source={StaticResource Filtered}, Path=ListViewModel.InvokeOnItemsCommand}"
Icon="AllApps"
Label="Set to 50"
Style="{ThemeResource UBIKActionAppBarButton}">
<AppBarButton.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="Command" Value="SetPropertyValueCommand" />
<example:KeyValueParameter Key="PropertyName" Value="VALUE" />
<example:KeyValueParameter Key="PropertyValue" Value="50" />
</example:KeyValueList>
</AppBarButton.CommandParameter>
</AppBarButton>
</source>

==== Support for old styled commands ====
Some old commands might not support KeyValueLists as parameters. In that case, just define the parameter value under the "CommandParameter" key, e.g.
<br />
<source lang = "xml"><example:KeyValueParameter Key="CommandParameter" Value="some string value for example" /></source>.
This single value is then passed as the command parameter instead of the entire KeyValueList.

=== SetPropertyValueCommand {{Version/WinXSince|3.6}} ===
{{Attention|To use a binding in the KeyValueParameter, it has to be applied like in the example provided here: [[KeyValueList]]}}

This command existed before but was implemented differently. In the newer version(s), it is improved to provide customizers more control over the things that happen during/after the property value changes.
The available commnad parameters are:
* PropertyName: the name of the property to set a new value to;
* PropertyValue: the value to be set to the above mentioned property;
* OnlyForUnvalidated (optional, defaults to false): When set to true, the value will only be set if the property is not yet validated;
* AutoSave (optional, defaults to false): When set to true, the change(s) will be saved to the local cache and database;
* AutoCommit (optional, defaults to false): When set to true, the change(s) will be committed to the server.

{{Hint|There's no way to commit changes without saving them locally first. Therefore, the "AutoSave" parameter will be ignored when "AutoCommit" is set to true.}}

Here's an example of the command usage. It tries to set the property called "VALUE" to a double value 50 regardless of its current state and then automatically save and commit the change.
<br />
<source lang = "xml">
<AppBarButton
xmlns:example="using:UBIK.WinX.Controls"
Command="{Binding SetPropertyValueCommand}"
Icon="Edit"
Label="Set to 50%"
Style="{ThemeResource UBIKActionAppBarButton}">
<AppBarButton.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="PropertyName" Value="VALUE" />
<example:KeyValueParameter Key="PropertyValue">
<example:KeyValueParameter.Value>
<x:Double>50</x:Double>
</example:KeyValueParameter.Value>
</example:KeyValueParameter>
<example:KeyValueParameter Key="OnlyForUnvalidated" Value="false" />
<example:KeyValueParameter Key="AutoSave" Value="true" />
<example:KeyValueParameter Key="AutoCommit" Value="true" />
</example:KeyValueList>
</AppBarButton.CommandParameter>
</AppBarButton>
</source>

{{Hint|It is advised to provide typed values like <nowiki><x:Double>50</x:Double></nowiki>. But for simple types, you can try writing them in the text format like <nowiki><example:KeyValueParameter Key="PropertyValue" Value="50" /></nowiki> and {{UBIK}} will try to find the right type.}}

=== DisplayViewCommand ===
This command can be used to [[Custom_View_(Client)|display cutom views]].

== Performance related ==

=== FlipView ===
When using the FlipView control in your XAML code, it's better to enable [https://docs.microsoft.com/en-us/windows/uwp/debug-test-perf/optimize-gridview-and-listview#ui-virtualization UI virtualization]. The difference in performance gets more obvious as the number of items in the FlipView increases. Here's how to enable it.

<source lang = "xml">
<FlipView
...
VirtualizingStackPanel.VirtualizationMode="Standard">
<Flipview.ItemsPanel>
<ItemsPanelTemplate>
<VirtualizingStackPanel Orientation="Horizontal" />
</ItemsPanelTemplate>
</Flipview.ItemsPanel>
</FlipView>
</source>

VirtualizingStackPanel.VirtualizationMode offers two possibilities: Standard & Recycling. In case you are interested, here are their [https://docs.microsoft.com/en-us/dotnet/api/system.windows.controls.virtualizationmode?view=netframework-4.7.2 differences].

[[Category:Client|XAML Tips]]
[[Category:WinX|XAML Tips]]

XAML

2020-11-11T12:53:49Z

CWU: /* Commands */

The WinX User Interface can be vastly customized using XAML. Starting with Version 3.2, this customizing experience can be largely controlled with the new [[Developer Mode]].

== Templates ==
The UI is controlled by several predefined XAML templates which are loaded into the App at startup. There is a set of default template deployed with the App at installation, however, each of them can be overridden by placing the respective file in the folder [AppInstallPath]\''LocalState\XAML''
For further information see ''[[ UBIK Templates]]''.

=== General ===
* [[UBIKThemes.xaml]]
Controls the overall styling and behavior of the App, like standard Brushes (Colors) and Fonts.

==== AuthenticationPage ====
[[File:AuthenticationPage.PNG|thumb|AuthenticationPage]]
* [[UBIKSplashArea.xaml]]
* UBIKPageNavigation.xaml -> Deprecated and changed to UBIKHomePageButtons.xaml {{Version/WinXSince|3.0.0}}
* UBIKProfileItem.xaml
{{clear}}

=== Content Pages ===
* UBIKObjectIcon.xaml
* UBIKObjectIconSmall.xaml

==== RootPage ====
[[File:MainPage.PNG|thumb|RootPage]]
* UBIKMainLeftArea.xaml
* UBIKMainItem.xaml
* UBIKMainItemSmall.xaml
{{clear}}

==== ChildPage ====
[[File:ChildPageNew.PNG|thumb|ChildPage]]
* UBIKChildItem.xaml
* UBIKChildItemSmall.xaml
* UBIKChildArea.xaml
* UBIKChildAreaSmall.xaml
* UBIKChildAction.xaml
* UBIKPriorityPropertyItem.xaml
{{clear}}

==== DetailsPage ====
* UBIKDocumentItem.xaml
* UBIKDocumentItemSmall.xaml

== Specific {{UBIK}} Controls ==
=== Basic ===
* CoolGridSplitter (UBIK.WinX.Controls)
Allows to make rows or columns of a grid user-resizable

Example:
<source lang = "xml">
<uc:CoolGridSplitter
x:Name="ChildAreaGridSplitter"
Height="10"
HorizontalAlignment="Center" VerticalAlignment="Bottom"
Background="Transparent"
Foreground="White"
ResizeBehavior="CurrentAndNext" ResizeDirection2="Rows"/>
</source>

=== Advanced ===
* [[EvalExpression]]
Allows to evaluate a C# expression in XAML, using any amount of [[EvalExpression#Parameters|EvalExpressionParameters]]

== Converters ==
These are classes in our code used to convert one form of data into another (For example: string to color, bool to string, color to string…). We are using it often on Data Bindings, so we can simply ‘change’ the data that got provided by the model. Mostly, in our environment, we use the Converters for the Visibility Property, Background Property or the Source Property (converting Byte to an Image).

Initialization of a converter in a XAML file:
<source lang = "xml"> <converters:ItemCountLesserThanToVisibilityConverter
x:Key="ItemCountLesserThanToColConverter"
EqualOrBiggerThan="Visible"
LesserThan="Collapsed" />

</source>
<br>
Using the ItemCountLesserThanToVisiblity in a visibility attribute:
<source lang = "xml"> <Visibility="{Binding Source={StaticResource RootListFilter}, Path=Count, Converter={StaticResource ItemCountLesserThanToColConverter }, ConverterParameter=13, FallbackValue=Collapsed}"/>

</source>
<br>
Example of an EqualToVisConverter being used in order to set the visibility of a grid:
<source lang = "xml"> <Grid Visibility="{Binding Values [MP_SCOPECHANGE], Converter={StaticResource EqualToVisConverter}, ConverterParameter=30}">
</Grid>

</source>
<br>
Example of a StringFormatConverter, which converts a value into a string and also accepts a parameter, in this case the GlobalDateTimeFormat, which ‘tells’ the converter how to format the string:
<source lang = "xml"> <TextBlock Grid.Row="1" Text="{Binding Values [MP_LATE_START_MATAP], Converter={StaticResource StringFormatConverter}, ConverterParameter={StaticResource GlobalDateTimeFormat} }"/>
</source>

=== List of all converters ===
For a complete and up-to-date list of all converters, please refer to the [[Developer_Mode#Browsing_the_ViewModel.2FContext|developer mode]].

[[Category:WinX|XAML]]

=== Advanced ===
* [[StringFormatConverter]]
Returns a formatted string where placeholders will be filled with values supplied to its parameter properties (''Param0, Param1, Param2'').

Example:
<source lang = "xml">
<StackPanel Orientation="Horizontal">
<StackPanel.Resources>

<converters:StringFormatConverter x:Key="URIConverter" Param0="{Binding ElementName=SkypeQuery, Path=QueryText}" />
</StackPanel.Resources>

<SearchBox
x:Name="SkypeQuery"
Width="240" Height="40"
FontSize="18"
PlaceholderText="Call Skype">
<Interactivity:Interaction.Behaviors>
<Core:EventTriggerBehavior EventName="QuerySubmitted">
<Core:InvokeCommandAction
Command="{Binding NavigateToURICommand}"
CommandParameter="{Binding ElementName=SkypeQuery, Path=QueryText, Converter={StaticResource URIConverter},
ConverterParameter=skype\:\{0\}\?call }" />
</Core:EventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</SearchBox>
</StackPanel>
</source>

* [[EvalExpressionConverter]]
Evaluates a C# expression with 3 optional variables (''Param0, Param1, Param2'') and returns the result. The object fed into the converter can be referenced in the expression as ''Context''.

Example:
<source lang = "xml">
<Grid>
<Grid.Resources>

<converters:EvalExpressionConverter x:Key="CodeConverter" Context="{Binding}" Param0="{Binding ElementName=ChildListView, Path=Name}" />
</Grid.Resources>
<StackPanel Orientation="Horizontal">

<TextBox
x:Name="CodeQuery"
MinWidth="240" Height="40"
FontSize="18"
PlaceholderText="Expression">
</TextBox>

<TextBlock Text="{Binding ElementName=CodeQuery, Path=Text, Converter={StaticResource CodeConverter}}" />
</StackPanel>
</Grid>
</source>

* [[CollectionToViewConverter]]
Converts a collection into a view that can be filtered using C# expressions and returns the (filtered) result. The object fed into the converter can be referenced in the expression as ''Item''.

Example:
<source lang = "xml">
<Grid>
<Grid.Resources>

<converters:CollectionToViewConverter x:Key="ColConv" Source="{Binding Children.Items}" />
</Grid.Resources>
<StackPanel Orientation="Horizontal">

<TextBox
x:Name="FilterQuery"
Height="40" MinWidth="240"
Margin="0,10,10,0" HorizontalAlignment="Right"
VerticalAlignment="Top"
FontSize="18"
PlaceholderText="Filter" />

<ListView
x:Name="ChildListView"
HorizontalContentAlignment="Stretch"
ItemsSource="{Binding ElementName=FilterQuery, Path=Text, Converter={StaticResource ColConv}}">
</ListView>
</StackPanel>
</Grid>
</source>

* [[ChildItemTemplateSelectorSuffixConverter]]
Converts a template selector to use templates with a certain suffix (e.g. "_Grid" to use "UBIKChildItem_Grid.xaml" instead of "UBIKChildItem.xaml"). The small template file name will be combined as <TemplateName><Suffix>Small.xaml (e.g. "UBIKChildItem_GridSmall.xaml").

Example:
<source lang = "xml">
<Grid>
<Grid.Resources>

<tpl:ChildItemTemplateSelector x:Key="ChildItemTemplateSelector" />
<tpl:ChildItemTemplateSmallSelector x:Key="ChildItemTemplateSmallSelector" />
<converters:ChildItemTemplateSelectorSuffixConverter x:Key="ChildItemTemplateSelectorSuffixConv" TemplateSelector="{Binding Source={StaticResource ChildItemTemplateSelector}}" TemplateSmallSelector="{Binding Source={StaticResource ChildItemTemplateSmallSelector}}"/>
</Grid.Resources>


<StackPanel>
<CheckBox Grid.Column="0">
<Interactivity:Interaction.Behaviors>
<Core:EventTriggerBehavior EventName="Checked">

<Core:InvokeCommandAction Command="{Binding StoreProfileParameterCommand}" CommandParameter="ChildItemsViewMode=_Grid"/>
</Core:EventTriggerBehavior>
<Core:EventTriggerBehavior EventName="Unchecked">
<Core:InvokeCommandAction Command="{Binding StoreProfileParameterCommand}" CommandParameter="ChildItemsViewMode=_List"/>
</Core:EventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</CheckBox>
<ListView
x:Name="ChildListView"
HorizontalContentAlignment="Stretch"
ItemTemplateSelector="{Binding Path=StoredProfileParameters[ChildItemsViewMode], Converter={StaticResource ChildItemTemplateSelectorSuffixConv}, ConverterParameter=Normal, FallbackValue=List}"
ItemsPanel="{StaticResource ChildPageItemsPanelTemplate}"
ItemsSource="{Binding Children.Items}"
ScrollViewer.VerticalScrollBarVisibility="Auto" SelectionMode="None">
<ListView.ItemContainerStyle>
<Style TargetType="ListViewItem">
<Setter Property="HorizontalContentAlignment" Value="Stretch" />
<Setter Property="Padding" Value="0" />
<Setter Property="Margin" Value="0,0,16,0" />
</Style>
</ListView.ItemContainerStyle>
<ListView.ItemContainerTransitions>
<TransitionCollection>
<EntranceThemeTransition FromHorizontalOffset="400" />
</TransitionCollection>
</ListView.ItemContainerTransitions>
</ListView>
</StackPanel>
</Grid>
</source>

[[Category:WinX|XAML]]

== Behaviors ==

== Properties ==
* ViewModel
** CurrentDateTime: the current date and time
** UserName: the current user name
** Self: the viewmodel itself
** AppStatus: the appplication status view model

* Content
** PropertyItems: Collection of all the content's PropertyItems, each accessible via a string indexer specifying the property ID.
** IsLocked: true, if the content islocked - false, if not
** IsReadOnly: true, if the content can be read only - false, if it is writeable
** ValueSeries: the value series, if available
** MROViewModel: if the content is an MRO related content, this is the sub view model for MRO
** GeoDataViewModel: if the content represents a geo object, this is the geo sub view model
** MetaDefinition: the meta definition of the content object
** Possible Children: collection if meta defintions the user can create new child content with
** ClassificationHandler: a classification handling object
** Content: the actual content object embedded in the viewmodel
** Icon: the content icon as a byte array
** HasIcon: true, if content object has an icon - false, if not
** Title: the content objects title
** SubTitle: the content objects sub title
** OrderId: the order id of the content
** GroupId: the group id of the content
** DownloadEnabled: true, if download is enabled - false, if not
** IsNewObject: true, if the object is created and not yet saved by the user - false, if not
** ToCommit: true, if the object is yet to be committed by pressing save - false, if not
** OfflineDate: date of the last offline download
** ToSave: true, if the object is yet to be saved by pressing save - false, if not
** ToEvaluateQuery: true, if a new query can be evaluated by pressing the sending the query
** ActionOverlayExpanded: true, if the action overlay is expanded - false, if not
** DeletionAllowed: true, if deletion of the object is allowed - false, if not
** RevertLocalChangesAllowed: true, if reverting the object is allowed - false, if not
** IsPictureChildCreationAllowed: true, if the creation of a picture child is allowed - false, if not
** PropertyItems: Collection of all the Content's Properties (all properties loaded when binding is triggered) - accessible via the property ID

* GeographyList
** ItemsSortedByZLevel: true, if the current items are sorted by z level - false, if not

* PolygonItem
** FillColor: the fill color of the polygon
** FillTransparency: the transparency if the polygon filling

* MRO
** ProjectData
** ParentViewModel
** Progress
** Weight
** TechStatus

* TaskOwner
** OrgaStatus
** IsConfirmed

* Task
** IsBooleanTask
** IsInspectionTask
** IsProgressReportingTask
** IsMeasurementTask
** Value
** PropertyItem
** DisplayValue
** PreviousValue
** Unit
** NotAppliccable
** IsTaskFinished
** IsValueMIssing

* WorkPackage
** WPOrgaStatus
** CanConfirm

* AlternativeNonDocumentChildrenList

* AppStatus
** Initializing
** UserAuthenticated

* Authentication
** LandscapeImage
** PortraitImage
** LoginState
** LoginType
** IsLoggedIn
** ShowLoginButton
** EnableLoginButton
** ShowTeamLoginButton
** EnableTeamLoginButton
** ShowLogoutButton
** EnableLogoutButton
** ShowTeamLogoutButton
** EnableTeamLogoutButton
** StatusText
** SplashImage
** AppVersion
** SyncModes
** ContentServiceConfigs
** KeyValues
** Profiles

* BuildingItem
** IsValidGeo

* BuildingLevelItem
** IsSelected
** LevelName
** LevelShortName
** Index
** Height
** IsValidGeo

* BuildingLevelList
** LowestLevelItem
** ItemsSortedByLevelDescending

* ChangedObject
** IsSelected

* ChildAppBar

* ChildrenList
** Content
** [[Property_Based_Content_Filters|Filters]]
** [[Property_Based_Content_Sorting|Sorting]]

* ContentChangeAware

* ContentDetailsPage
** DocumentScanMode
** LastScannedText
** LastScannedImage

* ContentListItem
** CachedPreviewDetails
** PreviewDetails
** SubDocuments
* ContentList
* ContentPageViewModel
* ContentSelectorDialog
** IsOpen
** SelectionText
** SelectedContent
** IsOK

* Dialog
* DocumentChildrenList
* DocumentListItem
* DocumentPage
* EditDialog
* GeoContentList
* GlobalAppBar
* GlobalStatusBar
* ListViewModel
* MapGeoContentList
* MapOverlayItem
* MapOverlayList
* MapViewModel
* NonDocumentChildrenList
* OverlayedPOIGroupItemItem
* ParentBaseViewModel
* POIBaseViewModel
* POIGroupItemItem
* POIGroupItem
* POIItemViewModel
* POI
* PreviewPage
* PropertyListItem
* PropertyList
* QueryDetailsPage
* RootContentList
* RootPage
* Scan
* SearchResultListItem
* SearchResultSelection
* Search
* TeamLogin

== Commands ==

* ViewModel
** [[NavigateToURICommand]]: Navigate to an URI (e.g. open a web page or a file with a known file path)
** [[LaunchDocumentByReferenceCommand]]: Launch a file document in an external viewer by specifying the reference property ID or the document's UID (Version 2.6.37+)
** [[ShowMessageBoxCommand]]: show a message box with customizable text and title (Version 2.6.37+)

* Content
** [[NavigateToDetailsCommand]]
** [[NavigateToChildrenCommand]]
** [[NavigateToDocumentCommand]]
** [[RevertLocalChangesCommand]]
** [[DiscardContentCommand]]
** [[DeleteContentCommand]]
** [[SaveAndCommitCommand]]
** [[SetPropertyValueCommand]]
** [[SetPropertyValueAndValidateCommand]]
** [[EvaluateQueryCommand]]
** [[CaptureMediaCommand]]
** [[ShareContentCommand]]
** [[ExpandActionOverlayCommand]]
** [[StartFileEditingCommand]]
** [[ViewPropertyValueCommand]]
** [[EditPropertyValueCommand]]
** [[CreateChildItemCommand]]
** [[CreateChildItemsCommand]]
** [[ActivateReferenceByScanCommand]]
** [[ActivateReferenceCommand]]
** [[ContinueReferenceByScanCommand]]
** [[SetActiveReferenceCommand]]
** [[CancelReferenceCommand]]
** [[LaunchDocumentByReferenceCommand]]

* GenericPropertyItem
** [[ShowValueRecordsCommand]]

* ChildrenList
** [[SortByPropertyCommand]]

* ContentListItem
** [[PreviewPropertiesCommand]]
** [[PreviewDocumentsCommand]]
** [[ShowSingleChildDocumentCommand]]
** [[ClearPreviewDocumentsCommand]]

* ContentList

* ContentPageViewModel
** [[BranchDownloadCommand]]
** [[DiscardCommand]]
** [[SetPropertyValueForAllChildrenCommand]]

* ContentSelectorDialog

* Dialog

* DocumentChildrenList

* DocumentListItem
** [[ShowDocumentCommand]]
** [[StartRedliningCommand]] (Version 2.6.37+)

* DocumentPage
** [[StartRedliningCommand]]

* EditDialog
** [[OKPressedCommand]]
** [[ResetPressedCommand]]
** [[CancelPressedCommand]]
** [[ChangeEditorModeCommand]]

* GeoContentList

* GlobalAppBar

* GlobalStatusBar

* ListViewModel

* MapGeoContentList

* MapOverlayItem

* MapOverlayList

* MapViewModel

* NonDocumentChildrenList

* OverlayedPOIGroupItemItem

* ParentBaseViewModel

* POIBaseViewModel
** [[ShowDirectionsCommand]]
** [[ShowDrivingDirectionsCommand]]
** [[ShowWalkingDirectionsCommand]]
** [[UseGeoPositionCommand]]
** [[NavigateToContentCommand]]
** [[OpenPOIGroupCommand]]
** [[ExitPOIGroupCommand]]
** [[EnterBuildingCommand]]

* POIGroupItemItem

* POIGroupItem

* POIItemViewModel
** [[RefreshCommand]]

* POI

* PreviewPage
** [[ReloadChildListCommand]]

* PropertyListItem
** [[ViewPropertyValueCommand]]
** [[PropertyClickedCommand]]
** [[PropertyRightClickedCommand]]
** [[PriorityPropertyClickedCommand]]
** [[PriorityPropertyRightClickedCommand]]

* PropertyList

* QueryDetailsPage

* RootContentList

* RootPage

* Scan

* SearchResultListItem

* SearchResultSelection

* Search

* TeamLogin
** [[AddMemberCommand]]
** [[DeleteMemberCommand]]
** [[TeamLoginCommand]]
** [[CloseDialogCommand]]

[[Category:WinX|XAML]]

== Differences between Xamarin and UWP ==

As you maybe already noticed we have two different clients, one is WinX UWP and the other one Xamarin, which is used to develop clients for three different platforms namely iOS, Android and new UWP (-> it doesn’t really differentiate from the previously mentioned UWP except it’s developed in a different framework which is Xamarin in this case). The customizing stays the same in case of the syntax, but there are some differences in the naming of controls and attributes. Unfortunately, there is no decent documentation of these differences, but the Microsoft documentation and in general the internet can support you when searching e.g. for a control in Xamarin that you used in UWP.
More specific documentations about Xamarin Customizing can be found under [[Xamarin XAML]].

== Namespace changes ==

Starting from the UBIK UWP client{{Version/WinXSince|3.0.0}}, we have restructured & renamed some of our outdated or inaccurate namespaces. This means modifications are necessary for any previous XAML customizing code that refers to these changed namespaces. The complete list of such changes is documented below.

{| class="wikitable" | width = "75%"
|-
! !!style="text-align:left;"|V.2.6!!style="text-align:left;"|V.3.0
|-
|rowspan="13" style="text-align:center;"|Name-<br/>space<br/>prefix
|''UBIK.Win8''||''UBIK.WinX''
|-
|''UBIK.WinX.UI''||''UBIK.UI''
|-
|''UBIK.WinX.Utility''||''UBIK.Utility''
|-
|''UBIK.WinX.Library''||''UBIK.Library''
|-
|''UBIK.WinX.DataProvider''||''UBIK.DataProvider''
|-
|''UBIK.WinX.SyncHandler''||''UBIK.SyncHandler''
|-
|''UBIK.WinX.DatabaseConnector''||''UBIK.DatabaseConnector''
|-
|''UBIK.WinX.ContentDatabase''||''UBIK.ContentDatabase''
|-
| ''UBIK.WinX.MRO''||''UBIK.MRO''
|-
| ''UBIK.WinX.Coding''||''UBIK.Coding''
|-
| ''UBIK.WinX.DataService''||''UBIK.DataService''
|-
| ''UBIK.WinX.Redlining''||''UBIK.Redlining''
|-
| ''UBIK.WinX.Positioning''||''UBIK.Positioning''
|-
|}

Take the namespace ''UBIK.Win8'' for example, it is now changed to ''UBIK.WinX''. A few affected XAML namespace references are e.g.
* ''using:UBIK.Win8.Views'' -> ''using:UBIK.WinX.Views''
* ''using:UBIK.Win8.GART.Controls'' -> ''using:UBIK.WinX.GART.Controls''

'''Important notes''' on the namespace ''UBIK.WinX.UI'':
* One exception is the namespace '''''UBIK.WinX.UI.CollectionView'''''. It is '''not''' changed since the content is indeed WinX specific.
* For namespaces that are changed from ''UBIK.Win8.UI'' such as '''''UBIK.Win8.UI.Controls''''', '''do not''' further '''remove the ''WinX''''' segment even though the results are something like '''''UBIK.WinX.UI.Controls'''''.

== Further information regarding XAML ==
* [[Developer Mode]] <br>
* [[Xamarin XAML]] <br>
* [[XAML Basics]] <br>
* [[XAML Best practices]]

[[Category:WinX|XAML]]

XAML Tips

2020-07-29T12:42:24Z

CWU: /* Invoke on selected items */

== Functionality related ==

=== Attachable behaviors ===
It's quite often that you need to attach behaviors to certain XAML elements. For example, on a Grid, you want to attach a behavior which executes a command upon a Tapped event, or you want to execute a command when a certain property on a UBIK object changes.

Notice that in the following examples, "Interactivity" and "Core" are both namespaces and you have to make sure that they are defined at the root of your XAMLs:

<source lang = "xml">
<DataTemplate
...
xmlns:Core="using:Microsoft.Xaml.Interactions.Core"
xmlns:Interactivity="using:Microsoft.Xaml.Interactivity">
...
</DataTemplate>
</source>

==== Event Triggered ====
With an EventTriggerBehavior, you can react on changes/events of UI Elements:

<source lang = "xml">
<Grid>
<Interactivity:Interaction.Behaviors>
<Core:EventTriggerBehavior EventName="Tapped">
<Core:InvokeCommandAction Command="{Binding NavigateToChildrenCommand}" />
</Core:EventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</source>

==== Data Triggered ====
If you want to react on changes of the underlying data (ViewModel), you can use DataTriggerBehavior instead. The following example, when used in the ''UBIKSplashArea'' template, automatically navigates to the root objects once the login process is finished and the user was successfully authenticated:

<source lang = "xml">
<Grid>
<Interactivity:Interaction.Behaviors>
<Core:DataTriggerBehavior Binding="{Binding IsLoggedIn}" Value="True">
<Core:InvokeCommandAction Command="{Binding NavigateToRootPageCommand}" />
</Core:DataTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</source>

=== Fit mode ===
If you are using the standard app without XAML customizings, the [[UBIK_WinX_Client_Basics#Fit_Mode|fit mode]] feature should work out of the box.
However, when using a FlipView for displaying documents in your customized XAMLs, you must make sure to include the following binding to the FlipView's ItemTemplate so that the fit modes are properly applied.

<source lang = "xml">
<DataTemplate
...
xmlns:hs="using:UBIK.WinX.HotSpotting.Document">
...
<Grid.Resources>
...
<DataTemplate x:Key="FlipDocItemTemplate">
...
<hs:Document
...
FitMode="{Binding DocumentViewModel.FitMode}" />
</DataTemplate>
</Grid.Resources>
</DataTemplate>
</source>

=== Content creation ===
{{Version/WinXSince|3.5.5}}
To directly create an object on a child of the current object, you can define a Button as follows. The method "Item.IsTypeCreationAllowed" used in the expression gets the uid of the type that should be created below a child, if a child does not allow the creation of that type underneath it, the child will be hidden in the selection dialog. To actually create the object, the "CreateChildItemCommand" needs to be passed a KeyValueList with two parameters: The Parent-key is the ContentViewModel of the child underneath the object should be created, the Type-key is the type of object which should be created--this should match the uid passed to the "Item.IsTypeCreationAllowed" method.
<source lang = "xml">
<x:String x:Key="PlantMap">Item.IsTypeCreationAllowed("21fc990a-d064-4bee-8d48-3293351f827a")</x:String>
<cv:ListCollectionView x:Key="PlantMapView" Expression="{StaticResource PlantMap}" ItemsSource="{Binding Children.Items}" />

<AppBarButton>
<AppBarButton.Flyout>
<Flyout Placement="Full">
<ListView ItemsSource="{Binding Source={StaticResource PlantMapView}}">
<ListView.ItemTemplate>
<DataTemplate>
<Button Content="{Binding Header}" Command="{Binding CreateChildItemCommand}" x:Name="CreateButton" Tag="{Binding}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Parent" Value="{Binding Tag, ElementName=CreateButton}"/>
<uc:KeyValueParameter Key="Type" Value="21fc990a-d064-4bee-8d48-3293351f827a"/>
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</Flyout>
</AppBarButton.Flyout>
</AppBarButton>
</source>

<br/>
Additionally, the following optional parameters can be added as well.
* CreateOnly (optional, defaults to false): When set to true, the client will not automatically navigate to the created content, rather automatically save and commit it. If set to true, this overrides the following parameters;
* AutoNavigate (optional, defaults to true): When set to false, the client will not automatically navigate to the created content;
* AutoCommit (optional, defaults to false): When set to true, the change(s) will be saved to the local cache and the database, and then committed to the server.

=== Disable FilloutCriteria ===
{{Version/WinXSince|3.5}}
To enable/disable the automatic filtering of a query based on the ParentObject, there is the possibility to specify EnableFillOutCriteria--if it is not set, it defaults to false. Additionaly "SkipDialog" can be set to true, to not display a dialog.

<source lang="xml">
<Grid x:Name="selectionGrid" Tag="{Binding MetaUID}">
<Interactivity:Interaction.Behaviors>
<Core:EventTriggerBehavior EventName="Tapped">
<Core:InvokeCommandAction Command="{Binding ElementName=ChildAreaGrid, Path=DataContext.AddTemplatableDataCommand}" >
<Core:InvokeCommandAction.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Uid" Value="{Binding Tag,ElementName=selectionGrid}"/>
<uc:KeyValueParameter Key="EnableFillOutCriteria" Value="false"/>
<uc:KeyValueParameter Key="SkipDialog" Value="false"/>
</uc:KeyValueList>
</Core:InvokeCommandAction.CommandParameter>
</Core:InvokeCommandAction>
</Core:EventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</source>

=== Hotspotting ===
{{Attention|To use a binding in the KeyValueParameter, it has to be applied like in the example provided here: [[KeyValueList]]}}
The hotspotting command is used for hotspotting as well as for annotating, to configure the button for hotspotting, the commandparameter "Mode" should be set to "HotSpotting", for annotating the "Mode" should be "Annotate". The parameter commit is optional, if set to true, the changes get automatically persisted when leaving the editing mode.

<source lang = "xml">
<AppBarToggleButton
IsChecked="{Binding EditingAnnotation, Mode=TwoWay}"
IsEnabled="{Binding IsAnnotatable}"
Command="{Binding HotSpottingCommand}">
<AppBarToggleButton.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Mode" Value="Annotate"/>
<uc:KeyValueParameter Key="Commit" Value="true"/>
</uc:KeyValueList>
</AppBarToggleButton.CommandParameter>
</AppBarToggleButton>
</source>

[[Category:Client|XAML Tips]]
[[Category:WinX|XAML Tips]]

=== Remember scroll positions of list views ===

==== Version 3.7 & later {{Version/WinXSince|3.7}} ====
Starting from this version,
* The precision of scroll position remembering is improved(by pixel offsets instead of by items);
* It also works for other scrollable lists (instead of just for content object lists).
<br />
To enable this feature, you should make sure the following.
* The SelectionBoundListView is used instead of the standard ListView. Its {{UBIK}} namespace is <code>UBIK.WinX.Controls</code>;
* The SelectionBoundListView's <code>RememberScrollPosition</code> property is not set to "false"; (It's "true" by default.)
* The SelectionBoundListView's <code>x:Name</code> property value is unique.

==== Version 3.6 {{Version/WinXSince|3.6}} ====
The UBIK-Client does include a function to remember the position in a list (ListView) when navigating away from it. This function is only available when the list (ListView) has a unique name as a property (x:Name). When browsing back to the previously visited list UBIK scrolls back to the last position. The function does not save scroll positions over different sessions.
Implementing the function to remember the scroll position in a ListView one has to consider that the list elements (Children) could depend on a other UI-element. If the list elements do depend on a other UI-elemente, this element has to be created above the ListView in the XAML.

<source lang = "xml">
<DataTemplate xmlns:behaviors="using:UBIK.WinX.Behaviors" xmlns:uc="using:UBIK.WinX.Controls">
...
<uc:SelectionBoundListView x:Name="ChildListView">
<Interactivity:Interaction.Behaviors>
<behaviors:FirstVisibleItemPersistenceBehavior FirstVisibleItems="{Binding ScrollItems}" />
</Interactivity:Interaction.Behaviors>
</uc:SelectionBoundListView>
</DataTemplate>
</source>

[[Category:Client|XAML Tips]]
[[Category:WinX|XAML Tips]]

=== MultiBinding {{Version/WinXSince|3.6}} ===
Very often we want to display some UI elements (e.g. a Grid) depending on whether multiple criteria are met. It's much easier to achieve this by using a MultiBindingBehavior like the following.
<source lang = "xml">
<DataTemplate
xmlns:Interactivity="using:Microsoft.Xaml.Interactivity"
xmlns:behaviors="using:UBIK.WinX.Behaviors">
...
<Grid>
<Interactivity:Interaction.Behaviors>
<behaviors:MultiBindingBehavior Converter="{StaticResource VisLogicAndConverter}" PropertyName="Visibility">
<behaviors:MultiBindingItem Value="{Binding MassEditViewModel, Converter={StaticResource NullToVisConverter}}" />
<behaviors:MultiBindingItem Value="{Binding Documents.Items.Count, Converter={StaticResource ItemCountToVisConverter}}" />
</behaviors:MultiBindingBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</DataTemplate>
</source>
The behavior makes sure the container Grid is set to Visibile only if the mass editing mode is not turned on (MassEditViewModel is null) and the context object has child document(s) (Documents.Items.Count is greater than 0. You can combine any number of binding results (MultiBindingItem) using the VisLogicAndConverter (the name should be self explanatory).

=== InvokeOnItemsCommand {{Version/WinXSince|3.6}} ===
Available on all ListViewModels, this command allows executing a specified command on a collection of list items. It can be used in combination with features such as [[Mass_Edit_(UBIK_WinX)|mass editing]] and [[XAML_Changes_in_UBIK_WinX_3.5#After_3.5|expression based collection filtering]]. Examples for both combinations are provided below.

{{Attention|The command specified through the "Command" parameter is executed on list items and, therefore, must be available in the list item contexts (view models). If in doubt, the [[Developer_Mode|developer mode]] can be used to inspect if a command is available in a certain context.}}

{{Hint|Parameter "Command" and "SelectedItemsOnly" are specific to the InvokeOnItemsCommand. What other parameters to define or whether to define them at all depends on the type of command to be executed on the items.}}

==== Invoke on selected items ====
{{Attention|To use a binding in the KeyValueParameter, it has to be applied like in the example provided here: [[KeyValueList]]}}
This example demonstrates how you can use the mass editing feature to select certain objects from the child list and then execute the SetPropertyValueCommand for those selected.
* The example code assumes that the child objects have an editable property called "VALUE" and tries to set 50 as their value;
* You should insert the following code snippet into the default UBIKChildArea template;
* If the parameter "SelectedItemsOnly" is missed or set to "False", the command will be executed on all child items;
* To enable selection, click on the "Mass Edit" button below the property list.
<br />
<source lang = "xml">
<AppBarButton
xmlns:example="using:UBIK.WinX.Controls"
Command="{Binding Children.InvokeOnItemsCommand}"
Icon="AllApps"
Label="Set to 50%"
Style="{ThemeResource UBIKActionAppBarButton}">
<AppBarButton.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="Command" Value="SetPropertyValueCommand" />
<example:KeyValueParameter Key="SelectedItemsOnly" Value="True" />
<example:KeyValueParameter Key="PropertyName" Value="VALUE" />
<example:KeyValueParameter Key="PropertyValue" Value="50" />
</example:KeyValueList>
</AppBarButton.CommandParameter>
</AppBarButton>
</source>

[[Category:Client|XAML Tips]]
[[Category:WinX|XAML Tips]]

==== Invoke on filtered results ====

{{Attention|To use a binding in the KeyValueParameter, it has to be applied like in the example provided here: [[KeyValueList]]}}

First, you need to setup a filtered list (ListCollectionView) in the Resources section of a UI element (e.g. Grid).
* This list is only available/visible within that UI element (the Grid in this case);
* The ItemsSource uses Children.Items. Use the [[Developer_Mode|developer mode]] if necessary to find out if this is available where you intend to define the list;
* The example expression filters for any items that don't contain the text "EXAMPLE" in their Title texts. You can filter differently by altering the expression.
<br />
<source lang = "xml">
<Grid xmlns:CV="using:UBIK.WinX.UI.CollectionView">
<Grid.Resources>
<CV:ListCollectionView
x:Key="Filtered"
Expression="!Item.Title.Contains("EXAMPLE")"
ItemsSource="{Binding Children.Items}" />
</Grid.Resources>
...
</Grid>
</source>
<br />
With the filtered list configured, you can then insert the following code snippet to execute the SetPropertyValueCommand for the filtered result items.
* The example code assumes that the child objects have an editable property called "VALUE" and tries to set 50 as their value;
* The "Filtered" refers to the ListCollectionView configured above.
<br />
<source lang = "xml">
<AppBarButton
xmlns:example="using:UBIK.WinX.Controls"
Command="{Binding Source={StaticResource Filtered}, Path=ListViewModel.InvokeOnItemsCommand}"
Icon="AllApps"
Label="Set to 50"
Style="{ThemeResource UBIKActionAppBarButton}">
<AppBarButton.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="Command" Value="SetPropertyValueCommand" />
<example:KeyValueParameter Key="PropertyName" Value="VALUE" />
<example:KeyValueParameter Key="PropertyValue" Value="50" />
</example:KeyValueList>
</AppBarButton.CommandParameter>
</AppBarButton>
</source>

[[Category:Client|XAML Tips]]
[[Category:WinX|XAML Tips]]

==== Support for old styled commands ====
Some old commands might not support KeyValueLists as parameters. In that case, just define the parameter value under the "CommandParameter" key, e.g.
<br />
<source lang = "xml"><example:KeyValueParameter Key="CommandParameter" Value="some string value for example" /></source>.
This single value is then passed as the command parameter instead of the entire KeyValueList.

=== SetPropertyValueCommand {{Version/WinXSince|3.6}} ===
{{Attention|To use a binding in the KeyValueParameter, it has to be applied like in the example provided here: [[KeyValueList]]}}

This command existed before but was implemented differently. In the newer version(s), it is improved to provide customizers more control over the things that happen during/after the property value changes.
The available commnad parameters are:
* PropertyName: the name of the property to set a new value to;
* PropertyValue: the value to be set to the above mentioned property;
* OnlyForUnvalidated (optional, defaults to false): When set to true, the value will only be set if the property is not yet validated;
* AutoSave (optional, defaults to false): When set to true, the change(s) will be saved to the local cache and database;
* AutoCommit (optional, defaults to false): When set to true, the change(s) will be committed to the server.

{{Hint|There's no way to commit changes without saving them locally first. Therefore, the "AutoSave" parameter will be ignored when "AutoCommit" is set to true.}}

Here's an example of the command usage. It tries to set the property called "VALUE" to a double value 50 regardless of its current state and then automatically save and commit the change.
<br />
<source lang = "xml">
<AppBarButton
xmlns:example="using:UBIK.WinX.Controls"
Command="{Binding SetPropertyValueCommand}"
Icon="Edit"
Label="Set to 50%"
Style="{ThemeResource UBIKActionAppBarButton}">
<AppBarButton.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="PropertyName" Value="VALUE" />
<example:KeyValueParameter Key="PropertyValue">
<example:KeyValueParameter.Value>
<x:Double>50</x:Double>
</example:KeyValueParameter.Value>
</example:KeyValueParameter>
<example:KeyValueParameter Key="OnlyForUnvalidated" Value="false" />
<example:KeyValueParameter Key="AutoSave" Value="true" />
<example:KeyValueParameter Key="AutoCommit" Value="true" />
</example:KeyValueList>
</AppBarButton.CommandParameter>
</AppBarButton>
</source>

{{Hint|It is advised to provide typed values like <nowiki><x:Double>50</x:Double></nowiki>. But for simple types, you can try writing them in the text format like <nowiki><example:KeyValueParameter Key="PropertyValue" Value="50" /></nowiki> and {{UBIK}} will try to find the right type.}}

[[Category:Client|XAML Tips]]
[[Category:WinX|XAML Tips]]

== Performance related ==

=== FlipView ===
When using the FlipView control in your XAML code, it's better to enable [https://docs.microsoft.com/en-us/windows/uwp/debug-test-perf/optimize-gridview-and-listview#ui-virtualization UI virtualization]. The difference in performance gets more obvious as the number of items in the FlipView increases. Here's how to enable it.

<source lang = "xml">
<FlipView
...
VirtualizingStackPanel.VirtualizationMode="Standard">
<Flipview.ItemsPanel>
<ItemsPanelTemplate>
<VirtualizingStackPanel Orientation="Horizontal" />
</ItemsPanelTemplate>
</Flipview.ItemsPanel>
</FlipView>
</source>

VirtualizingStackPanel.VirtualizationMode offers two possibilities: Standard & Recycling. In case you are interested, here are their [https://docs.microsoft.com/en-us/dotnet/api/system.windows.controls.virtualizationmode?view=netframework-4.7.2 differences].

[[Category:Client|XAML Tips]]
[[Category:WinX|XAML Tips]]

XAML Tips

2020-07-29T12:42:05Z

CWU: /* Hotspotting */

== Functionality related ==

=== Attachable behaviors ===
It's quite often that you need to attach behaviors to certain XAML elements. For example, on a Grid, you want to attach a behavior which executes a command upon a Tapped event, or you want to execute a command when a certain property on a UBIK object changes.

Notice that in the following examples, "Interactivity" and "Core" are both namespaces and you have to make sure that they are defined at the root of your XAMLs:

<source lang = "xml">
<DataTemplate
...
xmlns:Core="using:Microsoft.Xaml.Interactions.Core"
xmlns:Interactivity="using:Microsoft.Xaml.Interactivity">
...
</DataTemplate>
</source>

==== Event Triggered ====
With an EventTriggerBehavior, you can react on changes/events of UI Elements:

<source lang = "xml">
<Grid>
<Interactivity:Interaction.Behaviors>
<Core:EventTriggerBehavior EventName="Tapped">
<Core:InvokeCommandAction Command="{Binding NavigateToChildrenCommand}" />
</Core:EventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</source>

==== Data Triggered ====
If you want to react on changes of the underlying data (ViewModel), you can use DataTriggerBehavior instead. The following example, when used in the ''UBIKSplashArea'' template, automatically navigates to the root objects once the login process is finished and the user was successfully authenticated:

<source lang = "xml">
<Grid>
<Interactivity:Interaction.Behaviors>
<Core:DataTriggerBehavior Binding="{Binding IsLoggedIn}" Value="True">
<Core:InvokeCommandAction Command="{Binding NavigateToRootPageCommand}" />
</Core:DataTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</source>

=== Fit mode ===
If you are using the standard app without XAML customizings, the [[UBIK_WinX_Client_Basics#Fit_Mode|fit mode]] feature should work out of the box.
However, when using a FlipView for displaying documents in your customized XAMLs, you must make sure to include the following binding to the FlipView's ItemTemplate so that the fit modes are properly applied.

<source lang = "xml">
<DataTemplate
...
xmlns:hs="using:UBIK.WinX.HotSpotting.Document">
...
<Grid.Resources>
...
<DataTemplate x:Key="FlipDocItemTemplate">
...
<hs:Document
...
FitMode="{Binding DocumentViewModel.FitMode}" />
</DataTemplate>
</Grid.Resources>
</DataTemplate>
</source>

=== Content creation ===
{{Version/WinXSince|3.5.5}}
To directly create an object on a child of the current object, you can define a Button as follows. The method "Item.IsTypeCreationAllowed" used in the expression gets the uid of the type that should be created below a child, if a child does not allow the creation of that type underneath it, the child will be hidden in the selection dialog. To actually create the object, the "CreateChildItemCommand" needs to be passed a KeyValueList with two parameters: The Parent-key is the ContentViewModel of the child underneath the object should be created, the Type-key is the type of object which should be created--this should match the uid passed to the "Item.IsTypeCreationAllowed" method.
<source lang = "xml">
<x:String x:Key="PlantMap">Item.IsTypeCreationAllowed("21fc990a-d064-4bee-8d48-3293351f827a")</x:String>
<cv:ListCollectionView x:Key="PlantMapView" Expression="{StaticResource PlantMap}" ItemsSource="{Binding Children.Items}" />

<AppBarButton>
<AppBarButton.Flyout>
<Flyout Placement="Full">
<ListView ItemsSource="{Binding Source={StaticResource PlantMapView}}">
<ListView.ItemTemplate>
<DataTemplate>
<Button Content="{Binding Header}" Command="{Binding CreateChildItemCommand}" x:Name="CreateButton" Tag="{Binding}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Parent" Value="{Binding Tag, ElementName=CreateButton}"/>
<uc:KeyValueParameter Key="Type" Value="21fc990a-d064-4bee-8d48-3293351f827a"/>
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</Flyout>
</AppBarButton.Flyout>
</AppBarButton>
</source>

<br/>
Additionally, the following optional parameters can be added as well.
* CreateOnly (optional, defaults to false): When set to true, the client will not automatically navigate to the created content, rather automatically save and commit it. If set to true, this overrides the following parameters;
* AutoNavigate (optional, defaults to true): When set to false, the client will not automatically navigate to the created content;
* AutoCommit (optional, defaults to false): When set to true, the change(s) will be saved to the local cache and the database, and then committed to the server.

=== Disable FilloutCriteria ===
{{Version/WinXSince|3.5}}
To enable/disable the automatic filtering of a query based on the ParentObject, there is the possibility to specify EnableFillOutCriteria--if it is not set, it defaults to false. Additionaly "SkipDialog" can be set to true, to not display a dialog.

<source lang="xml">
<Grid x:Name="selectionGrid" Tag="{Binding MetaUID}">
<Interactivity:Interaction.Behaviors>
<Core:EventTriggerBehavior EventName="Tapped">
<Core:InvokeCommandAction Command="{Binding ElementName=ChildAreaGrid, Path=DataContext.AddTemplatableDataCommand}" >
<Core:InvokeCommandAction.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Uid" Value="{Binding Tag,ElementName=selectionGrid}"/>
<uc:KeyValueParameter Key="EnableFillOutCriteria" Value="false"/>
<uc:KeyValueParameter Key="SkipDialog" Value="false"/>
</uc:KeyValueList>
</Core:InvokeCommandAction.CommandParameter>
</Core:InvokeCommandAction>
</Core:EventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</source>

=== Hotspotting ===
{{Attention|To use a binding in the KeyValueParameter, it has to be applied like in the example provided here: [[KeyValueList]]}}
The hotspotting command is used for hotspotting as well as for annotating, to configure the button for hotspotting, the commandparameter "Mode" should be set to "HotSpotting", for annotating the "Mode" should be "Annotate". The parameter commit is optional, if set to true, the changes get automatically persisted when leaving the editing mode.

<source lang = "xml">
<AppBarToggleButton
IsChecked="{Binding EditingAnnotation, Mode=TwoWay}"
IsEnabled="{Binding IsAnnotatable}"
Command="{Binding HotSpottingCommand}">
<AppBarToggleButton.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Mode" Value="Annotate"/>
<uc:KeyValueParameter Key="Commit" Value="true"/>
</uc:KeyValueList>
</AppBarToggleButton.CommandParameter>
</AppBarToggleButton>
</source>

[[Category:Client|XAML Tips]]
[[Category:WinX|XAML Tips]]

=== Remember scroll positions of list views ===

==== Version 3.7 & later {{Version/WinXSince|3.7}} ====
Starting from this version,
* The precision of scroll position remembering is improved(by pixel offsets instead of by items);
* It also works for other scrollable lists (instead of just for content object lists).
<br />
To enable this feature, you should make sure the following.
* The SelectionBoundListView is used instead of the standard ListView. Its {{UBIK}} namespace is <code>UBIK.WinX.Controls</code>;
* The SelectionBoundListView's <code>RememberScrollPosition</code> property is not set to "false"; (It's "true" by default.)
* The SelectionBoundListView's <code>x:Name</code> property value is unique.

==== Version 3.6 {{Version/WinXSince|3.6}} ====
The UBIK-Client does include a function to remember the position in a list (ListView) when navigating away from it. This function is only available when the list (ListView) has a unique name as a property (x:Name). When browsing back to the previously visited list UBIK scrolls back to the last position. The function does not save scroll positions over different sessions.
Implementing the function to remember the scroll position in a ListView one has to consider that the list elements (Children) could depend on a other UI-element. If the list elements do depend on a other UI-elemente, this element has to be created above the ListView in the XAML.

<source lang = "xml">
<DataTemplate xmlns:behaviors="using:UBIK.WinX.Behaviors" xmlns:uc="using:UBIK.WinX.Controls">
...
<uc:SelectionBoundListView x:Name="ChildListView">
<Interactivity:Interaction.Behaviors>
<behaviors:FirstVisibleItemPersistenceBehavior FirstVisibleItems="{Binding ScrollItems}" />
</Interactivity:Interaction.Behaviors>
</uc:SelectionBoundListView>
</DataTemplate>
</source>

[[Category:Client|XAML Tips]]
[[Category:WinX|XAML Tips]]

=== MultiBinding {{Version/WinXSince|3.6}} ===
Very often we want to display some UI elements (e.g. a Grid) depending on whether multiple criteria are met. It's much easier to achieve this by using a MultiBindingBehavior like the following.
<source lang = "xml">
<DataTemplate
xmlns:Interactivity="using:Microsoft.Xaml.Interactivity"
xmlns:behaviors="using:UBIK.WinX.Behaviors">
...
<Grid>
<Interactivity:Interaction.Behaviors>
<behaviors:MultiBindingBehavior Converter="{StaticResource VisLogicAndConverter}" PropertyName="Visibility">
<behaviors:MultiBindingItem Value="{Binding MassEditViewModel, Converter={StaticResource NullToVisConverter}}" />
<behaviors:MultiBindingItem Value="{Binding Documents.Items.Count, Converter={StaticResource ItemCountToVisConverter}}" />
</behaviors:MultiBindingBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</DataTemplate>
</source>
The behavior makes sure the container Grid is set to Visibile only if the mass editing mode is not turned on (MassEditViewModel is null) and the context object has child document(s) (Documents.Items.Count is greater than 0. You can combine any number of binding results (MultiBindingItem) using the VisLogicAndConverter (the name should be self explanatory).

=== InvokeOnItemsCommand {{Version/WinXSince|3.6}} ===
Available on all ListViewModels, this command allows executing a specified command on a collection of list items. It can be used in combination with features such as [[Mass_Edit_(UBIK_WinX)|mass editing]] and [[XAML_Changes_in_UBIK_WinX_3.5#After_3.5|expression based collection filtering]]. Examples for both combinations are provided below.

{{Attention|The command specified through the "Command" parameter is executed on list items and, therefore, must be available in the list item contexts (view models). If in doubt, the [[Developer_Mode|developer mode]] can be used to inspect if a command is available in a certain context.}}

{{Hint|Parameter "Command" and "SelectedItemsOnly" are specific to the InvokeOnItemsCommand. What other parameters to define or whether to define them at all depends on the type of command to be executed on the items.}}

==== Invoke on selected items ====
This example demonstrates how you can use the mass editing feature to select certain objects from the child list and then execute the SetPropertyValueCommand for those selected.
* The example code assumes that the child objects have an editable property called "VALUE" and tries to set 50 as their value;
* You should insert the following code snippet into the default UBIKChildArea template;
* If the parameter "SelectedItemsOnly" is missed or set to "False", the command will be executed on all child items;
* To enable selection, click on the "Mass Edit" button below the property list.
<br />
<source lang = "xml">
<AppBarButton
xmlns:example="using:UBIK.WinX.Controls"
Command="{Binding Children.InvokeOnItemsCommand}"
Icon="AllApps"
Label="Set to 50%"
Style="{ThemeResource UBIKActionAppBarButton}">
<AppBarButton.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="Command" Value="SetPropertyValueCommand" />
<example:KeyValueParameter Key="SelectedItemsOnly" Value="True" />
<example:KeyValueParameter Key="PropertyName" Value="VALUE" />
<example:KeyValueParameter Key="PropertyValue" Value="50" />
</example:KeyValueList>
</AppBarButton.CommandParameter>
</AppBarButton>
</source>

==== Invoke on filtered results ====

{{Attention|To use a binding in the KeyValueParameter, it has to be applied like in the example provided here: [[KeyValueList]]}}

First, you need to setup a filtered list (ListCollectionView) in the Resources section of a UI element (e.g. Grid).
* This list is only available/visible within that UI element (the Grid in this case);
* The ItemsSource uses Children.Items. Use the [[Developer_Mode|developer mode]] if necessary to find out if this is available where you intend to define the list;
* The example expression filters for any items that don't contain the text "EXAMPLE" in their Title texts. You can filter differently by altering the expression.
<br />
<source lang = "xml">
<Grid xmlns:CV="using:UBIK.WinX.UI.CollectionView">
<Grid.Resources>
<CV:ListCollectionView
x:Key="Filtered"
Expression="!Item.Title.Contains("EXAMPLE")"
ItemsSource="{Binding Children.Items}" />
</Grid.Resources>
...
</Grid>
</source>
<br />
With the filtered list configured, you can then insert the following code snippet to execute the SetPropertyValueCommand for the filtered result items.
* The example code assumes that the child objects have an editable property called "VALUE" and tries to set 50 as their value;
* The "Filtered" refers to the ListCollectionView configured above.
<br />
<source lang = "xml">
<AppBarButton
xmlns:example="using:UBIK.WinX.Controls"
Command="{Binding Source={StaticResource Filtered}, Path=ListViewModel.InvokeOnItemsCommand}"
Icon="AllApps"
Label="Set to 50"
Style="{ThemeResource UBIKActionAppBarButton}">
<AppBarButton.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="Command" Value="SetPropertyValueCommand" />
<example:KeyValueParameter Key="PropertyName" Value="VALUE" />
<example:KeyValueParameter Key="PropertyValue" Value="50" />
</example:KeyValueList>
</AppBarButton.CommandParameter>
</AppBarButton>
</source>

[[Category:Client|XAML Tips]]
[[Category:WinX|XAML Tips]]

==== Support for old styled commands ====
Some old commands might not support KeyValueLists as parameters. In that case, just define the parameter value under the "CommandParameter" key, e.g.
<br />
<source lang = "xml"><example:KeyValueParameter Key="CommandParameter" Value="some string value for example" /></source>.
This single value is then passed as the command parameter instead of the entire KeyValueList.

=== SetPropertyValueCommand {{Version/WinXSince|3.6}} ===
{{Attention|To use a binding in the KeyValueParameter, it has to be applied like in the example provided here: [[KeyValueList]]}}

This command existed before but was implemented differently. In the newer version(s), it is improved to provide customizers more control over the things that happen during/after the property value changes.
The available commnad parameters are:
* PropertyName: the name of the property to set a new value to;
* PropertyValue: the value to be set to the above mentioned property;
* OnlyForUnvalidated (optional, defaults to false): When set to true, the value will only be set if the property is not yet validated;
* AutoSave (optional, defaults to false): When set to true, the change(s) will be saved to the local cache and database;
* AutoCommit (optional, defaults to false): When set to true, the change(s) will be committed to the server.

{{Hint|There's no way to commit changes without saving them locally first. Therefore, the "AutoSave" parameter will be ignored when "AutoCommit" is set to true.}}

Here's an example of the command usage. It tries to set the property called "VALUE" to a double value 50 regardless of its current state and then automatically save and commit the change.
<br />
<source lang = "xml">
<AppBarButton
xmlns:example="using:UBIK.WinX.Controls"
Command="{Binding SetPropertyValueCommand}"
Icon="Edit"
Label="Set to 50%"
Style="{ThemeResource UBIKActionAppBarButton}">
<AppBarButton.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="PropertyName" Value="VALUE" />
<example:KeyValueParameter Key="PropertyValue">
<example:KeyValueParameter.Value>
<x:Double>50</x:Double>
</example:KeyValueParameter.Value>
</example:KeyValueParameter>
<example:KeyValueParameter Key="OnlyForUnvalidated" Value="false" />
<example:KeyValueParameter Key="AutoSave" Value="true" />
<example:KeyValueParameter Key="AutoCommit" Value="true" />
</example:KeyValueList>
</AppBarButton.CommandParameter>
</AppBarButton>
</source>

{{Hint|It is advised to provide typed values like <nowiki><x:Double>50</x:Double></nowiki>. But for simple types, you can try writing them in the text format like <nowiki><example:KeyValueParameter Key="PropertyValue" Value="50" /></nowiki> and {{UBIK}} will try to find the right type.}}

[[Category:Client|XAML Tips]]
[[Category:WinX|XAML Tips]]

== Performance related ==

=== FlipView ===
When using the FlipView control in your XAML code, it's better to enable [https://docs.microsoft.com/en-us/windows/uwp/debug-test-perf/optimize-gridview-and-listview#ui-virtualization UI virtualization]. The difference in performance gets more obvious as the number of items in the FlipView increases. Here's how to enable it.

<source lang = "xml">
<FlipView
...
VirtualizingStackPanel.VirtualizationMode="Standard">
<Flipview.ItemsPanel>
<ItemsPanelTemplate>
<VirtualizingStackPanel Orientation="Horizontal" />
</ItemsPanelTemplate>
</Flipview.ItemsPanel>
</FlipView>
</source>

VirtualizingStackPanel.VirtualizationMode offers two possibilities: Standard & Recycling. In case you are interested, here are their [https://docs.microsoft.com/en-us/dotnet/api/system.windows.controls.virtualizationmode?view=netframework-4.7.2 differences].

[[Category:Client|XAML Tips]]
[[Category:WinX|XAML Tips]]

XAML Tips

2020-07-29T12:38:57Z

CWU: /* Invoke on filtered results */

== Functionality related ==

=== Attachable behaviors ===
It's quite often that you need to attach behaviors to certain XAML elements. For example, on a Grid, you want to attach a behavior which executes a command upon a Tapped event, or you want to execute a command when a certain property on a UBIK object changes.

Notice that in the following examples, "Interactivity" and "Core" are both namespaces and you have to make sure that they are defined at the root of your XAMLs:

<source lang = "xml">
<DataTemplate
...
xmlns:Core="using:Microsoft.Xaml.Interactions.Core"
xmlns:Interactivity="using:Microsoft.Xaml.Interactivity">
...
</DataTemplate>
</source>

==== Event Triggered ====
With an EventTriggerBehavior, you can react on changes/events of UI Elements:

<source lang = "xml">
<Grid>
<Interactivity:Interaction.Behaviors>
<Core:EventTriggerBehavior EventName="Tapped">
<Core:InvokeCommandAction Command="{Binding NavigateToChildrenCommand}" />
</Core:EventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</source>

==== Data Triggered ====
If you want to react on changes of the underlying data (ViewModel), you can use DataTriggerBehavior instead. The following example, when used in the ''UBIKSplashArea'' template, automatically navigates to the root objects once the login process is finished and the user was successfully authenticated:

<source lang = "xml">
<Grid>
<Interactivity:Interaction.Behaviors>
<Core:DataTriggerBehavior Binding="{Binding IsLoggedIn}" Value="True">
<Core:InvokeCommandAction Command="{Binding NavigateToRootPageCommand}" />
</Core:DataTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</source>

=== Fit mode ===
If you are using the standard app without XAML customizings, the [[UBIK_WinX_Client_Basics#Fit_Mode|fit mode]] feature should work out of the box.
However, when using a FlipView for displaying documents in your customized XAMLs, you must make sure to include the following binding to the FlipView's ItemTemplate so that the fit modes are properly applied.

<source lang = "xml">
<DataTemplate
...
xmlns:hs="using:UBIK.WinX.HotSpotting.Document">
...
<Grid.Resources>
...
<DataTemplate x:Key="FlipDocItemTemplate">
...
<hs:Document
...
FitMode="{Binding DocumentViewModel.FitMode}" />
</DataTemplate>
</Grid.Resources>
</DataTemplate>
</source>

=== Content creation ===
{{Version/WinXSince|3.5.5}}
To directly create an object on a child of the current object, you can define a Button as follows. The method "Item.IsTypeCreationAllowed" used in the expression gets the uid of the type that should be created below a child, if a child does not allow the creation of that type underneath it, the child will be hidden in the selection dialog. To actually create the object, the "CreateChildItemCommand" needs to be passed a KeyValueList with two parameters: The Parent-key is the ContentViewModel of the child underneath the object should be created, the Type-key is the type of object which should be created--this should match the uid passed to the "Item.IsTypeCreationAllowed" method.
<source lang = "xml">
<x:String x:Key="PlantMap">Item.IsTypeCreationAllowed("21fc990a-d064-4bee-8d48-3293351f827a")</x:String>
<cv:ListCollectionView x:Key="PlantMapView" Expression="{StaticResource PlantMap}" ItemsSource="{Binding Children.Items}" />

<AppBarButton>
<AppBarButton.Flyout>
<Flyout Placement="Full">
<ListView ItemsSource="{Binding Source={StaticResource PlantMapView}}">
<ListView.ItemTemplate>
<DataTemplate>
<Button Content="{Binding Header}" Command="{Binding CreateChildItemCommand}" x:Name="CreateButton" Tag="{Binding}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Parent" Value="{Binding Tag, ElementName=CreateButton}"/>
<uc:KeyValueParameter Key="Type" Value="21fc990a-d064-4bee-8d48-3293351f827a"/>
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</Flyout>
</AppBarButton.Flyout>
</AppBarButton>
</source>

<br/>
Additionally, the following optional parameters can be added as well.
* CreateOnly (optional, defaults to false): When set to true, the client will not automatically navigate to the created content, rather automatically save and commit it. If set to true, this overrides the following parameters;
* AutoNavigate (optional, defaults to true): When set to false, the client will not automatically navigate to the created content;
* AutoCommit (optional, defaults to false): When set to true, the change(s) will be saved to the local cache and the database, and then committed to the server.

=== Disable FilloutCriteria ===
{{Version/WinXSince|3.5}}
To enable/disable the automatic filtering of a query based on the ParentObject, there is the possibility to specify EnableFillOutCriteria--if it is not set, it defaults to false. Additionaly "SkipDialog" can be set to true, to not display a dialog.

<source lang="xml">
<Grid x:Name="selectionGrid" Tag="{Binding MetaUID}">
<Interactivity:Interaction.Behaviors>
<Core:EventTriggerBehavior EventName="Tapped">
<Core:InvokeCommandAction Command="{Binding ElementName=ChildAreaGrid, Path=DataContext.AddTemplatableDataCommand}" >
<Core:InvokeCommandAction.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Uid" Value="{Binding Tag,ElementName=selectionGrid}"/>
<uc:KeyValueParameter Key="EnableFillOutCriteria" Value="false"/>
<uc:KeyValueParameter Key="SkipDialog" Value="false"/>
</uc:KeyValueList>
</Core:InvokeCommandAction.CommandParameter>
</Core:InvokeCommandAction>
</Core:EventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</source>

=== Hotspotting ===

The hotspotting command is used for hotspotting as well as for annotating, to configure the button for hotspotting, the commandparameter "Mode" should be set to "HotSpotting", for annotating the "Mode" should be "Annotate". The parameter commit is optional, if set to true, the changes get automatically persisted when leaving the editing mode.

<source lang = "xml">
<AppBarToggleButton
IsChecked="{Binding EditingAnnotation, Mode=TwoWay}"
IsEnabled="{Binding IsAnnotatable}"
Command="{Binding HotSpottingCommand}">
<AppBarToggleButton.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Mode" Value="Annotate"/>
<uc:KeyValueParameter Key="Commit" Value="true"/>
</uc:KeyValueList>
</AppBarToggleButton.CommandParameter>
</AppBarToggleButton>
</source>

=== Remember scroll positions of list views ===

==== Version 3.7 & later {{Version/WinXSince|3.7}} ====
Starting from this version,
* The precision of scroll position remembering is improved(by pixel offsets instead of by items);
* It also works for other scrollable lists (instead of just for content object lists).
<br />
To enable this feature, you should make sure the following.
* The SelectionBoundListView is used instead of the standard ListView. Its {{UBIK}} namespace is <code>UBIK.WinX.Controls</code>;
* The SelectionBoundListView's <code>RememberScrollPosition</code> property is not set to "false"; (It's "true" by default.)
* The SelectionBoundListView's <code>x:Name</code> property value is unique.

==== Version 3.6 {{Version/WinXSince|3.6}} ====
The UBIK-Client does include a function to remember the position in a list (ListView) when navigating away from it. This function is only available when the list (ListView) has a unique name as a property (x:Name). When browsing back to the previously visited list UBIK scrolls back to the last position. The function does not save scroll positions over different sessions.
Implementing the function to remember the scroll position in a ListView one has to consider that the list elements (Children) could depend on a other UI-element. If the list elements do depend on a other UI-elemente, this element has to be created above the ListView in the XAML.

<source lang = "xml">
<DataTemplate xmlns:behaviors="using:UBIK.WinX.Behaviors" xmlns:uc="using:UBIK.WinX.Controls">
...
<uc:SelectionBoundListView x:Name="ChildListView">
<Interactivity:Interaction.Behaviors>
<behaviors:FirstVisibleItemPersistenceBehavior FirstVisibleItems="{Binding ScrollItems}" />
</Interactivity:Interaction.Behaviors>
</uc:SelectionBoundListView>
</DataTemplate>
</source>

[[Category:Client|XAML Tips]]
[[Category:WinX|XAML Tips]]

=== MultiBinding {{Version/WinXSince|3.6}} ===
Very often we want to display some UI elements (e.g. a Grid) depending on whether multiple criteria are met. It's much easier to achieve this by using a MultiBindingBehavior like the following.
<source lang = "xml">
<DataTemplate
xmlns:Interactivity="using:Microsoft.Xaml.Interactivity"
xmlns:behaviors="using:UBIK.WinX.Behaviors">
...
<Grid>
<Interactivity:Interaction.Behaviors>
<behaviors:MultiBindingBehavior Converter="{StaticResource VisLogicAndConverter}" PropertyName="Visibility">
<behaviors:MultiBindingItem Value="{Binding MassEditViewModel, Converter={StaticResource NullToVisConverter}}" />
<behaviors:MultiBindingItem Value="{Binding Documents.Items.Count, Converter={StaticResource ItemCountToVisConverter}}" />
</behaviors:MultiBindingBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</DataTemplate>
</source>
The behavior makes sure the container Grid is set to Visibile only if the mass editing mode is not turned on (MassEditViewModel is null) and the context object has child document(s) (Documents.Items.Count is greater than 0. You can combine any number of binding results (MultiBindingItem) using the VisLogicAndConverter (the name should be self explanatory).

=== InvokeOnItemsCommand {{Version/WinXSince|3.6}} ===
Available on all ListViewModels, this command allows executing a specified command on a collection of list items. It can be used in combination with features such as [[Mass_Edit_(UBIK_WinX)|mass editing]] and [[XAML_Changes_in_UBIK_WinX_3.5#After_3.5|expression based collection filtering]]. Examples for both combinations are provided below.

{{Attention|The command specified through the "Command" parameter is executed on list items and, therefore, must be available in the list item contexts (view models). If in doubt, the [[Developer_Mode|developer mode]] can be used to inspect if a command is available in a certain context.}}

{{Hint|Parameter "Command" and "SelectedItemsOnly" are specific to the InvokeOnItemsCommand. What other parameters to define or whether to define them at all depends on the type of command to be executed on the items.}}

==== Invoke on selected items ====
This example demonstrates how you can use the mass editing feature to select certain objects from the child list and then execute the SetPropertyValueCommand for those selected.
* The example code assumes that the child objects have an editable property called "VALUE" and tries to set 50 as their value;
* You should insert the following code snippet into the default UBIKChildArea template;
* If the parameter "SelectedItemsOnly" is missed or set to "False", the command will be executed on all child items;
* To enable selection, click on the "Mass Edit" button below the property list.
<br />
<source lang = "xml">
<AppBarButton
xmlns:example="using:UBIK.WinX.Controls"
Command="{Binding Children.InvokeOnItemsCommand}"
Icon="AllApps"
Label="Set to 50%"
Style="{ThemeResource UBIKActionAppBarButton}">
<AppBarButton.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="Command" Value="SetPropertyValueCommand" />
<example:KeyValueParameter Key="SelectedItemsOnly" Value="True" />
<example:KeyValueParameter Key="PropertyName" Value="VALUE" />
<example:KeyValueParameter Key="PropertyValue" Value="50" />
</example:KeyValueList>
</AppBarButton.CommandParameter>
</AppBarButton>
</source>

==== Invoke on filtered results ====

{{Attention|To use a binding in the KeyValueParameter, it has to be applied like in the example provided here: [[KeyValueList]]}}

First, you need to setup a filtered list (ListCollectionView) in the Resources section of a UI element (e.g. Grid).
* This list is only available/visible within that UI element (the Grid in this case);
* The ItemsSource uses Children.Items. Use the [[Developer_Mode|developer mode]] if necessary to find out if this is available where you intend to define the list;
* The example expression filters for any items that don't contain the text "EXAMPLE" in their Title texts. You can filter differently by altering the expression.
<br />
<source lang = "xml">
<Grid xmlns:CV="using:UBIK.WinX.UI.CollectionView">
<Grid.Resources>
<CV:ListCollectionView
x:Key="Filtered"
Expression="!Item.Title.Contains("EXAMPLE")"
ItemsSource="{Binding Children.Items}" />
</Grid.Resources>
...
</Grid>
</source>
<br />
With the filtered list configured, you can then insert the following code snippet to execute the SetPropertyValueCommand for the filtered result items.
* The example code assumes that the child objects have an editable property called "VALUE" and tries to set 50 as their value;
* The "Filtered" refers to the ListCollectionView configured above.
<br />
<source lang = "xml">
<AppBarButton
xmlns:example="using:UBIK.WinX.Controls"
Command="{Binding Source={StaticResource Filtered}, Path=ListViewModel.InvokeOnItemsCommand}"
Icon="AllApps"
Label="Set to 50"
Style="{ThemeResource UBIKActionAppBarButton}">
<AppBarButton.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="Command" Value="SetPropertyValueCommand" />
<example:KeyValueParameter Key="PropertyName" Value="VALUE" />
<example:KeyValueParameter Key="PropertyValue" Value="50" />
</example:KeyValueList>
</AppBarButton.CommandParameter>
</AppBarButton>
</source>

[[Category:Client|XAML Tips]]
[[Category:WinX|XAML Tips]]

==== Support for old styled commands ====
Some old commands might not support KeyValueLists as parameters. In that case, just define the parameter value under the "CommandParameter" key, e.g.
<br />
<source lang = "xml"><example:KeyValueParameter Key="CommandParameter" Value="some string value for example" /></source>.
This single value is then passed as the command parameter instead of the entire KeyValueList.

=== SetPropertyValueCommand {{Version/WinXSince|3.6}} ===
{{Attention|To use a binding in the KeyValueParameter, it has to be applied like in the example provided here: [[KeyValueList]]}}

This command existed before but was implemented differently. In the newer version(s), it is improved to provide customizers more control over the things that happen during/after the property value changes.
The available commnad parameters are:
* PropertyName: the name of the property to set a new value to;
* PropertyValue: the value to be set to the above mentioned property;
* OnlyForUnvalidated (optional, defaults to false): When set to true, the value will only be set if the property is not yet validated;
* AutoSave (optional, defaults to false): When set to true, the change(s) will be saved to the local cache and database;
* AutoCommit (optional, defaults to false): When set to true, the change(s) will be committed to the server.

{{Hint|There's no way to commit changes without saving them locally first. Therefore, the "AutoSave" parameter will be ignored when "AutoCommit" is set to true.}}

Here's an example of the command usage. It tries to set the property called "VALUE" to a double value 50 regardless of its current state and then automatically save and commit the change.
<br />
<source lang = "xml">
<AppBarButton
xmlns:example="using:UBIK.WinX.Controls"
Command="{Binding SetPropertyValueCommand}"
Icon="Edit"
Label="Set to 50%"
Style="{ThemeResource UBIKActionAppBarButton}">
<AppBarButton.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="PropertyName" Value="VALUE" />
<example:KeyValueParameter Key="PropertyValue">
<example:KeyValueParameter.Value>
<x:Double>50</x:Double>
</example:KeyValueParameter.Value>
</example:KeyValueParameter>
<example:KeyValueParameter Key="OnlyForUnvalidated" Value="false" />
<example:KeyValueParameter Key="AutoSave" Value="true" />
<example:KeyValueParameter Key="AutoCommit" Value="true" />
</example:KeyValueList>
</AppBarButton.CommandParameter>
</AppBarButton>
</source>

{{Hint|It is advised to provide typed values like <nowiki><x:Double>50</x:Double></nowiki>. But for simple types, you can try writing them in the text format like <nowiki><example:KeyValueParameter Key="PropertyValue" Value="50" /></nowiki> and {{UBIK}} will try to find the right type.}}

[[Category:Client|XAML Tips]]
[[Category:WinX|XAML Tips]]

== Performance related ==

=== FlipView ===
When using the FlipView control in your XAML code, it's better to enable [https://docs.microsoft.com/en-us/windows/uwp/debug-test-perf/optimize-gridview-and-listview#ui-virtualization UI virtualization]. The difference in performance gets more obvious as the number of items in the FlipView increases. Here's how to enable it.

<source lang = "xml">
<FlipView
...
VirtualizingStackPanel.VirtualizationMode="Standard">
<Flipview.ItemsPanel>
<ItemsPanelTemplate>
<VirtualizingStackPanel Orientation="Horizontal" />
</ItemsPanelTemplate>
</Flipview.ItemsPanel>
</FlipView>
</source>

VirtualizingStackPanel.VirtualizationMode offers two possibilities: Standard & Recycling. In case you are interested, here are their [https://docs.microsoft.com/en-us/dotnet/api/system.windows.controls.virtualizationmode?view=netframework-4.7.2 differences].

[[Category:Client|XAML Tips]]
[[Category:WinX|XAML Tips]]

XAML Tips

2020-07-29T12:38:36Z

CWU: /* SetPropertyValueCommand {{Version/WinXSince|3.6}} */

== Functionality related ==

=== Attachable behaviors ===
It's quite often that you need to attach behaviors to certain XAML elements. For example, on a Grid, you want to attach a behavior which executes a command upon a Tapped event, or you want to execute a command when a certain property on a UBIK object changes.

Notice that in the following examples, "Interactivity" and "Core" are both namespaces and you have to make sure that they are defined at the root of your XAMLs:

<source lang = "xml">
<DataTemplate
...
xmlns:Core="using:Microsoft.Xaml.Interactions.Core"
xmlns:Interactivity="using:Microsoft.Xaml.Interactivity">
...
</DataTemplate>
</source>

==== Event Triggered ====
With an EventTriggerBehavior, you can react on changes/events of UI Elements:

<source lang = "xml">
<Grid>
<Interactivity:Interaction.Behaviors>
<Core:EventTriggerBehavior EventName="Tapped">
<Core:InvokeCommandAction Command="{Binding NavigateToChildrenCommand}" />
</Core:EventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</source>

==== Data Triggered ====
If you want to react on changes of the underlying data (ViewModel), you can use DataTriggerBehavior instead. The following example, when used in the ''UBIKSplashArea'' template, automatically navigates to the root objects once the login process is finished and the user was successfully authenticated:

<source lang = "xml">
<Grid>
<Interactivity:Interaction.Behaviors>
<Core:DataTriggerBehavior Binding="{Binding IsLoggedIn}" Value="True">
<Core:InvokeCommandAction Command="{Binding NavigateToRootPageCommand}" />
</Core:DataTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</source>

=== Fit mode ===
If you are using the standard app without XAML customizings, the [[UBIK_WinX_Client_Basics#Fit_Mode|fit mode]] feature should work out of the box.
However, when using a FlipView for displaying documents in your customized XAMLs, you must make sure to include the following binding to the FlipView's ItemTemplate so that the fit modes are properly applied.

<source lang = "xml">
<DataTemplate
...
xmlns:hs="using:UBIK.WinX.HotSpotting.Document">
...
<Grid.Resources>
...
<DataTemplate x:Key="FlipDocItemTemplate">
...
<hs:Document
...
FitMode="{Binding DocumentViewModel.FitMode}" />
</DataTemplate>
</Grid.Resources>
</DataTemplate>
</source>

=== Content creation ===
{{Version/WinXSince|3.5.5}}
To directly create an object on a child of the current object, you can define a Button as follows. The method "Item.IsTypeCreationAllowed" used in the expression gets the uid of the type that should be created below a child, if a child does not allow the creation of that type underneath it, the child will be hidden in the selection dialog. To actually create the object, the "CreateChildItemCommand" needs to be passed a KeyValueList with two parameters: The Parent-key is the ContentViewModel of the child underneath the object should be created, the Type-key is the type of object which should be created--this should match the uid passed to the "Item.IsTypeCreationAllowed" method.
<source lang = "xml">
<x:String x:Key="PlantMap">Item.IsTypeCreationAllowed("21fc990a-d064-4bee-8d48-3293351f827a")</x:String>
<cv:ListCollectionView x:Key="PlantMapView" Expression="{StaticResource PlantMap}" ItemsSource="{Binding Children.Items}" />

<AppBarButton>
<AppBarButton.Flyout>
<Flyout Placement="Full">
<ListView ItemsSource="{Binding Source={StaticResource PlantMapView}}">
<ListView.ItemTemplate>
<DataTemplate>
<Button Content="{Binding Header}" Command="{Binding CreateChildItemCommand}" x:Name="CreateButton" Tag="{Binding}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Parent" Value="{Binding Tag, ElementName=CreateButton}"/>
<uc:KeyValueParameter Key="Type" Value="21fc990a-d064-4bee-8d48-3293351f827a"/>
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</Flyout>
</AppBarButton.Flyout>
</AppBarButton>
</source>

<br/>
Additionally, the following optional parameters can be added as well.
* CreateOnly (optional, defaults to false): When set to true, the client will not automatically navigate to the created content, rather automatically save and commit it. If set to true, this overrides the following parameters;
* AutoNavigate (optional, defaults to true): When set to false, the client will not automatically navigate to the created content;
* AutoCommit (optional, defaults to false): When set to true, the change(s) will be saved to the local cache and the database, and then committed to the server.

=== Disable FilloutCriteria ===
{{Version/WinXSince|3.5}}
To enable/disable the automatic filtering of a query based on the ParentObject, there is the possibility to specify EnableFillOutCriteria--if it is not set, it defaults to false. Additionaly "SkipDialog" can be set to true, to not display a dialog.

<source lang="xml">
<Grid x:Name="selectionGrid" Tag="{Binding MetaUID}">
<Interactivity:Interaction.Behaviors>
<Core:EventTriggerBehavior EventName="Tapped">
<Core:InvokeCommandAction Command="{Binding ElementName=ChildAreaGrid, Path=DataContext.AddTemplatableDataCommand}" >
<Core:InvokeCommandAction.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Uid" Value="{Binding Tag,ElementName=selectionGrid}"/>
<uc:KeyValueParameter Key="EnableFillOutCriteria" Value="false"/>
<uc:KeyValueParameter Key="SkipDialog" Value="false"/>
</uc:KeyValueList>
</Core:InvokeCommandAction.CommandParameter>
</Core:InvokeCommandAction>
</Core:EventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</source>

=== Hotspotting ===

The hotspotting command is used for hotspotting as well as for annotating, to configure the button for hotspotting, the commandparameter "Mode" should be set to "HotSpotting", for annotating the "Mode" should be "Annotate". The parameter commit is optional, if set to true, the changes get automatically persisted when leaving the editing mode.

<source lang = "xml">
<AppBarToggleButton
IsChecked="{Binding EditingAnnotation, Mode=TwoWay}"
IsEnabled="{Binding IsAnnotatable}"
Command="{Binding HotSpottingCommand}">
<AppBarToggleButton.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Mode" Value="Annotate"/>
<uc:KeyValueParameter Key="Commit" Value="true"/>
</uc:KeyValueList>
</AppBarToggleButton.CommandParameter>
</AppBarToggleButton>
</source>

=== Remember scroll positions of list views ===

==== Version 3.7 & later {{Version/WinXSince|3.7}} ====
Starting from this version,
* The precision of scroll position remembering is improved(by pixel offsets instead of by items);
* It also works for other scrollable lists (instead of just for content object lists).
<br />
To enable this feature, you should make sure the following.
* The SelectionBoundListView is used instead of the standard ListView. Its {{UBIK}} namespace is <code>UBIK.WinX.Controls</code>;
* The SelectionBoundListView's <code>RememberScrollPosition</code> property is not set to "false"; (It's "true" by default.)
* The SelectionBoundListView's <code>x:Name</code> property value is unique.

==== Version 3.6 {{Version/WinXSince|3.6}} ====
The UBIK-Client does include a function to remember the position in a list (ListView) when navigating away from it. This function is only available when the list (ListView) has a unique name as a property (x:Name). When browsing back to the previously visited list UBIK scrolls back to the last position. The function does not save scroll positions over different sessions.
Implementing the function to remember the scroll position in a ListView one has to consider that the list elements (Children) could depend on a other UI-element. If the list elements do depend on a other UI-elemente, this element has to be created above the ListView in the XAML.

<source lang = "xml">
<DataTemplate xmlns:behaviors="using:UBIK.WinX.Behaviors" xmlns:uc="using:UBIK.WinX.Controls">
...
<uc:SelectionBoundListView x:Name="ChildListView">
<Interactivity:Interaction.Behaviors>
<behaviors:FirstVisibleItemPersistenceBehavior FirstVisibleItems="{Binding ScrollItems}" />
</Interactivity:Interaction.Behaviors>
</uc:SelectionBoundListView>
</DataTemplate>
</source>

[[Category:Client|XAML Tips]]
[[Category:WinX|XAML Tips]]

=== MultiBinding {{Version/WinXSince|3.6}} ===
Very often we want to display some UI elements (e.g. a Grid) depending on whether multiple criteria are met. It's much easier to achieve this by using a MultiBindingBehavior like the following.
<source lang = "xml">
<DataTemplate
xmlns:Interactivity="using:Microsoft.Xaml.Interactivity"
xmlns:behaviors="using:UBIK.WinX.Behaviors">
...
<Grid>
<Interactivity:Interaction.Behaviors>
<behaviors:MultiBindingBehavior Converter="{StaticResource VisLogicAndConverter}" PropertyName="Visibility">
<behaviors:MultiBindingItem Value="{Binding MassEditViewModel, Converter={StaticResource NullToVisConverter}}" />
<behaviors:MultiBindingItem Value="{Binding Documents.Items.Count, Converter={StaticResource ItemCountToVisConverter}}" />
</behaviors:MultiBindingBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</DataTemplate>
</source>
The behavior makes sure the container Grid is set to Visibile only if the mass editing mode is not turned on (MassEditViewModel is null) and the context object has child document(s) (Documents.Items.Count is greater than 0. You can combine any number of binding results (MultiBindingItem) using the VisLogicAndConverter (the name should be self explanatory).

=== InvokeOnItemsCommand {{Version/WinXSince|3.6}} ===
Available on all ListViewModels, this command allows executing a specified command on a collection of list items. It can be used in combination with features such as [[Mass_Edit_(UBIK_WinX)|mass editing]] and [[XAML_Changes_in_UBIK_WinX_3.5#After_3.5|expression based collection filtering]]. Examples for both combinations are provided below.

{{Attention|The command specified through the "Command" parameter is executed on list items and, therefore, must be available in the list item contexts (view models). If in doubt, the [[Developer_Mode|developer mode]] can be used to inspect if a command is available in a certain context.}}

{{Hint|Parameter "Command" and "SelectedItemsOnly" are specific to the InvokeOnItemsCommand. What other parameters to define or whether to define them at all depends on the type of command to be executed on the items.}}

==== Invoke on selected items ====
This example demonstrates how you can use the mass editing feature to select certain objects from the child list and then execute the SetPropertyValueCommand for those selected.
* The example code assumes that the child objects have an editable property called "VALUE" and tries to set 50 as their value;
* You should insert the following code snippet into the default UBIKChildArea template;
* If the parameter "SelectedItemsOnly" is missed or set to "False", the command will be executed on all child items;
* To enable selection, click on the "Mass Edit" button below the property list.
<br />
<source lang = "xml">
<AppBarButton
xmlns:example="using:UBIK.WinX.Controls"
Command="{Binding Children.InvokeOnItemsCommand}"
Icon="AllApps"
Label="Set to 50%"
Style="{ThemeResource UBIKActionAppBarButton}">
<AppBarButton.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="Command" Value="SetPropertyValueCommand" />
<example:KeyValueParameter Key="SelectedItemsOnly" Value="True" />
<example:KeyValueParameter Key="PropertyName" Value="VALUE" />
<example:KeyValueParameter Key="PropertyValue" Value="50" />
</example:KeyValueList>
</AppBarButton.CommandParameter>
</AppBarButton>
</source>

==== Invoke on filtered results ====
First, you need to setup a filtered list (ListCollectionView) in the Resources section of a UI element (e.g. Grid).
* This list is only available/visible within that UI element (the Grid in this case);
* The ItemsSource uses Children.Items. Use the [[Developer_Mode|developer mode]] if necessary to find out if this is available where you intend to define the list;
* The example expression filters for any items that don't contain the text "EXAMPLE" in their Title texts. You can filter differently by altering the expression.
<br />
<source lang = "xml">
<Grid xmlns:CV="using:UBIK.WinX.UI.CollectionView">
<Grid.Resources>
<CV:ListCollectionView
x:Key="Filtered"
Expression="!Item.Title.Contains("EXAMPLE")"
ItemsSource="{Binding Children.Items}" />
</Grid.Resources>
...
</Grid>
</source>
<br />
With the filtered list configured, you can then insert the following code snippet to execute the SetPropertyValueCommand for the filtered result items.
* The example code assumes that the child objects have an editable property called "VALUE" and tries to set 50 as their value;
* The "Filtered" refers to the ListCollectionView configured above.
<br />
<source lang = "xml">
<AppBarButton
xmlns:example="using:UBIK.WinX.Controls"
Command="{Binding Source={StaticResource Filtered}, Path=ListViewModel.InvokeOnItemsCommand}"
Icon="AllApps"
Label="Set to 50"
Style="{ThemeResource UBIKActionAppBarButton}">
<AppBarButton.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="Command" Value="SetPropertyValueCommand" />
<example:KeyValueParameter Key="PropertyName" Value="VALUE" />
<example:KeyValueParameter Key="PropertyValue" Value="50" />
</example:KeyValueList>
</AppBarButton.CommandParameter>
</AppBarButton>
</source>

==== Support for old styled commands ====
Some old commands might not support KeyValueLists as parameters. In that case, just define the parameter value under the "CommandParameter" key, e.g.
<br />
<source lang = "xml"><example:KeyValueParameter Key="CommandParameter" Value="some string value for example" /></source>.
This single value is then passed as the command parameter instead of the entire KeyValueList.

=== SetPropertyValueCommand {{Version/WinXSince|3.6}} ===
{{Attention|To use a binding in the KeyValueParameter, it has to be applied like in the example provided here: [[KeyValueList]]}}

This command existed before but was implemented differently. In the newer version(s), it is improved to provide customizers more control over the things that happen during/after the property value changes.
The available commnad parameters are:
* PropertyName: the name of the property to set a new value to;
* PropertyValue: the value to be set to the above mentioned property;
* OnlyForUnvalidated (optional, defaults to false): When set to true, the value will only be set if the property is not yet validated;
* AutoSave (optional, defaults to false): When set to true, the change(s) will be saved to the local cache and database;
* AutoCommit (optional, defaults to false): When set to true, the change(s) will be committed to the server.

{{Hint|There's no way to commit changes without saving them locally first. Therefore, the "AutoSave" parameter will be ignored when "AutoCommit" is set to true.}}

Here's an example of the command usage. It tries to set the property called "VALUE" to a double value 50 regardless of its current state and then automatically save and commit the change.
<br />
<source lang = "xml">
<AppBarButton
xmlns:example="using:UBIK.WinX.Controls"
Command="{Binding SetPropertyValueCommand}"
Icon="Edit"
Label="Set to 50%"
Style="{ThemeResource UBIKActionAppBarButton}">
<AppBarButton.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="PropertyName" Value="VALUE" />
<example:KeyValueParameter Key="PropertyValue">
<example:KeyValueParameter.Value>
<x:Double>50</x:Double>
</example:KeyValueParameter.Value>
</example:KeyValueParameter>
<example:KeyValueParameter Key="OnlyForUnvalidated" Value="false" />
<example:KeyValueParameter Key="AutoSave" Value="true" />
<example:KeyValueParameter Key="AutoCommit" Value="true" />
</example:KeyValueList>
</AppBarButton.CommandParameter>
</AppBarButton>
</source>

{{Hint|It is advised to provide typed values like <nowiki><x:Double>50</x:Double></nowiki>. But for simple types, you can try writing them in the text format like <nowiki><example:KeyValueParameter Key="PropertyValue" Value="50" /></nowiki> and {{UBIK}} will try to find the right type.}}

[[Category:Client|XAML Tips]]
[[Category:WinX|XAML Tips]]

== Performance related ==

=== FlipView ===
When using the FlipView control in your XAML code, it's better to enable [https://docs.microsoft.com/en-us/windows/uwp/debug-test-perf/optimize-gridview-and-listview#ui-virtualization UI virtualization]. The difference in performance gets more obvious as the number of items in the FlipView increases. Here's how to enable it.

<source lang = "xml">
<FlipView
...
VirtualizingStackPanel.VirtualizationMode="Standard">
<Flipview.ItemsPanel>
<ItemsPanelTemplate>
<VirtualizingStackPanel Orientation="Horizontal" />
</ItemsPanelTemplate>
</Flipview.ItemsPanel>
</FlipView>
</source>

VirtualizingStackPanel.VirtualizationMode offers two possibilities: Standard & Recycling. In case you are interested, here are their [https://docs.microsoft.com/en-us/dotnet/api/system.windows.controls.virtualizationmode?view=netframework-4.7.2 differences].

[[Category:Client|XAML Tips]]
[[Category:WinX|XAML Tips]]

KeyValueList

2020-07-29T12:34:26Z

CWU: /* Example */

{{XAMLControlInfoBox
| title = {{PAGENAME}}
| name = {{PAGENAME}}
| namespace= UBIK.WinX.Controls
| image = [[File:SY_{{PAGENAME}}.png|220px]]
| imagecaption = imagecaption
| purpose = Define a complex parameter type in XAML
| version = 3.5+
}}

== Usage ==
The KeyValueList controls allows to declare a complex parameter type from within XAML markup. It can hold any number of KeyValueParameter elements, where each consists of a string Key and and associated value.

=== Example ===
The following example shows how to use the control with two parameters in conjunction with the NavigateToGuidCommand. The first parameter specifies the Guid of the target document and the second parameter specifies the HotSpot that should be highlighted on that very document. This example needs a namespace declaration ''xmlns:ctrls="using:UBIK.WinX.Controls"''
<source lang = "xml">
<Button Command="{Binding NavigateToGuidCommand}" Content="Test">
<Button.CommandParameter>
<ctrls:KeyValueList>
<ctrls:KeyValueParameter Key="Guid" Value="c9ad0e93-395a-4b4e-a526-fb5d5e42f8ff" />
<ctrls:KeyValueParameter Key="HotSpot" Value="b9e855f9-d3be-4b60-b4e3-19398f5925b5" />
</ctrls:KeyValueList>
</Button.CommandParameter>
</Button>
</source>

'''To use a Binding in the KeyValueParameter, the following logic has to be used, instead of applying the binding directly on the Value property'''

<source lang = "xml">
<Button Content="{Binding Header}" Command="{Binding CreateChildItemCommand}" x:Name="CreateButton" Tag="{Binding}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Parent" Value="{Binding Tag, ElementName=CreateButton}"/>
<uc:KeyValueParameter Key="Type" Value="21fc990a-d064-4bee-8d48-3293351f827a"/>
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
</source>

[[Category:Pages with broken file links|KeyValueList]]

== Parameters ==
KeyValueParameter can be added as child objects to an KeyValueList control. Each parameter object needs a unique ''Key'' and a ''Value'', where the latter can be either a constant or dynamic value supplied through a binding.

==See also==
* [[XAML]]

[[Category:Pages with broken file links|KeyValueList]]

Version 3.7 (WinX)

2020-06-30T09:48:03Z

CWU: /* Build History */

= Initial Release =

=== New features ===
* The UBIK client can now automatically use UI customizings deployed from the server. Details can be found [[Deploy_UI_Customizings_(Client)|here]].

=== Enhancements ===
* [[SYSCLS_UNLOCK_GROUP_BY_SCAN|Unlock group by scan]] feature no longer locks items that don't have an UNLOCK_CODE set.

=== Bugfixes ===
* Fixed a memory leak issue when viewing 3D models in the app.
* Fixed an issue where created content is not automatically committed if the navigation is skipped.
* Fixed an issue where unwanted values are assigned during the data/template replications.
* Fixed the not working template selection button in the default XAML template.

=== Known issues ===
* Project specific resources defined in UBIKThemes might not take effect immediately after switching profiles. Restarting the app solves the problem.
* If a device has multiple cameras of exactly the same model (e.g. Microsoft HD 3000), the wrong one might be used during remote support calls.
* The AR Marker related features are resource intense and can cause the app to slow down on weaker tablets.
* Sometimes after an external bluetooth RFID scanner is disconnected, the app still incorrectly recognizes it as available.
* It's not possible to interact with an online document in a flip view. This will be fixed in the next build. Until then, a workaround is to customize the default UBIKDetailsArea template. Find the one and only Canvas control in it and change its Visibility property value to <code>"{Binding DataContext.HotSpotViewModel.DocumentScanMode, ElementName=ChildFlipView, Converter={StaticResource BoolToVisConverter}, FallbackValue=Collapsed}"</code>
<br />

= Build History =
* 3.7.3 on 2020-03-27
** Initial release.
* 3.7.6 on 2020-04-16
** Improved the precision of remembered list view scroll positions and fixe an issue where it sometimes stops working.
* 3.7.10 on 2020-06-30
** Fixed an issue where AR items (e.g. POIs, map pins) are not correctly updated after switching POI groups.
** Fixed an issue where scanning sometimes does not work until toggling the scan switches.
** Fixed an issue where live values are sometimes not received on the clients (when the live value attributes are configured as null).
** Fixed an issue where users could not swipe across documents in the gallery/flipview using gestures.
** Fixed an issue where documents in the gallery/flipview was contantly moving slightly up and down.
* 3.7.11 on 2020-07-30
** RootPage is now fully customizable via UBIKRootArea.xml

<headertabs />

{{Category/Version2|{{PAGENAME}}}}

[[Category:Client|Version 3.7 (WinX)]]
[[Category:Version 3.7|Version 3.7 (WinX)]]
[[Category:WinX|Version 3.7 (WinX)]]

Mobile XAML

2020-04-14T09:33:54Z

CWU: /* SfListViewExt */

The User Interface of the Xamarin Clients (Android, iOS, new UWP) can be fundamentally customized using custom XAML definitions. This customization process is heavily influenced by the [[XAML|XAML Customization Process on the WinX Client]].

= Basics =
There are predefined XAML templates available that can be customized. If no customizing is found, the default templates will be used.

== Default XAMLs ==
All default XAML templates that can be customized are available through the Xamarin.UWP client. You need to go to the app settings and click the "Unpack default XAMLs" button.

== Differences to WinX/UWP ==
* Since it's based on the Xamarin XAML dialect, you CANNOT use any existing XAML customizings for the WinX/UWP app;
* Namespace definitions must include the corresponding assembly names;
* XAML template files have the extension name of '''xamlx''' instead of '''xaml''';
* You can deploy only those resources that you want to customize. (This is also the case for newer versions of WinX/UWP. {{Version/WinXSince|3.6}})

= Overriding default XAMLs=
On Windows (WinX/UWP), the <code>[App Package Folder]/LocalState/xaml/</code> folder can be accessed by the user and the customized XAML files directly added. An alternative to this on all platforms (including Android, iOS, etc.) is to use the ''Import Customizing'' button in the app settings to import the templates, styles, images, etc. (file by file, or all files within a zip package). The changes should be reflected in the UI (except the current page) without restarting the app. After directly editing the customizings (Xamarin.UWP), you can also use the "Reload customizing" button without restarting the app.

In the following, we're going to override the default light theme color of the app:
* Unpack the default XAMLs;
* Pick and deploy the default UBIKThemes.xamlx to the '''xaml''' folder inside the ''LocalState'' folder;
* Open it with the text editor of your choice and remove everything within the '''ResouceDictionary''' except <code><Color x:Key="UBIKLightThemeColor">blue</Color></code>;
* Save the changes and reload. You should see changes successfully implemented.

{{Attention| For maintainability reasons, it's HIGHLY recommended to deploy only those XAML resources you want to override. For example, if you only want to customize the UBIKChildArea, don't deploy others like the UBIKMenuArea. If you only want to customize the UBIKChildItem, that's the only content you should include in the UBIKThemes.}}

== Custom Templates ==
Custom templates can be added, just like on the WinX/UWP client. Make sure to include all '''namespace definitions''' (as attributes of the '''ContentView''' tag), otherwise the custom template will not load.

Similar to the ''UBIKThemes.xamlx'' file, custom or overridden templates start with a <code><ContentView></code> tag containing all '''namespaces'''. <code><ContentView.Resources></code> takes a '''ResourceDictionary''' and contains resources like references to converters. Finally, <code><ContentView.Content></code> contains the actual layout content (it's best to start with a '''Grid'''). Again, don't forget to add namespaces that you need!

Templates can also be defined in ''UBIKThemes.xamlx''. In this case, they need to be added into the <code><ResourceDictionary></code> inside the <code><ContentView.Resources></code> template as a <code><DataTemplate></code>. Similarly, if you want to split up the templates into seperate files, you need to make sure to follow the steps mentioned above and get the content of the <code><DataTemplate></code> into the <code><ContentView.Content></code> tag.

{{Attention|Templates defined in separate files will override templates defined in the ''UBIKThemes.xamlx''!}}

== Adding Images ==
Images can't be loaded with the default '''Image''' tag, as the image is on different paths on each operating system.

Therefore, there's a custom '''FileImage''' that internally overrides the default ''Image'' with two custom parameters:
* '''FolderName''' ...The name of the '''folder''' in the '''local folder'''. Only the first level inside the ''LocalState'' folder seems to work.
* '''FileName''' ...The name of the '''file''' in the said folder.

Make sure to implement the proper namespace as well by adding
<code>xmlns:fimage="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL"</code> into the root item's attributes.

Then, the image can be loaded using:<br/>
<code><fimage:FileImage FileName="image.png" FolderName="xaml"/></code>

This snipped loads the image called '''image.png''' located in the '''xaml''' folder inside the ''LocalState''.

Furthermore, the ''FileImage'' tag doesn't seem to support most attributes. Therefore place it inside a '''Grid''' to achieve a perfect layout.

== Converters==
:''Main Page: [[Converters_In_Xamarin]]''

They are used to convert specific data into some desired output, using custom logic.

Consider the following example:<br/>
A label saying ''There are no children items available!'' should only be visible if the number of children-items is 0.

= Advanced =

== Feature related ==

=== Content filtering ===
For the Xamarin clients, an "SfDataSourceExt" type is available for filtering list of items using defined expressions.<br />
The following example demonstrates how to filter for child items having certain property values. The filtered list and its count can be displayed in the UI.<br />
<syntaxhighlight lang="xml">
<ContentView
xmlns:controls="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL"
...>
<ContentView.Resources>
<ResourceDictionary>
<x:String x:Key="Expresssion">Item.Values["MP_YEAR"].Contains("2019")</x:String>
<controls:SfDataSourceExt x:Key="FilteredList" Expression="{StaticResource Expresssion}" ItemsSource="{Binding Children.Items}" Unloaded="{Binding SkipFiltering}" />
</ResourceDictionary>
</ContentView.Resources>
<StackLayout Orientation="Vertical">
<Label Text="{Binding DisplayItemsCount, Source={StaticResource FilteredList}}" />
<controls:SfListViewExt ItemsSource="{Binding DisplayItems, Source={StaticResource FilteredList}}" />
</StackLayout>
</ContentView>
</syntaxhighlight>

=== Search ===
In the default UBIKMenuArea.xamlx (where the search UI is hosted), there are two commands associated with two events. See below.
<syntaxhighlight lang="xml">
<SearchBar ...>
<SearchBar.Behaviors>
<behaviors:EventToCommandBehavior
Command="{Binding FreeTextSearchCommand}"
CommandParameter="{Binding Path=Text, Source={x:Reference SearchField}}"
EventName="SearchButtonPressed" />
<behaviors:EventToCommandBehavior Command="{Binding DelayedFreeTextSearchCommand}" EventName="TextChanged" />
</SearchBar.Behaviors>
</SearchBar>
</syntaxhighlight>
<br />
The one for <code>SearchButtonPressed</code> is responsible for executing searches after the user confirms the input (e.g. pressing {{{keypress|Enter}}} or the search button).
<br />
The one for <code>TextChanged</code> is responsible for the "search as you type" behavior. Namely it triggers an automatic search shortly (half second) after the user stops changing the text in the search bar. It can be turned off by simply removing that particular behavior.

== Performance ==
To get a good performance in the app UI when using your Xaml customizings, it is recommended to try the following.
* Always keep your UI structure simple. Choose the most efficient layouts for the scenarios and avoid unnecessary UI elements. Please refer to [https://docs.microsoft.com/en-us/xamarin/xamarin-forms/deploy-test/performance#choose-the-correct-layout "choose the correct layout"] and [https://docs.microsoft.com/en-us/xamarin/xamarin-forms/deploy-test/performance#reduce-the-visual-tree-size "reduce the visual tree size"];
* Turn on [https://docs.microsoft.com/en-us/xamarin/xamarin-forms/user-interface/layouts/layout-compression layout compression] on wrapping elements that don't have any visual parameters set (reasons stated in the linked documentation).
{{Hint|There is a default "HeadlessLayout" style available in the app you can use on elements such as Grids, StackLayouts, ContentViews, etc. It turns on layout compression on the applied elements in Xamarin.Android (since we find it not worth the effort in Xamarin.iOS).}}
{{Attention|If possible, one should always favor designing the UI with less wrapping elements over turning on layout compression on unnecessary ones.}}

=== Layout compression examples ===
<syntaxhighlight lang="xml">
<ContentView ControlTemplate="{DynamicResource ChangedSymbol}" Style="{DynamicResource HeadlessLayout}" />
</syntaxhighlight>
The code above removes one wrapping element added automatically by the ContentView and demonstrates a good reason to use layout compression because it can not be avoided otherwise.
<syntaxhighlight lang="xml">
<Grid Margin="2" Style="{DynamicResource HeadlessLayout}">
<Label Margin="5" Text="{Binding Title}" />
</Grid>
</syntaxhighlight>
This example, on the other hand, demonstrates a bad usage of layout compression because it can be easily achieved by better designs such as using only the Label with a merged margin.

Sometimes the content inside a compressed layout appears on a wrong z-index level. For eample:
<syntaxhighlight lang="xml">
<BoxView CornerRadius="14" HeightRequest="28" WidthRequest="28" Color="Red" />
<ContentView ControlTemplate="{DynamicResource Badge}" Style="{DynamicResource HeadlessLayout}">
<Label Text="{Binding Title}" />
</ContentView >
</syntaxhighlight>
According to the order of the BoxView and the Label, the latter should appear on top of the former (later ones have higher z-index levels). However, this can be disturbed by layout compression, causing the exact opposite.
In this case, you can add a <code>xmlns:android="clr-namespace:Xamarin.Forms.PlatformConfiguration.AndroidSpecific;assembly=Xamarin.Forms.Core"</code> namespace to your Xaml file and manually elevate the Label by specifying <code>android:VisualElement.Elevation="X"</code> on it accordingly (X is the delta of the z-index level you want).

=== SfListViewExt ===
For performance reasons, we created an extended version of the Syncfusion SfListView control and it should be used for all lists in customizings. You need to add a namespace like <code>xmlns:controls="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL"</code> to your Xaml file and use it like <code><controls:SfListViewExt ... /></code>.
{{Hint|Technically speaking, SfListViewExt informs item view models when their corresponding item views appear on / disappear from the screen. This way, view models can skip a lot of unnecessary work (on the UI) when their views are not visible. '''If SfListView is used instead, the item views will not reflect content changes until the page is reloaded/refreshed.'''}}

It is possible to configure the ListView, that the ScrollPosition is remembered when navigating away from the page, to do so, the property RembemberScrollPosition needs to be set to true:

<syntaxhighlight lang="xml">
<controls:SfListViewExt RememberScrollPosition="True"/>
</syntaxhighlight>

When using multiple Lists on one page (e.g. in a TabbedView), it is necessary to set the AutomationId property uniquely for each list on the page, to support the remembering of the ScrollPosition.

[[Category:Client|Xamarin XAML]]
[[Category:Pages with broken file links|Xamarin XAML]]
[[Category:Styling|Xamarin XAML]]
[[Category:Xamarin|Xamarin XAML]]

Version 1.0 (Xamarin.Android)

2020-03-24T10:21:49Z

CWU: /* Build history */

= Release notes =
Initial release (1.0) of the Xamarin.Android app.
* It's available in the Google Play Store ([https://play.google.com/store/apps/details?id=com.augmensys.ubik link]).
* If subscribed in our App Center distribution channel, you can also download through email notifications.

== Build history ==
* 1.0.69 on 2019-10-21
** Initial release.
* 1.0.71 on 2019-10-28
** Syncfusion chart control (https://help.syncfusion.com/xamarin/sfchart/getting-started#initialize-chart) can now be used in XAML customizings;
** Added confirmation before deleting XAML customizings;
** Fixed an issue where the progress bar was not shown on workpackages.
* 1.0.72 on 2019-10-29
** Improved the stability of the client;
** In case of errors in XAML customizings, the client now provides more useful information (e.g. name of the customizing, line number, error) for easy trouble-shooting;
** Fixed an issue where lists were often missing an item (the first one) after applying filters.
* 1.0.73 on 2019-11-04
** Fixed an issue where importing customizings didn't work on some devices;
** Fixed an issue where content filtering stopped working on the root page after navigating back.
* 1.0.74 on 2019-11-13
** Fixed an issue where the configurable content filtering sometimes stops working.
* 1.0.76 on 2020-03-23
** Added RememberScrollPosition property to [[Xamarin_XAML#SfListViewExt|SfListViewExt]] control

[[Category:Client|Version 1.0 (Xamarin.Android)]]
[[Category:Version 1.0|Version 1.0 (Xamarin.Android)]]
[[Category:Xamarin|Version 1.0 (Xamarin.Android)]]

== Known issues ==
* Branch download might be paused if the device goes into sleep mode without a power source attached and will only resume if the device screen is unlocked again. We are aware of this issue and will improve it in the future versions.
* When editing the value of a double property in landscape mode characters other then numbers are not displayed but still remain in the string.

= XAML =
[[Xamarin_XAML|Some basic information]] to get you started on the XAML customizing topic.

To stop the re-evaluation of not needed filters, the SfDataSourceExt has a Property "Unloaded" which stops the filtering if set to true. For details see: [https://wiki.augmensys.com/index.php?title=Xamarin_XAML#Content_filtering]. This increases the performance of filtered lists.

[[Category:Client|Version 1.0 (Xamarin.Android)]]
[[Category:Version 1.0|Version 1.0 (Xamarin.Android)]]
[[Category:Xamarin|Version 1.0 (Xamarin.Android)]]

Version 1.0 (Xamarin.iOS)

2020-03-24T10:21:28Z

CWU: /* Build history */

= Release notes =
Initial release (1.0) of the Xamarin.iOS app.
* It's available in the Apple App Store.
* If subscribed in our App Center distribution channel, you can also download through email notifications.

== Build history ==
* 1.0.73 on 2019-11-04
** Initial release.
* 1.0.74 on 2019-11-13
** Fixed an issue where the configurable content filtering sometimes stops working;
** Improved app stability.
* 1.0.76 on 2020-03-23
** Added RememberScrollPosition property to [[Xamarin_XAML#SfListViewExt|SfListViewExt]] control

[[Category:Client|Version 1.0 (Xamarin.iOS)]]
[[Category:Version 1.0|Version 1.0 (Xamarin.iOS)]]
[[Category:Xamarin|Version 1.0 (Xamarin.iOS)]]

== Known issues ==
* Branch download might be paused if the device goes into sleep mode without a power source attached and will only resume if the device screen is unlocked again. We are aware of this issue and will improve it in the future versions.
* When editing the value of a double property in landscape mode characters other then numbers are not displayed but still remain in the string.

= XAML =
[[Xamarin_XAML|Some basic information]] to get you started on the XAML customizing topic.

To stop the re-evaluation of not needed filters, the SfDataSourceExt has a Property "Unloaded" which stops the filtering if set to true. For details see: [https://wiki.augmensys.com/index.php?title=Xamarin_XAML#Content_filtering]. This increases the performance of filtered lists.

[[Category:Client|Version 1.0 (Xamarin.iOS)]]
[[Category:Version 1.0|Version 1.0 (Xamarin.iOS)]]
[[Category:Xamarin|Version 1.0 (Xamarin.iOS)]]

Mobile XAML

2020-03-24T10:18:40Z

CWU: /* SfListViewExt */

The User Interface of the Xamarin Clients (Android, iOS, new UWP) can be fundamentally customized using custom XAML definitions. This customization process is heavily influenced by the [[XAML|XAML Customization Process on the WinX Client]].

= Basics =
There are predefined XAML templates available that can be customized. If no customizing is found, the default templates will be used.

== Default XAMLs ==
All default XAML templates that can be customized are available through the Xamarin.UWP client. You need to go to the app settings and click the "Unpack default XAMLs" button.

== Differences to WinX/UWP ==
* Since it's based on the Xamarin XAML dialect, you CANNOT use any existing XAML customizings for the WinX/UWP app;
* Namespace definitions must include the corresponding assembly names;
* XAML template files have the extension name of '''xamlx''' instead of '''xaml''';
* You can deploy only those resources that you want to customize. (This is also the case for newer versions of WinX/UWP. {{Version/WinXSince|3.6}})

= Overriding default XAMLs=
On Windows (WinX/UWP), the <code>[App Package Folder]/LocalState/xaml/</code> folder can be accessed by the user and the customized XAML files directly added. An alternative to this on all platforms (including Android, iOS, etc.) is to use the ''Import Customizing'' button in the app settings to import the templates, styles, images, etc. (file by file, or all files within a zip package). The changes should be reflected in the UI (except the current page) without restarting the app. After directly editing the customizings (Xamarin.UWP), you can also use the "Reload customizing" button without restarting the app.

In the following, we're going to override the default light theme color of the app:
* Unpack the default XAMLs;
* Pick and deploy the default UBIKThemes.xamlx to the '''xaml''' folder inside the ''LocalState'' folder;
* Open it with the text editor of your choice and remove everything within the '''ResouceDictionary''' except <code><Color x:Key="UBIKLightThemeColor">blue</Color></code>;
* Save the changes and reload. You should see changes successfully implemented.

{{Attention| For maintainability reasons, it's HIGHLY recommended to deploy only those XAML resources you want to override. For example, if you only want to customize the UBIKChildArea, don't deploy others like the UBIKMenuArea. If you only want to customize the UBIKChildItem, that's the only content you should include in the UBIKThemes.}}

== Custom Templates ==
Custom templates can be added, just like on the WinX/UWP client. Make sure to include all '''namespace definitions''' (as attributes of the '''ContentView''' tag), otherwise the custom template will not load.

Similar to the ''UBIKThemes.xamlx'' file, custom or overridden templates start with a <code><ContentView></code> tag containing all '''namespaces'''. <code><ContentView.Resources></code> takes a '''ResourceDictionary''' and contains resources like references to converters. Finally, <code><ContentView.Content></code> contains the actual layout content (it's best to start with a '''Grid'''). Again, don't forget to add namespaces that you need!

Templates can also be defined in ''UBIKThemes.xamlx''. In this case, they need to be added into the <code><ResourceDictionary></code> inside the <code><ContentView.Resources></code> template as a <code><DataTemplate></code>. Similarly, if you want to split up the templates into seperate files, you need to make sure to follow the steps mentioned above and get the content of the <code><DataTemplate></code> into the <code><ContentView.Content></code> tag.

{{Attention|Templates defined in separate files will override templates defined in the ''UBIKThemes.xamlx''!}}

== Adding Images ==
Images can't be loaded with the default '''Image''' tag, as the image is on different paths on each operating system.

Therefore, there's a custom '''FileImage''' that internally overrides the default ''Image'' with two custom parameters:
* '''FolderName''' ...The name of the '''folder''' in the '''local folder'''. Only the first level inside the ''LocalState'' folder seems to work.
* '''FileName''' ...The name of the '''file''' in the said folder.

Make sure to implement the proper namespace as well by adding
<code>xmlns:fimage="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL"</code> into the root item's attributes.

Then, the image can be loaded using:<br/>
<code><fimage:FileImage FileName="image.png" FolderName="xaml"/></code>

This snipped loads the image called '''image.png''' located in the '''xaml''' folder inside the ''LocalState''.

Furthermore, the ''FileImage'' tag doesn't seem to support most attributes. Therefore place it inside a '''Grid''' to achieve a perfect layout.

== Converters==
:''Main Page: [[Converters_In_Xamarin]]''

They are used to convert specific data into some desired output, using custom logic.

Consider the following example:<br/>
A label saying ''There are no children items available!'' should only be visible if the number of children-items is 0.

= Advanced =

== Feature related ==

=== Content filtering ===
For the Xamarin clients, an "SfDataSourceExt" type is available for filtering list of items using defined expressions.<br />
The following example demonstrates how to filter for child items having certain property values. The filtered list and its count can be displayed in the UI.<br />
<syntaxhighlight lang="xml">
<ContentView
xmlns:controls="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL"
...>
<ContentView.Resources>
<ResourceDictionary>
<x:String x:Key="Expresssion">Item.Values["MP_YEAR"].Contains("2019")</x:String>
<controls:SfDataSourceExt x:Key="FilteredList" Expression="{StaticResource Expresssion}" ItemsSource="{Binding Children.Items}" Unloaded="{Binding SkipFiltering}" />
</ResourceDictionary>
</ContentView.Resources>
<StackLayout Orientation="Vertical">
<Label Text="{Binding DisplayItemsCount, Source={StaticResource FilteredList}}" />
<controls:SfListViewExt ItemsSource="{Binding DisplayItems, Source={StaticResource FilteredList}}" />
</StackLayout>
</ContentView>
</syntaxhighlight>

=== Search ===
In the default UBIKMenuArea.xamlx (where the search UI is hosted), there are two commands associated with two events. See below.
<syntaxhighlight lang="xml">
<SearchBar ...>
<SearchBar.Behaviors>
<behaviors:EventToCommandBehavior
Command="{Binding FreeTextSearchCommand}"
CommandParameter="{Binding Path=Text, Source={x:Reference SearchField}}"
EventName="SearchButtonPressed" />
<behaviors:EventToCommandBehavior Command="{Binding DelayedFreeTextSearchCommand}" EventName="TextChanged" />
</SearchBar.Behaviors>
</SearchBar>
</syntaxhighlight>
<br />
The one for <code>SearchButtonPressed</code> is responsible for executing searches after the user confirms the input (e.g. pressing {{{keypress|Enter}}} or the search button).
<br />
The one for <code>TextChanged</code> is responsible for the "search as you type" behavior. Namely it triggers an automatic search shortly (half second) after the user stops changing the text in the search bar. It can be turned off by simply removing that particular behavior.

== Performance ==
To get a good performance in the app UI when using your Xaml customizings, it is recommended to try the following.
* Always keep your UI structure simple. Choose the most efficient layouts for the scenarios and avoid unnecessary UI elements. Please refer to [https://docs.microsoft.com/en-us/xamarin/xamarin-forms/deploy-test/performance#choose-the-correct-layout "choose the correct layout"] and [https://docs.microsoft.com/en-us/xamarin/xamarin-forms/deploy-test/performance#reduce-the-visual-tree-size "reduce the visual tree size"];
* Turn on [https://docs.microsoft.com/en-us/xamarin/xamarin-forms/user-interface/layouts/layout-compression layout compression] on wrapping elements that don't have any visual parameters set (reasons stated in the linked documentation).
{{Hint|There is a default "HeadlessLayout" style available in the app you can use on elements such as Grids, StackLayouts, ContentViews, etc. It turns on layout compression on the applied elements in Xamarin.Android (since we find it not worth the effort in Xamarin.iOS).}}
{{Attention|If possible, one should always favor designing the UI with less wrapping elements over turning on layout compression on unnecessary ones.}}

=== Layout compression examples ===
<syntaxhighlight lang="xml">
<ContentView ControlTemplate="{DynamicResource ChangedSymbol}" Style="{DynamicResource HeadlessLayout}" />
</syntaxhighlight>
The code above removes one wrapping element added automatically by the ContentView and demonstrates a good reason to use layout compression because it can not be avoided otherwise.
<syntaxhighlight lang="xml">
<Grid Margin="2" Style="{DynamicResource HeadlessLayout}">
<Label Margin="5" Text="{Binding Title}" />
</Grid>
</syntaxhighlight>
This example, on the other hand, demonstrates a bad usage of layout compression because it can be easily achieved by better designs such as using only the Label with a merged margin.

Sometimes the content inside a compressed layout appears on a wrong z-index level. For eample:
<syntaxhighlight lang="xml">
<BoxView CornerRadius="14" HeightRequest="28" WidthRequest="28" Color="Red" />
<ContentView ControlTemplate="{DynamicResource Badge}" Style="{DynamicResource HeadlessLayout}">
<Label Text="{Binding Title}" />
</ContentView >
</syntaxhighlight>
According to the order of the BoxView and the Label, the latter should appear on top of the former (later ones have higher z-index levels). However, this can be disturbed by layout compression, causing the exact opposite.
In this case, you can add a <code>xmlns:android="clr-namespace:Xamarin.Forms.PlatformConfiguration.AndroidSpecific;assembly=Xamarin.Forms.Core"</code> namespace to your Xaml file and manually elevate the Label by specifying <code>android:VisualElement.Elevation="X"</code> on it accordingly (X is the delta of the z-index level you want).

=== SfListViewExt ===
For performance reasons, we created an extended version of the Syncfusion SfListView control and it should be used for all lists in customizings. You need to add a namespace like <code>xmlns:controls="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL"</code> to your Xaml file and use it like <code><controls:SfListViewExt ... /></code>.
{{Hint|Technically speaking, SfListViewExt informs item view models when their corresponding item views appear on / disappear from the screen. This way, view models can skip a lot of unnecessary work (on the UI) when their views are not visible. '''If SfListView is used instead, the item views will not reflect content changes until the page is reloaded/refreshed.'''}}

It is possible to configure the ListView, that the ScrollPosition is remembered when navigating away from the page, to do so, the property RembemberScrollPosition needs to be set to true:

<syntaxhighlight lang="xml">
<controls:SfListViewExt RememberScrollPosition="True"/>
</syntaxhighlight>

[[Category:Client|Xamarin XAML]]
[[Category:Pages with broken file links|Xamarin XAML]]
[[Category:Styling|Xamarin XAML]]
[[Category:Xamarin|Xamarin XAML]]

UBIK WinX Client Basics

2019-12-02T10:57:17Z

CWU: /* Linked objects */

{{UBIK}} Client is the mobile application for viewing and modifying data, showing documents, starting navigation, visualizing POIs and much more.

Client applications are available for Android and WinX, however the features available on each of the platform dependent applications might differ. An overview of the available features can be found in the [[Client_Feature_Table|feature comparison table]].

== Login ==
Users need to login in order to access confidential data, this can be done in the [[Login View]].

=== Confirm login ===
{{Version/WinXSince|3.6}}
Certain pages might require to confirm the login data, even if the user is already logged in. This can be done in the following way: The CheckUserOfflineCommand needs to be called with the username and password as parameter, if the login was valid, the CheckUserOfflineSuccess boolean property is set to true, which causes the text "Login confirmed" to appear in the example.

<source lang = "xml">
<TextBox
x:Name="Sign01User"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}"
PlaceholderText="User"
Text="{Binding UserName}" />
<PasswordBox
x:Name="Sign01PW"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}"
PlaceholderText="Password" />
<Button
Command="{Binding CheckUserOfflineCommand}"
Content="Confirm login"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="UserName" Value="{Binding ElementName=Sign01User, Path=Text}" />
<uc:KeyValueParameter Key="Password" Value="{Binding ElementName=Sign01PW, Path=Password}" />
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
<TextBlock Text="Login confirmed" Visibility="{Binding AuthenticationViewModel.CheckUserOfflineSuccess, Source={StaticResource Locator}, FallbackValue=false, Converter={StaticResource BoolToVisConverter}}" />
</source>

== Profiles ==
Profiles are used to store connection information for {{UBIK}} services. It specifies the location where to find the service along with other useful informations. Profiles are stored by UBIK whenever the user created connection information and stored it in the settings. However, profiles can also be created and edited with any text editor. Possible settings to be defined are:
* InternalConnectionSettings: Connections settings how to connect to the Content and the USAM service that has been set up.
** Application: the [[APPLICATION]] to use with the service
** AuthenticationPort: Port Number of the authentication (USAM) service (default: 777)
** AuthenticationProtocol: Protocol of the authentication service (default: https)
** AuthenticationServer: the ip address of the authentication server
** AuthenticationService: the path to the authentication service
** ContentPort: Port Number of the content service (default: 777)
** ContentProtocol: Protocol of the content service (default: https)
** ContentServer: the ip address of the content server
** ContentService: the path to the content service
** Context: the [[CONTEXT]] to use with the service
** SyncMode: the used sync mode (Online [= Auto], Manual, Offline; default:Online)
* IsDefault: true, if the profile should be the default profile
* Name: the name of the profile (will also be used to identify the database)
** If the profile name contains invalid characters like: /, ", <, >, ... they will be replaced with %_
* Project: the project name. Use this to share a single project name with more than one profile. If the project is defined, all profile with the same project will share one database.
* Customizing: the XAML subfolder to use for customized UI. This parameter can be used to share one single XAML customizing folder for multiple profiles.
* ShowHiddenSettings: show hidden settings (feault: false)

Example:
<source lang = "xml">
<?xml version="1.0" encoding="utf-8"?>
<Profile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UBIK.WinX.Settings">
<Customizing>MYAPPLICATIONUI</Customizing>
<Description i:nil="true" />
<InternalConnectionSettings>
<Application>APP_DEMO</Application>
<AuthenticationPort>777</AuthenticationPort>
<AuthenticationProtocol>https</AuthenticationProtocol>
<AuthenticationServer>80.243.175.50</AuthenticationServer>
<AuthenticationService>UBIK/DBG/AUG/DEMO.250/USAM/USAM.svc</AuthenticationService>
<ContentPort>777</ContentPort>
<ContentProtocol>https</ContentProtocol>
<ContentServer>80.243.175.50</ContentServer>
<ContentService>UBIK/DBG/AUG/DEMO.250/CONTENT/UBIKContent.svc</ContentService>
<Context>CXT_DEMO</Context>
<SyncMode>Online</SyncMode>
</InternalConnectionSettings>
<IsDefault>true</IsDefault>
<Name>DEMO.250.AT</Name>
<Project>DEMO.250</Project>
<ShowHiddenSettings>false</ShowHiddenSettings>
</Profile>
</source>

== Content Browser ==
Allows to navigate through the entire data model in a hierarchical manner, as it is published by the server.

Initially, a list of objects ("root objects") is shown. Upon selecting an object, a new browser is opened for that object, showing details about it. When an object is selected in the content browser, it is called the browser's context. For such a contextual object, child objects and selected properties are shown. Also, there is a context menu providing actions related to the currently selected object.

=== Status Bar ===
[[File:UI_WinX_DbSavingIndicator.PNG|300 px|thumb|border|alt=Saving Symbol|Saving Symbol]]
{{Version/WinXSince|2.5.4}}Whenever content is being saved into the local database (for example, after a branch is downloaded from the server), there will be a blinking symbol indicating the saving activity is happening in the background.
During that time, the user is advised to not logout or close the app because the content might be lost otherwise. However, it is okay to undertake other tasks such as browsing, editing or downloading branches.

=== Child Page ===

[[File:ChildPage.PNG|400 px|thumb|border|alt=Child Page|Child Page]]

The child page shows the context of a selected object.

The global status bar shows the icon, the name and the description of the selected object. An arrow on the left side allows the user to navigate back to the parent object. On the right side the currently logged-in user is indicated. By clicking on the username one is able to navigate back to the home screen or log off.

The right side of the child page shows child objects of the current object. Each child object is represented by an icon, a name and a description.

On the left side of the child page the current object´s high priority properties are shown. By clicking on a live value property, the live value details dialog opens. By clicking on an editable [[UBIK_WinX_Client_Basics#High_priority_properties| high priority property]], an editor opens {{Version/WinXSince|2.5.4}}. If a property was edited a save button is shown in the lower left corner, allowing the user to commit the changes. If a property of a query object was edited an evaluate button is shown in the lower left corner, allowing the user to run the query with the changed propery.

=== Details Page ===

=== Context Menu ===

=== Objects ===

==== Root objects vs child objects ====

The first entry point in the ''Content Browser'' is the list of root objects.

==== Task objects ====

==== Query objects ====

==== Safety relevant objects ====

==== Commissioning objects ====

==== Locked objects ====

=== Properties ===

==== Live value properties ====

==== High priority properties ====
High priority properties are properities having a priority higher than the [[Settings#Content |priority threshold]].

==== Selective List Properties ====

==== Properties with value records {{Version/WinXSince|2.5.4}} ====
[[File:UI_WinX_PropertyWithValueRecords.png|thumb|A property with value records]]
[[File:UI_WinX_PropertyValueRecords.png|thumb|Property value records dialog]]
In addition to its value, a property might also bring along a series of value records showing "who changed the value at what time".

When such records exist, the property row shows a special symbol on the right side. After a right click (with mouse) or a long tap (with touch) on the property row, a dialog will be shown to present these records (sorted by their time, recent ones on top).

{{Clear}}

==== Editors ====

===== Geo Editor & Teach In =====

==== Guid editor ====
[[File:Guid_property_dialog.PNG|thumb|border|alt=Guid property editor dialog|Guid property editor dialog]]

To edit Guid properties (that do not have a selective list available), we have implemented a special system. Since a Guid property always just contains the Guid as a reference to another object, we can use a query to find the object we want to assign to this property.

When the Guid property has a FilterQuery datamember (which should contain the guid of a query), it will become editable through this query. Note that this FilterQuery guid will not actually be visible in the client. All this should be setup in the backend, the client has no control over this.

When clicking an editable Guid property, you will see a dialog with up to 3 extra buttons added (see image):

;View Object
:This button will be enabled when there is a valid guid assigned to the property. Clicking this button will immediately navigate to the referenced object.
;Edit Property
:If the property has a valid FilterQuery assigned to it, clicking this button will launch that query. If no FilterQuery is assigned, this button will be invisible.
;Clear Property Value
:If the property has a guid assigned, the user can press this button to reset the value back to empty.

Additionally, if a valid FilterQuery is assigned, the user will see the results of that query ''inline'', if the query delivers 200 results or fewer. The user can select an item from this horizontally scrollable list, and press "OK" to assign the UID of the selected object to the Guid property. This is useful for cases where the user does not want to jump into the full query to be able to select an object.

If the user does choose to launch the full query page (or if the query returns over 200 objects), they can click any of the displayed items in the query's child list. When clicking one of them, it will immediately be set as the reference in the original Guid property. To cancel selecting an item (and stop editing the property), simply navigate to any other page (by pressing back, using navigation bar, etc).

{{hint|'''Skipping the dialog'''
If editing the property in a query page without having to go through the dialog is desired, one can customize the boolean variable "SkipQueryDialog" in UBIKThemes.xaml. If none can be found, simply add the following line into its "Default" ResourceDictionary.
<source lang = "xml"><x:Boolean x:Key="SkipQueryDialog">True</x:Boolean></source>
}}

=== Documents ===
UBIK supports and displays document objects and a bunch of actions related to them (editing, redlining, creation, thumbnails, ...).

==== Fit Mode{{Version/WinXSince|3.5}} ====
By default, documents are displayed in their original dimensions. But administrators can also [[SYSCLS_DOCUMENT_FITMODE|configure different fit modes]] for each document. The following demonstrates how documents can look under different fit modes.

{| class="wikitable" | width = "100%" style="text-align: center;"
|-
! Unspecified / Unscaled / Default !! Fit to container !! Fit to width !! Fit to height
|-
| [[File:UI_WinX_FitMode_Unspecified_Small.png|240x225px]] || [[File:UI_WinX_FitMode_Container_Small.png|240x225px]] || [[File:UI_WinX_FitMode_Width_Small.png|240x225px]] || [[File:UI_WinX_FitMode_Height_Small.png|240x225px]]
|-
| [[File:UI_WinX_FitMode_Unspecified_Large.png|240x225px]] || [[File:UI_WinX_FitMode_Container_Large.png|240x225px]] || [[File:UI_WinX_FitMode_Width_Large.png|240x225px]] || [[File:UI_WinX_FitMode_Height_Large.png|240x225px]]
|}

{{Attention|When using a FlipView for documents in your customized XAMLs, you need to additionally [[XAML_Tips#Fit_mode|apply the fit mode]] by yourself. }}
{{Hint|Double tapping on a document toggles the display between "Fit to width" and the fit mode that document is configured with.}}

==== Customizing Possibilities ====

==== Editing{{Version/WinXSince|2.5.4}} ====
[[File:UI_WinX_EditDocumentButton.png|thumb|Button to edit a document]]
For [[SYSCLS_EDITABLEDOCUMENT|editable documents]], there is an {{key press|edit}} button in the bottom app bar. It allows the user to edit a document file using the default app of the OS. If a file is changed during the edit, the same {{key press|save}} button appears just like it does for content with changed properties.
{{Hint|Similar to saving, other app features also apply on edited documents. For example, reverting local changes for an edited document will throw away the changed document file and restore it to the server version.}}
[[File:UI_WinX_EditDocumentOverlayButton.png|thumb|Edit button in thumbnail overlay]]
An alternative way to start editing is to right click on a document's thumbnail, which brings up an overlay of buttons, and then select the {{key press|edit}} button. The difference here is that there is no {{key press|save}} button and any changes are automatically saved (and committed if in online mode).
{{Clear}}

==== Offline availability ====
When a user selects a branch to bring offline, files of all document objects underneath are downloaded in principle. However, they can also be selectively configured to be ignored with a [[SYSCLS_OFFLINE_AVAILABLE_DOCUMENT|classification]] on the server-side. Once a document is classified as offline available, the document file will not be removed when the storage for already synchronized document files is cleared.
{{Hint|This is not to be confused with the accessibility related to [[User_Rights|user rights]]. The logic here is "some documents '''do not have to''' be downloaded", not "some documents '''can not''' be downloaded/accessed". In other words, a user can browse to and open the document regardless of this configuration.}}

==== Clear Online Documents ====
By clearing the online documents, it is possible to free up system memory if needed. It can be triggered by pressing the button "Clear online documents" in the general settings tab. Online documents are documents already uploaded to the server. They can be downloaded anytime agian when the client is connected to the server. However, documents classified as offline available will not be affected and will always stay on the device.

== AR Features ==

=== POI View ===
Brings up the POI View|Augmented Reality view and displays Points of Interest (POI's) related to the current location of the mobile device.

=== Markerless ===

=== Map View ===
Opens the Map View and displays Points of Interest (POI's) related to the current location of the mobile device.

== Positioning ==
{{UBIK}} clients use a [[Location_Manager|Location Manager]] in order to gain knowledge about their position, so it can help the user navigate to his/her target.

The user can choose one of different positioning modes optimized for different environments.
Most of them incorporate multiple technologies for calculating positions or checking their reliability.

=== Positioning modes ===

* ''Use all'' - uses all available position sources
* ''LLA only mode'' - used for positioning using markers only
* ''Beacon Proximity mode'' - uses iBeacon proximity and LLA only

=== Technologies ===

==== GPS ====
GPS is used as a primary positioning input source for outdoor areas. Its precision depends on the environment and satellite availability. With good circumstances, the accuracy varies between 1 and 10 meters.

==== LLA markers ====
LLA markers basically are QR codes with location data encoded into them - which can be used for positioning when they are scanned.

==== Object Proximity Positioning ====
The location of nearby Geo-Objects can be used for positioning.

The position of a Geo-Object can be used manually by pushing the button {{key press|Use Location}} in the [[UBIK_WinX_Client_Basics#Context_Menu|Context Menu]].

The geo information of an object gets used automatically if exactly one single object is found through scanning. If more objects are found, their geo information doesn´t get used. Scanning includes [[UBIK Client Basics#Bar Code|Bar Code]], [[UBIK Client Basics#QR Code|QR Code]], [[UBIK Client Basics#OCR|OCR]] and [[UBIK Client Basics#RFID|RFID]]. The automatic use of Geo-Object´s location can be turned off by disabling the "EnableObjectProximityPositioning" setting.

==== Beacon-Proximity Positioning ====
The Beacon Proximity Mode detects if the user is in the proximity of a beacon. The proximity region is defined by a proximity distance which creates a sphere around the beacon. Whenever the calculated distance to a beacon is smaller than the proximity distance, the user is supposed to be at the position of the beacon. If multiple regions intersect the user is supposed to be at the position of the nearest beacon.
In order to use Beacon Proximity as a Positioning System, Bluetooth Low Energy has to be available and enabled on the mobile device. If a new environment should be equipped with iBeacon-Positioning, an expert has to mount iBeacons on known positions and calibrate the propagation factor of these beacons. Proximity beacons can be configured using [[SYSCLS_PROXIMITY_BEACON]]. {{Version/WinXSince|UWP}}

== Finding Objects ==
=== Free Text Search ===

=== ID Marker ===

=== QR Code ===

=== Bar Code ===

=== RFID Code ===
Provides a fast and convenient way for users to find objects that are identifiable through [[RFID tags|RFID tags]].

=== OCR ===

== Linked objects ==
{{Version/WinXSince|3.6}}
It is possible to display values of linked objects by using the "LinkedLevel" property. An example can be seen here, where Items[0] is a Guid property linking to another object. The ItemsControl then binds to the Properties of the linked object.

<source lang = "xml">
<Grid DataContext="{Binding Properties.Items[0].LinkedLevel}">
<ItemsControl ItemsSource="{Binding Properties.AllItems}" />
</Grid>
</source>

[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

== See also ==
* [[Client_Feature_Table]]

[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

UBIK WinX Client Basics

2019-11-27T13:17:09Z

CWU:

{{UBIK}} Client is the mobile application for viewing and modifying data, showing documents, starting navigation, visualizing POIs and much more.

Client applications are available for Android and WinX, however the features available on each of the platform dependent applications might differ. An overview of the available features can be found in the [[Client_Feature_Table|feature comparison table]].

== Login ==
Users need to login in order to access confidential data, this can be done in the [[Login View]].

=== Confirm login ===
{{Version/WinXSince|3.6}}
Certain pages might require to confirm the login data, even if the user is already logged in. This can be done in the following way: The CheckUserOfflineCommand needs to be called with the username and password as parameter, if the login was valid, the CheckUserOfflineSuccess boolean property is set to true, which causes the text "Login confirmed" to appear in the example.

<source lang = "xml">
<TextBox
x:Name="Sign01User"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}"
PlaceholderText="User"
Text="{Binding UserName}" />
<PasswordBox
x:Name="Sign01PW"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}"
PlaceholderText="Password" />
<Button
Command="{Binding CheckUserOfflineCommand}"
Content="Confirm login"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="UserName" Value="{Binding ElementName=Sign01User, Path=Text}" />
<uc:KeyValueParameter Key="Password" Value="{Binding ElementName=Sign01PW, Path=Password}" />
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
<TextBlock Text="Login confirmed" Visibility="{Binding AuthenticationViewModel.CheckUserOfflineSuccess, Source={StaticResource Locator}, FallbackValue=false, Converter={StaticResource BoolToVisConverter}}" />
</source>

== Profiles ==
Profiles are used to store connection information for {{UBIK}} services. It specifies the location where to find the service along with other useful informations. Profiles are stored by UBIK whenever the user created connection information and stored it in the settings. However, profiles can also be created and edited with any text editor. Possible settings to be defined are:
* InternalConnectionSettings: Connections settings how to connect to the Content and the USAM service that has been set up.
** Application: the [[APPLICATION]] to use with the service
** AuthenticationPort: Port Number of the authentication (USAM) service (default: 777)
** AuthenticationProtocol: Protocol of the authentication service (default: https)
** AuthenticationServer: the ip address of the authentication server
** AuthenticationService: the path to the authentication service
** ContentPort: Port Number of the content service (default: 777)
** ContentProtocol: Protocol of the content service (default: https)
** ContentServer: the ip address of the content server
** ContentService: the path to the content service
** Context: the [[CONTEXT]] to use with the service
** SyncMode: the used sync mode (Online [= Auto], Manual, Offline; default:Online)
* IsDefault: true, if the profile should be the default profile
* Name: the name of the profile (will also be used to identify the database)
** If the profile name contains invalid characters like: /, ", <, >, ... they will be replaced with %_
* Project: the project name. Use this to share a single project name with more than one profile. If the project is defined, all profile with the same project will share one database.
* Customizing: the XAML subfolder to use for customized UI. This parameter can be used to share one single XAML customizing folder for multiple profiles.
* ShowHiddenSettings: show hidden settings (feault: false)

Example:
<source lang = "xml">
<?xml version="1.0" encoding="utf-8"?>
<Profile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UBIK.WinX.Settings">
<Customizing>MYAPPLICATIONUI</Customizing>
<Description i:nil="true" />
<InternalConnectionSettings>
<Application>APP_DEMO</Application>
<AuthenticationPort>777</AuthenticationPort>
<AuthenticationProtocol>https</AuthenticationProtocol>
<AuthenticationServer>80.243.175.50</AuthenticationServer>
<AuthenticationService>UBIK/DBG/AUG/DEMO.250/USAM/USAM.svc</AuthenticationService>
<ContentPort>777</ContentPort>
<ContentProtocol>https</ContentProtocol>
<ContentServer>80.243.175.50</ContentServer>
<ContentService>UBIK/DBG/AUG/DEMO.250/CONTENT/UBIKContent.svc</ContentService>
<Context>CXT_DEMO</Context>
<SyncMode>Online</SyncMode>
</InternalConnectionSettings>
<IsDefault>true</IsDefault>
<Name>DEMO.250.AT</Name>
<Project>DEMO.250</Project>
<ShowHiddenSettings>false</ShowHiddenSettings>
</Profile>
</source>

== Content Browser ==
Allows to navigate through the entire data model in a hierarchical manner, as it is published by the server.

Initially, a list of objects ("root objects") is shown. Upon selecting an object, a new browser is opened for that object, showing details about it. When an object is selected in the content browser, it is called the browser's context. For such a contextual object, child objects and selected properties are shown. Also, there is a context menu providing actions related to the currently selected object.

=== Status Bar ===
[[File:UI_WinX_DbSavingIndicator.PNG|300 px|thumb|border|alt=Saving Symbol|Saving Symbol]]
{{Version/WinXSince|2.5.4}}Whenever content is being saved into the local database (for example, after a branch is downloaded from the server), there will be a blinking symbol indicating the saving activity is happening in the background.
During that time, the user is advised to not logout or close the app because the content might be lost otherwise. However, it is okay to undertake other tasks such as browsing, editing or downloading branches.

=== Child Page ===

[[File:ChildPage.PNG|400 px|thumb|border|alt=Child Page|Child Page]]

The child page shows the context of a selected object.

The global status bar shows the icon, the name and the description of the selected object. An arrow on the left side allows the user to navigate back to the parent object. On the right side the currently logged-in user is indicated. By clicking on the username one is able to navigate back to the home screen or log off.

The right side of the child page shows child objects of the current object. Each child object is represented by an icon, a name and a description.

On the left side of the child page the current object´s high priority properties are shown. By clicking on a live value property, the live value details dialog opens. By clicking on an editable [[UBIK_WinX_Client_Basics#High_priority_properties| high priority property]], an editor opens {{Version/WinXSince|2.5.4}}. If a property was edited a save button is shown in the lower left corner, allowing the user to commit the changes. If a property of a query object was edited an evaluate button is shown in the lower left corner, allowing the user to run the query with the changed propery.

=== Details Page ===

=== Context Menu ===

=== Objects ===

==== Root objects vs child objects ====

The first entry point in the ''Content Browser'' is the list of root objects.

==== Task objects ====

==== Query objects ====

==== Safety relevant objects ====

==== Commissioning objects ====

==== Locked objects ====

=== Properties ===

==== Live value properties ====

==== High priority properties ====
High priority properties are properities having a priority higher than the [[Settings#Content |priority threshold]].

==== Selective List Properties ====

==== Properties with value records {{Version/WinXSince|2.5.4}} ====
[[File:UI_WinX_PropertyWithValueRecords.png|thumb|A property with value records]]
[[File:UI_WinX_PropertyValueRecords.png|thumb|Property value records dialog]]
In addition to its value, a property might also bring along a series of value records showing "who changed the value at what time".

When such records exist, the property row shows a special symbol on the right side. After a right click (with mouse) or a long tap (with touch) on the property row, a dialog will be shown to present these records (sorted by their time, recent ones on top).

{{Clear}}

==== Editors ====

===== Geo Editor & Teach In =====

==== Guid editor ====
[[File:Guid_property_dialog.PNG|thumb|border|alt=Guid property editor dialog|Guid property editor dialog]]

To edit Guid properties (that do not have a selective list available), we have implemented a special system. Since a Guid property always just contains the Guid as a reference to another object, we can use a query to find the object we want to assign to this property.

When the Guid property has a FilterQuery datamember (which should contain the guid of a query), it will become editable through this query. Note that this FilterQuery guid will not actually be visible in the client. All this should be setup in the backend, the client has no control over this.

When clicking an editable Guid property, you will see a dialog with up to 3 extra buttons added (see image):

;View Object
:This button will be enabled when there is a valid guid assigned to the property. Clicking this button will immediately navigate to the referenced object.
;Edit Property
:If the property has a valid FilterQuery assigned to it, clicking this button will launch that query. If no FilterQuery is assigned, this button will be invisible.
;Clear Property Value
:If the property has a guid assigned, the user can press this button to reset the value back to empty.

Additionally, if a valid FilterQuery is assigned, the user will see the results of that query ''inline'', if the query delivers 200 results or fewer. The user can select an item from this horizontally scrollable list, and press "OK" to assign the UID of the selected object to the Guid property. This is useful for cases where the user does not want to jump into the full query to be able to select an object.

If the user does choose to launch the full query page (or if the query returns over 200 objects), they can click any of the displayed items in the query's child list. When clicking one of them, it will immediately be set as the reference in the original Guid property. To cancel selecting an item (and stop editing the property), simply navigate to any other page (by pressing back, using navigation bar, etc).

{{hint|'''Skipping the dialog'''
If editing the property in a query page without having to go through the dialog is desired, one can customize the boolean variable "SkipQueryDialog" in UBIKThemes.xaml. If none can be found, simply add the following line into its "Default" ResourceDictionary.
<source lang = "xml"><x:Boolean x:Key="SkipQueryDialog">True</x:Boolean></source>
}}

=== Documents ===
UBIK supports and displays document objects and a bunch of actions related to them (editing, redlining, creation, thumbnails, ...).

==== Fit Mode{{Version/WinXSince|3.5}} ====
By default, documents are displayed in their original dimensions. But administrators can also [[SYSCLS_DOCUMENT_FITMODE|configure different fit modes]] for each document. The following demonstrates how documents can look under different fit modes.

{| class="wikitable" | width = "100%" style="text-align: center;"
|-
! Unspecified / Unscaled / Default !! Fit to container !! Fit to width !! Fit to height
|-
| [[File:UI_WinX_FitMode_Unspecified_Small.png|240x225px]] || [[File:UI_WinX_FitMode_Container_Small.png|240x225px]] || [[File:UI_WinX_FitMode_Width_Small.png|240x225px]] || [[File:UI_WinX_FitMode_Height_Small.png|240x225px]]
|-
| [[File:UI_WinX_FitMode_Unspecified_Large.png|240x225px]] || [[File:UI_WinX_FitMode_Container_Large.png|240x225px]] || [[File:UI_WinX_FitMode_Width_Large.png|240x225px]] || [[File:UI_WinX_FitMode_Height_Large.png|240x225px]]
|}

{{Attention|When using a FlipView for documents in your customized XAMLs, you need to additionally [[XAML_Tips#Fit_mode|apply the fit mode]] by yourself. }}
{{Hint|Double tapping on a document toggles the display between "Fit to width" and the fit mode that document is configured with.}}

==== Customizing Possibilities ====

==== Editing{{Version/WinXSince|2.5.4}} ====
[[File:UI_WinX_EditDocumentButton.png|thumb|Button to edit a document]]
For [[SYSCLS_EDITABLEDOCUMENT|editable documents]], there is an {{key press|edit}} button in the bottom app bar. It allows the user to edit a document file using the default app of the OS. If a file is changed during the edit, the same {{key press|save}} button appears just like it does for content with changed properties.
{{Hint|Similar to saving, other app features also apply on edited documents. For example, reverting local changes for an edited document will throw away the changed document file and restore it to the server version.}}
[[File:UI_WinX_EditDocumentOverlayButton.png|thumb|Edit button in thumbnail overlay]]
An alternative way to start editing is to right click on a document's thumbnail, which brings up an overlay of buttons, and then select the {{key press|edit}} button. The difference here is that there is no {{key press|save}} button and any changes are automatically saved (and committed if in online mode).
{{Clear}}

==== Offline availability ====
When a user selects a branch to bring offline, files of all document objects underneath are downloaded in principle. However, they can also be selectively configured to be ignored with a [[SYSCLS_OFFLINE_AVAILABLE_DOCUMENT|classification]] on the server-side. Once a document is classified as offline available, the document file will not be removed when the storage for already synchronized document files is cleared.
{{Hint|This is not to be confused with the accessibility related to [[User_Rights|user rights]]. The logic here is "some documents '''do not have to''' be downloaded", not "some documents '''can not''' be downloaded/accessed". In other words, a user can browse to and open the document regardless of this configuration.}}

==== Clear Online Documents ====
By clearing the online documents, it is possible to free up system memory if needed. It can be triggered by pressing the button "Clear online documents" in the general settings tab. Online documents are documents already uploaded to the server. They can be downloaded anytime agian when the client is connected to the server. However, documents classified as offline available will not be affected and will always stay on the device.

== AR Features ==

=== POI View ===
Brings up the POI View|Augmented Reality view and displays Points of Interest (POI's) related to the current location of the mobile device.

=== Markerless ===

=== Map View ===
Opens the Map View and displays Points of Interest (POI's) related to the current location of the mobile device.

== Positioning ==
{{UBIK}} clients use a [[Location_Manager|Location Manager]] in order to gain knowledge about their position, so it can help the user navigate to his/her target.

The user can choose one of different positioning modes optimized for different environments.
Most of them incorporate multiple technologies for calculating positions or checking their reliability.

=== Positioning modes ===

* ''Use all'' - uses all available position sources
* ''LLA only mode'' - used for positioning using markers only
* ''Beacon Proximity mode'' - uses iBeacon proximity and LLA only

=== Technologies ===

==== GPS ====
GPS is used as a primary positioning input source for outdoor areas. Its precision depends on the environment and satellite availability. With good circumstances, the accuracy varies between 1 and 10 meters.

==== LLA markers ====
LLA markers basically are QR codes with location data encoded into them - which can be used for positioning when they are scanned.

==== Object Proximity Positioning ====
The location of nearby Geo-Objects can be used for positioning.

The position of a Geo-Object can be used manually by pushing the button {{key press|Use Location}} in the [[UBIK_WinX_Client_Basics#Context_Menu|Context Menu]].

The geo information of an object gets used automatically if exactly one single object is found through scanning. If more objects are found, their geo information doesn´t get used. Scanning includes [[UBIK Client Basics#Bar Code|Bar Code]], [[UBIK Client Basics#QR Code|QR Code]], [[UBIK Client Basics#OCR|OCR]] and [[UBIK Client Basics#RFID|RFID]]. The automatic use of Geo-Object´s location can be turned off by disabling the "EnableObjectProximityPositioning" setting.

==== Beacon-Proximity Positioning ====
The Beacon Proximity Mode detects if the user is in the proximity of a beacon. The proximity region is defined by a proximity distance which creates a sphere around the beacon. Whenever the calculated distance to a beacon is smaller than the proximity distance, the user is supposed to be at the position of the beacon. If multiple regions intersect the user is supposed to be at the position of the nearest beacon.
In order to use Beacon Proximity as a Positioning System, Bluetooth Low Energy has to be available and enabled on the mobile device. If a new environment should be equipped with iBeacon-Positioning, an expert has to mount iBeacons on known positions and calibrate the propagation factor of these beacons. Proximity beacons can be configured using [[SYSCLS_PROXIMITY_BEACON]]. {{Version/WinXSince|UWP}}

== Finding Objects ==
=== Free Text Search ===

=== ID Marker ===

=== QR Code ===

=== Bar Code ===

=== RFID Code ===
Provides a fast and convenient way for users to find objects that are identifiable through [[RFID tags|RFID tags]].

=== OCR ===

== Linked objects ==
{{Version/WinXSince|3.6}}
It is possible to display values of linked objects by using the "LinkedLevel" property. An example can be seen here, where Items[0] is a Guid property linking to another object. The ItemsControl then binds to the Properties of the linked object.

<source lang = "xml">
<Grid DataContext="{Binding Properties.Items[0].LinkedLevel}">
<ItemsControl ItemsSource="{Binding Content.Properties}" />
</Grid>
</source>

== See also ==
* [[Client_Feature_Table]]

[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

UBIK WinX Client Basics

2019-11-27T13:14:04Z

CWU:

{{UBIK}} Client is the mobile application for viewing and modifying data, showing documents, starting navigation, visualizing POIs and much more.

Client applications are available for Android and WinX, however the features available on each of the platform dependent applications might differ. An overview of the available features can be found in the [[Client_Feature_Table|feature comparison table]].

== Login ==
Users need to login in order to access confidential data, this can be done in the [[Login View]].

=== Confirm login ===

Certain pages might require to confirm the login data, even if the user is already logged in. This can be done in the following way: The CheckUserOfflineCommand needs to be called with the username and password as parameter, if the login was valid, the CheckUserOfflineSuccess boolean property is set to true, which causes the text "Login confirmed" to appear in the example.

<source lang = "xml">
<TextBox
x:Name="Sign01User"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}"
PlaceholderText="User"
Text="{Binding UserName}" />
<PasswordBox
x:Name="Sign01PW"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}"
PlaceholderText="Password" />
<Button
Command="{Binding CheckUserOfflineCommand}"
Content="Confirm login"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="UserName" Value="{Binding ElementName=Sign01User, Path=Text}" />
<uc:KeyValueParameter Key="Password" Value="{Binding ElementName=Sign01PW, Path=Password}" />
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
<TextBlock Text="Login confirmed" Visibility="{Binding AuthenticationViewModel.CheckUserOfflineSuccess, Source={StaticResource Locator}, FallbackValue=false, Converter={StaticResource BoolToVisConverter}}" />
</source>

== Profiles ==
Profiles are used to store connection information for {{UBIK}} services. It specifies the location where to find the service along with other useful informations. Profiles are stored by UBIK whenever the user created connection information and stored it in the settings. However, profiles can also be created and edited with any text editor. Possible settings to be defined are:
* InternalConnectionSettings: Connections settings how to connect to the Content and the USAM service that has been set up.
** Application: the [[APPLICATION]] to use with the service
** AuthenticationPort: Port Number of the authentication (USAM) service (default: 777)
** AuthenticationProtocol: Protocol of the authentication service (default: https)
** AuthenticationServer: the ip address of the authentication server
** AuthenticationService: the path to the authentication service
** ContentPort: Port Number of the content service (default: 777)
** ContentProtocol: Protocol of the content service (default: https)
** ContentServer: the ip address of the content server
** ContentService: the path to the content service
** Context: the [[CONTEXT]] to use with the service
** SyncMode: the used sync mode (Online [= Auto], Manual, Offline; default:Online)
* IsDefault: true, if the profile should be the default profile
* Name: the name of the profile (will also be used to identify the database)
** If the profile name contains invalid characters like: /, ", <, >, ... they will be replaced with %_
* Project: the project name. Use this to share a single project name with more than one profile. If the project is defined, all profile with the same project will share one database.
* Customizing: the XAML subfolder to use for customized UI. This parameter can be used to share one single XAML customizing folder for multiple profiles.
* ShowHiddenSettings: show hidden settings (feault: false)

Example:
<source lang = "xml">
<?xml version="1.0" encoding="utf-8"?>
<Profile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UBIK.WinX.Settings">
<Customizing>MYAPPLICATIONUI</Customizing>
<Description i:nil="true" />
<InternalConnectionSettings>
<Application>APP_DEMO</Application>
<AuthenticationPort>777</AuthenticationPort>
<AuthenticationProtocol>https</AuthenticationProtocol>
<AuthenticationServer>80.243.175.50</AuthenticationServer>
<AuthenticationService>UBIK/DBG/AUG/DEMO.250/USAM/USAM.svc</AuthenticationService>
<ContentPort>777</ContentPort>
<ContentProtocol>https</ContentProtocol>
<ContentServer>80.243.175.50</ContentServer>
<ContentService>UBIK/DBG/AUG/DEMO.250/CONTENT/UBIKContent.svc</ContentService>
<Context>CXT_DEMO</Context>
<SyncMode>Online</SyncMode>
</InternalConnectionSettings>
<IsDefault>true</IsDefault>
<Name>DEMO.250.AT</Name>
<Project>DEMO.250</Project>
<ShowHiddenSettings>false</ShowHiddenSettings>
</Profile>
</source>

== Content Browser ==
Allows to navigate through the entire data model in a hierarchical manner, as it is published by the server.

Initially, a list of objects ("root objects") is shown. Upon selecting an object, a new browser is opened for that object, showing details about it. When an object is selected in the content browser, it is called the browser's context. For such a contextual object, child objects and selected properties are shown. Also, there is a context menu providing actions related to the currently selected object.

=== Status Bar ===
[[File:UI_WinX_DbSavingIndicator.PNG|300 px|thumb|border|alt=Saving Symbol|Saving Symbol]]
{{Version/WinXSince|2.5.4}}Whenever content is being saved into the local database (for example, after a branch is downloaded from the server), there will be a blinking symbol indicating the saving activity is happening in the background.
During that time, the user is advised to not logout or close the app because the content might be lost otherwise. However, it is okay to undertake other tasks such as browsing, editing or downloading branches.

=== Child Page ===

[[File:ChildPage.PNG|400 px|thumb|border|alt=Child Page|Child Page]]

The child page shows the context of a selected object.

The global status bar shows the icon, the name and the description of the selected object. An arrow on the left side allows the user to navigate back to the parent object. On the right side the currently logged-in user is indicated. By clicking on the username one is able to navigate back to the home screen or log off.

The right side of the child page shows child objects of the current object. Each child object is represented by an icon, a name and a description.

On the left side of the child page the current object´s high priority properties are shown. By clicking on a live value property, the live value details dialog opens. By clicking on an editable [[UBIK_WinX_Client_Basics#High_priority_properties| high priority property]], an editor opens {{Version/WinXSince|2.5.4}}. If a property was edited a save button is shown in the lower left corner, allowing the user to commit the changes. If a property of a query object was edited an evaluate button is shown in the lower left corner, allowing the user to run the query with the changed propery.

=== Details Page ===

=== Context Menu ===

=== Objects ===

==== Root objects vs child objects ====

The first entry point in the ''Content Browser'' is the list of root objects.

==== Task objects ====

==== Query objects ====

==== Safety relevant objects ====

==== Commissioning objects ====

==== Locked objects ====

=== Properties ===

==== Live value properties ====

==== High priority properties ====
High priority properties are properities having a priority higher than the [[Settings#Content |priority threshold]].

==== Selective List Properties ====

==== Properties with value records {{Version/WinXSince|2.5.4}} ====
[[File:UI_WinX_PropertyWithValueRecords.png|thumb|A property with value records]]
[[File:UI_WinX_PropertyValueRecords.png|thumb|Property value records dialog]]
In addition to its value, a property might also bring along a series of value records showing "who changed the value at what time".

When such records exist, the property row shows a special symbol on the right side. After a right click (with mouse) or a long tap (with touch) on the property row, a dialog will be shown to present these records (sorted by their time, recent ones on top).

{{Clear}}

==== Editors ====

===== Geo Editor & Teach In =====

==== Guid editor ====
[[File:Guid_property_dialog.PNG|thumb|border|alt=Guid property editor dialog|Guid property editor dialog]]

To edit Guid properties (that do not have a selective list available), we have implemented a special system. Since a Guid property always just contains the Guid as a reference to another object, we can use a query to find the object we want to assign to this property.

When the Guid property has a FilterQuery datamember (which should contain the guid of a query), it will become editable through this query. Note that this FilterQuery guid will not actually be visible in the client. All this should be setup in the backend, the client has no control over this.

When clicking an editable Guid property, you will see a dialog with up to 3 extra buttons added (see image):

;View Object
:This button will be enabled when there is a valid guid assigned to the property. Clicking this button will immediately navigate to the referenced object.
;Edit Property
:If the property has a valid FilterQuery assigned to it, clicking this button will launch that query. If no FilterQuery is assigned, this button will be invisible.
;Clear Property Value
:If the property has a guid assigned, the user can press this button to reset the value back to empty.

Additionally, if a valid FilterQuery is assigned, the user will see the results of that query ''inline'', if the query delivers 200 results or fewer. The user can select an item from this horizontally scrollable list, and press "OK" to assign the UID of the selected object to the Guid property. This is useful for cases where the user does not want to jump into the full query to be able to select an object.

If the user does choose to launch the full query page (or if the query returns over 200 objects), they can click any of the displayed items in the query's child list. When clicking one of them, it will immediately be set as the reference in the original Guid property. To cancel selecting an item (and stop editing the property), simply navigate to any other page (by pressing back, using navigation bar, etc).

{{hint|'''Skipping the dialog'''
If editing the property in a query page without having to go through the dialog is desired, one can customize the boolean variable "SkipQueryDialog" in UBIKThemes.xaml. If none can be found, simply add the following line into its "Default" ResourceDictionary.
<source lang = "xml"><x:Boolean x:Key="SkipQueryDialog">True</x:Boolean></source>
}}

=== Documents ===
UBIK supports and displays document objects and a bunch of actions related to them (editing, redlining, creation, thumbnails, ...).

==== Fit Mode{{Version/WinXSince|3.5}} ====
By default, documents are displayed in their original dimensions. But administrators can also [[SYSCLS_DOCUMENT_FITMODE|configure different fit modes]] for each document. The following demonstrates how documents can look under different fit modes.

{| class="wikitable" | width = "100%" style="text-align: center;"
|-
! Unspecified / Unscaled / Default !! Fit to container !! Fit to width !! Fit to height
|-
| [[File:UI_WinX_FitMode_Unspecified_Small.png|240x225px]] || [[File:UI_WinX_FitMode_Container_Small.png|240x225px]] || [[File:UI_WinX_FitMode_Width_Small.png|240x225px]] || [[File:UI_WinX_FitMode_Height_Small.png|240x225px]]
|-
| [[File:UI_WinX_FitMode_Unspecified_Large.png|240x225px]] || [[File:UI_WinX_FitMode_Container_Large.png|240x225px]] || [[File:UI_WinX_FitMode_Width_Large.png|240x225px]] || [[File:UI_WinX_FitMode_Height_Large.png|240x225px]]
|}

{{Attention|When using a FlipView for documents in your customized XAMLs, you need to additionally [[XAML_Tips#Fit_mode|apply the fit mode]] by yourself. }}
{{Hint|Double tapping on a document toggles the display between "Fit to width" and the fit mode that document is configured with.}}

==== Customizing Possibilities ====

==== Editing{{Version/WinXSince|2.5.4}} ====
[[File:UI_WinX_EditDocumentButton.png|thumb|Button to edit a document]]
For [[SYSCLS_EDITABLEDOCUMENT|editable documents]], there is an {{key press|edit}} button in the bottom app bar. It allows the user to edit a document file using the default app of the OS. If a file is changed during the edit, the same {{key press|save}} button appears just like it does for content with changed properties.
{{Hint|Similar to saving, other app features also apply on edited documents. For example, reverting local changes for an edited document will throw away the changed document file and restore it to the server version.}}
[[File:UI_WinX_EditDocumentOverlayButton.png|thumb|Edit button in thumbnail overlay]]
An alternative way to start editing is to right click on a document's thumbnail, which brings up an overlay of buttons, and then select the {{key press|edit}} button. The difference here is that there is no {{key press|save}} button and any changes are automatically saved (and committed if in online mode).
{{Clear}}

==== Offline availability ====
When a user selects a branch to bring offline, files of all document objects underneath are downloaded in principle. However, they can also be selectively configured to be ignored with a [[SYSCLS_OFFLINE_AVAILABLE_DOCUMENT|classification]] on the server-side. Once a document is classified as offline available, the document file will not be removed when the storage for already synchronized document files is cleared.
{{Hint|This is not to be confused with the accessibility related to [[User_Rights|user rights]]. The logic here is "some documents '''do not have to''' be downloaded", not "some documents '''can not''' be downloaded/accessed". In other words, a user can browse to and open the document regardless of this configuration.}}

==== Clear Online Documents ====
By clearing the online documents, it is possible to free up system memory if needed. It can be triggered by pressing the button "Clear online documents" in the general settings tab. Online documents are documents already uploaded to the server. They can be downloaded anytime agian when the client is connected to the server. However, documents classified as offline available will not be affected and will always stay on the device.

== AR Features ==

=== POI View ===
Brings up the POI View|Augmented Reality view and displays Points of Interest (POI's) related to the current location of the mobile device.

=== Markerless ===

=== Map View ===
Opens the Map View and displays Points of Interest (POI's) related to the current location of the mobile device.

== Positioning ==
{{UBIK}} clients use a [[Location_Manager|Location Manager]] in order to gain knowledge about their position, so it can help the user navigate to his/her target.

The user can choose one of different positioning modes optimized for different environments.
Most of them incorporate multiple technologies for calculating positions or checking their reliability.

=== Positioning modes ===

* ''Use all'' - uses all available position sources
* ''LLA only mode'' - used for positioning using markers only
* ''Beacon Proximity mode'' - uses iBeacon proximity and LLA only

=== Technologies ===

==== GPS ====
GPS is used as a primary positioning input source for outdoor areas. Its precision depends on the environment and satellite availability. With good circumstances, the accuracy varies between 1 and 10 meters.

==== LLA markers ====
LLA markers basically are QR codes with location data encoded into them - which can be used for positioning when they are scanned.

==== Object Proximity Positioning ====
The location of nearby Geo-Objects can be used for positioning.

The position of a Geo-Object can be used manually by pushing the button {{key press|Use Location}} in the [[UBIK_WinX_Client_Basics#Context_Menu|Context Menu]].

The geo information of an object gets used automatically if exactly one single object is found through scanning. If more objects are found, their geo information doesn´t get used. Scanning includes [[UBIK Client Basics#Bar Code|Bar Code]], [[UBIK Client Basics#QR Code|QR Code]], [[UBIK Client Basics#OCR|OCR]] and [[UBIK Client Basics#RFID|RFID]]. The automatic use of Geo-Object´s location can be turned off by disabling the "EnableObjectProximityPositioning" setting.

==== Beacon-Proximity Positioning ====
The Beacon Proximity Mode detects if the user is in the proximity of a beacon. The proximity region is defined by a proximity distance which creates a sphere around the beacon. Whenever the calculated distance to a beacon is smaller than the proximity distance, the user is supposed to be at the position of the beacon. If multiple regions intersect the user is supposed to be at the position of the nearest beacon.
In order to use Beacon Proximity as a Positioning System, Bluetooth Low Energy has to be available and enabled on the mobile device. If a new environment should be equipped with iBeacon-Positioning, an expert has to mount iBeacons on known positions and calibrate the propagation factor of these beacons. Proximity beacons can be configured using [[SYSCLS_PROXIMITY_BEACON]]. {{Version/WinXSince|UWP}}

== Finding Objects ==
=== Free Text Search ===

=== ID Marker ===

=== QR Code ===

=== Bar Code ===

=== RFID Code ===
Provides a fast and convenient way for users to find objects that are identifiable through [[RFID tags|RFID tags]].

=== OCR ===

== Linked objects ==
It is possible to display values of linked objects by using the "LinkedLevel" property. An example can be seen here, where Items[0] is a Guid property linking to another object. The ItemsControl then binds to the Properties of the linked object.

<source lang = "xml">
<Grid DataContext="{Binding Properties.Items[0].LinkedLevel}">
<ItemsControl ItemsSource="{Binding Content.Properties}" />
</Grid>
</source>

== See also ==
* [[Client_Feature_Table]]

[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

Version 1.0 (Xamarin.Android)

2019-11-12T12:54:32Z

CWU: /* XAML */

= Release notes =
Initial release (1.0) of the Xamarin.Android app.
* It's available in the Google Play Store ([https://play.google.com/store/apps/details?id=com.augmensys.ubik link]).
* If subscribed in our App Center distribution channel, you can also download through email notifications.

== Build history ==
* 1.0.69 on 2019-10-21
** Initial release.
* 1.0.71 on 2019-10-28
** Syncfusion chart control (https://help.syncfusion.com/xamarin/sfchart/getting-started#initialize-chart) can now be used in XAML customizings;
** Added confirmation before deleting XAML customizings;
** Fixed an issue where the progress bar was not shown on workpackages.
* 1.0.72 on 2019-10-29
** Improved the stability of the client;
** In case of errors in XAML customizings, the client now provides more useful information (e.g. name of the customizing, line number, error) for easy trouble-shooting;
** Fixed an issue where lists were often missing an item (the first one) after applying filters.
* 1.0.73 on 2019-11-04
** Fixed an issue where importing customizings didn't work on some devices;
** Fixed an issue where content filtering stopped working on the root page after navigating back.

== Known issues ==
* Branch download might be paused if the device goes into sleep mode without a power source attached and will only resume if the device screen is unlocked again. We are aware of this issue and will improve it in the future versions.
* When editing the value of a double property in landscape mode characters other then numbers are not displayed but still remain in the string.

= XAML =
[[Xamarin_XAML|Some basic information]] to get you started on the XAML customizing topic.

To stop the re-evaluation of not needed filters, the SfDataSourceExt has a Property "Unloaded" which stops the filtering if set to true. For details see: [https://wiki.augmensys.com/index.php?title=Xamarin_XAML#Content_filtering]. This increases the performance of filtered lists.

[[Category:Client|Version 1.0 (Xamarin.Android)]]
[[Category:Version 1.0|Version 1.0 (Xamarin.Android)]]
[[Category:Xamarin|Version 1.0 (Xamarin.Android)]]

Version 1.0 (Xamarin.iOS)

2019-11-12T12:53:57Z

CWU: /* XAML */

= Release notes =
Initial release (1.0) of the Xamarin.iOS app.
* It's available in the Apple App Store.
* If subscribed in our App Center distribution channel, you can also download through email notifications.

== Build history ==
* 1.0.73 on 2019-11-04
** Initial release.

== Known issues ==
* Branch download might be paused if the device goes into sleep mode without a power source attached and will only resume if the device screen is unlocked again. We are aware of this issue and will improve it in the future versions.
* When editing the value of a double property in landscape mode characters other then numbers are not displayed but still remain in the string.

= XAML =
[[Xamarin_XAML|Some basic information]] to get you started on the XAML customizing topic.

To stop the re-evaluation of not needed filters, the SfDataSourceExt has a Property "Unloaded" which stops the filtering if set to true. For details see: [https://wiki.augmensys.com/index.php?title=Xamarin_XAML#Content_filtering]. This increases the performance of filtered lists.

[[Category:Client|Version 1.0 (Xamarin.iOS)]]
[[Category:Version 1.0|Version 1.0 (Xamarin.iOS)]]
[[Category:Xamarin|Version 1.0 (Xamarin.iOS)]]

Mobile XAML

2019-11-12T12:50:28Z

CWU: /* Content filtering */

The User Interface of the Xamarin Clients (Android, iOS, new UWP) can be fundamentally customized using custom XAML definitions. This customization process is heavily influenced by the [[XAML|XAML Customization Process on the WinX Client]].

= Basics =
There are predefined XAML templates available that can be customized. If no customizing is found, the default templates will be used.

== Default XAMLs ==
All default XAML templates that can be customized are available through the Xamarin.UWP client. You need to go to the app settings and click the "Unpack default XAMLs" button.

== Differences to WinX/UWP ==
* Since it's based on the Xamarin XAML dialect, you CANNOT use any existing XAML customizings for the WinX/UWP app;
* Namespace definitions must include the corresponding assembly names;
* XAML template files have the extension name of '''xamlx''' instead of '''xaml''';
* You can deploy only those resources that you want to customize.

= Overriding default XAMLs=
On Windows (WinX/UWP), the <code>[App Package Folder]/LocalState/xaml/</code> folder can be accessed by the user and the customized XAML files directly added. An alternative to this on all platforms (including Android, iOS, etc.) is to use the ''Import Customizing'' button in the app settings to import the templates, styles, images, etc. (file by file, or all files within a zip package). The changes should be reflected in the UI (except the current page) without restarting the app. After directly editing the customizings (Xamarin.UWP), you can also use the "Reload customizing" button without restarting the app.

In the following, we're going to override the default light theme color of the app:
* Unpack the default XAMLs;
* Pick and deploy the default UBIKThemes.xamlx to the '''xaml''' folder inside the ''LocalState'' folder;
* Open it with the text editor of your choice and remove everything within the '''ResouceDictionary''' except <code><Color x:Key="UBIKLightThemeColor">blue</Color></code>;
* Save the changes and reload. You should see changes successfully implemented.

{{Attention| For maintainability reasons, it's HIGHLY recommended to deploy only those XAML resources you want to override. For example, if you only want to customize the UBIKChildArea, don't deploy others like the UBIKMenuArea. If you only want to customize the UBIKChildItem, that's the only content you should include in the UBIKThemes.}}

== Custom Templates ==
Custom templates can be added, just like on the WinX/UWP client. Make sure to include all '''namespace definitions''' (as attributes of the '''ContentView''' tag), otherwise the custom template will not load.

Similar to the ''UBIKThemes.xamlx'' file, custom or overridden templates start with a <code><ContentView></code> tag containing all '''namespaces'''. <code><ContentView.Resources></code> takes a '''ResourceDictionary''' and contains resources like references to converters. Finally, <code><ContentView.Content></code> contains the actual layout content (it's best to start with a '''Grid'''). Again, don't forget to add namespaces that you need!

Templates can also be defined in ''UBIKThemes.xamlx''. In this case, they need to be added into the <code><ResourceDictionary></code> inside the <code><ContentView.Resources></code> template as a <code><DataTemplate></code>. Similarly, if you want to split up the templates into seperate files, you need to make sure to follow the steps mentioned above and get the content of the <code><DataTemplate></code> into the <code><ContentView.Content></code> tag.

{{Attention|Templates defined in separate files will override templates defined in the ''UBIKThemes.xamlx''!}}

== Adding Images ==
Images can't be loaded with the default '''Image''' tag, as the image is on different paths on each operating system.

Therefore, there's a custom '''FileImage''' that internally overrides the default ''Image'' with two custom parameters:
* '''FolderName''' ...The name of the '''folder''' in the '''local folder'''. Only the first level inside the ''LocalState'' folder seems to work.
* '''FileName''' ...The name of the '''file''' in the said folder.

Make sure to implement the proper namespace as well by adding
<code>xmlns:fimage="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL"</code> into the root item's attributes.

Then, the image can be loaded using:<br/>
<code><fimage:FileImage FileName="image.png" FolderName="xaml"/></code>

This snipped loads the image called '''image.png''' located in the '''xaml''' folder inside the ''LocalState''.

Furthermore, the ''FileImage'' tag doesn't seem to support most attributes. Therefore place it inside a '''Grid''' to achieve a perfect layout.

== Converters==
:''Main Page: [[Converters_In_Xamarin]]''

They are used to convert specific data into some desired output, using custom logic.

Consider the following example:<br/>
A label saying ''There are no children items available!'' should only be visible if the number of children-items is 0.

= Advanced =

== Feature related ==

=== Content filtering ===
For the Xamarin clients, an "SfDataSourceExt" type is available for filtering list of items using defined expressions.<br />
The following example demonstrates how to filter for child items having certain property values. The filtered list and its count can be displayed in the UI.<br />
<syntaxhighlight lang="xml">
<ContentView
xmlns:controls="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL"
...>
<ContentView.Resources>
<ResourceDictionary>
<x:String x:Key="Expresssion">Item.Values["MP_YEAR"].Contains("2019")</x:String>
<controls:SfDataSourceExt x:Key="FilteredList" Expression="{StaticResource Expresssion}" ItemsSource="{Binding Children.Items}" Unloaded="{Binding SkipFiltering}" />
</ResourceDictionary>
</ContentView.Resources>
<StackLayout Orientation="Vertical">
<Label Text="{Binding DisplayItemsCount, Source={StaticResource FilteredList}}" />
<controls:SfListViewExt ItemsSource="{Binding DisplayItems, Source={StaticResource FilteredList}}" />
</StackLayout>
</ContentView>
</syntaxhighlight>

[[Category:Client|Xamarin XAML]]
[[Category:Pages with broken file links|Xamarin XAML]]
[[Category:Styling|Xamarin XAML]]
[[Category:Xamarin|Xamarin XAML]]

=== Search ===
In the default UBIKMenuArea.xamlx (where the search UI is hosted), there are two commands associated with two events. See below.
<syntaxhighlight lang="xml">
<SearchBar ...>
<SearchBar.Behaviors>
<behaviors:EventToCommandBehavior
Command="{Binding FreeTextSearchCommand}"
CommandParameter="{Binding Path=Text, Source={x:Reference SearchField}}"
EventName="SearchButtonPressed" />
<behaviors:EventToCommandBehavior Command="{Binding DelayedFreeTextSearchCommand}" EventName="TextChanged" />
</SearchBar.Behaviors>
</SearchBar>
</syntaxhighlight>
<br />
The one for <code>SearchButtonPressed</code> is responsible for executing searches after the user confirms the input (e.g. pressing {{{keypress|Enter}}} or the search button).
<br />
The one for <code>TextChanged</code> is responsible for the "search as you type" behavior. Namely it triggers an automatic search shortly (half second) after the user stops changing the text in the search bar. It can be turned off by simply removing that particular behavior.

== Performance ==
To get a good performance in the app UI when using your Xaml customizings, it is recommended to try the following.
* Always keep your UI structure simple. Choose the most efficient layouts for the scenarios and avoid unnecessary UI elements. Please refer to [https://docs.microsoft.com/en-us/xamarin/xamarin-forms/deploy-test/performance#choose-the-correct-layout "choose the correct layout"] and [https://docs.microsoft.com/en-us/xamarin/xamarin-forms/deploy-test/performance#reduce-the-visual-tree-size "reduce the visual tree size"];
* Turn on [https://docs.microsoft.com/en-us/xamarin/xamarin-forms/user-interface/layouts/layout-compression layout compression] on wrapping elements that don't have any visual parameters set (reasons stated in the linked documentation).
{{Hint|There is a default "HeadlessLayout" style available in the app you can use on elements such as Grids, StackLayouts, ContentViews, etc. It turns on layout compression on the applied elements in Xamarin.Android (since we find it not worth the effort in Xamarin.iOS).}}
{{Attention|If possible, one should always favor designing the UI with less wrapping elements over turning on layout compression on unnecessary ones.}}

=== Layout compression examples ===
<syntaxhighlight lang="xml">
<ContentView ControlTemplate="{DynamicResource ChangedSymbol}" Style="{DynamicResource HeadlessLayout}" />
</syntaxhighlight>
The code above removes one wrapping element added automatically by the ContentView and demonstrates a good reason to use layout compression because it can not be avoided otherwise.
<syntaxhighlight lang="xml">
<Grid Margin="2" Style="{DynamicResource HeadlessLayout}">
<Label Margin="5" Text="{Binding Title}" />
</Grid>
</syntaxhighlight>
This example, on the other hand, demonstrates a bad usage of layout compression because it can be easily achieved by better designs such as using only the Label with a merged margin.

Sometimes the content inside a compressed layout appears on a wrong z-index level. For eample:
<syntaxhighlight lang="xml">
<BoxView CornerRadius="14" HeightRequest="28" WidthRequest="28" Color="Red" />
<ContentView ControlTemplate="{DynamicResource Badge}" Style="{DynamicResource HeadlessLayout}">
<Label Text="{Binding Title}" />
</ContentView >
</syntaxhighlight>
According to the order of the BoxView and the Label, the latter should appear on top of the former (later ones have higher z-index levels). However, this can be disturbed by layout compression, causing the exact opposite.
In this case, you can add a <code>xmlns:android="clr-namespace:Xamarin.Forms.PlatformConfiguration.AndroidSpecific;assembly=Xamarin.Forms.Core"</code> namespace to your Xaml file and manually elevate the Label by specifying <code>android:VisualElement.Elevation="X"</code> on it accordingly (X is the delta of the z-index level you want).

=== SfListViewExt ===
For performance reasons, we created an extended version of the Syncfusion SfListView control and it should be used for all lists in customizings. You need to add a namespace like <code>xmlns:controls="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL"</code> to your Xaml file and use it like <code><controls:SfListViewExt ... /></code>.
{{Hint|Technically speaking, SfListViewExt informs item view models when their corresponding item views appear on / disappear from the screen. This way, view models can skip a lot of unnecessary work (on the UI) when their views are not visible. '''If SfListView is used instead, the item views will not reflect content changes until the page is reloaded/refreshed.'''}}

[[Category:Client|Xamarin XAML]]
[[Category:Pages with broken file links|Xamarin XAML]]
[[Category:Styling|Xamarin XAML]]
[[Category:Xamarin|Xamarin XAML]]

Version 3.6 (WinX)

2019-10-23T10:35:39Z

CWU: /* Xaml Changes */

{{Attention|There are mandatory Xaml changes and existing customizings need to be updated.}}

= Initial Release =
=== New features ===
* Position and Orientation information of separate source systems (GPS, Compass, AR-Markers, etc.) are now combined based on their probabilistic error levels using an Extended Kalman Filter.
* It is now possible to persist the scroll position of a ListView when browsing through the content hierarchy. But the ListView does need an unique identifying name (x:name) to work properly. Furthermore, if list elements depend on other UI-elements those have to be created above the ListView in the XAML.
* The element in the middle of the screen within a !ListView is memorized. With this information the scroll position is memorized. But the ListView does need an unique identifying name (x:name) to work properly. Furthermore, if list elements depend on other UI-elements those have to be created above the ListView in the XAML.
* The feature of [[Login_View#UWP_.26_Xamarin_clients|remembering user credentials]] is redesigned.
* The GlobalStatusBar can now be fully customized in the template: ''UBIKGlobalStatusBar.xaml''.
* The AuthenticationPage (Start Page of the App) can now be fully customized in the template: ''UBIKStartArea.xaml''.
* It is now possible to use external Bluetooth RFID Readers to scan [[RFID_tags#tab=WinX_External_Scanner|RFID Tags]] in UBIK.
* The not found offline query criteria are now ignored.
* It's now possible to use [[XAML_Tips#MultiBinding|multi bindings]] in XAML.
* A new command ''InvokeForAllChildrenCommand'' allows to execute a command on all selected items of a ''ChildrenListViewModel''
* A new property ''LinkedLevel'' on the ''PropertyListItemViewModel'' loads and delivers a full PageViewModel of the linked object of a Guid property
* It is now possible to attach documents to the [[Property_Wizard_(Client)|content creation wizard]].

[[Category:Version 3.6|Version 3.6 (WinX)]]

=== Enhancements ===
* Simplified and improved the bindings to TemplateService and its templates. See [[Version_3.6_(WinX)#Xaml_Changes|Xaml Changes]].
* The shortcut key to activate the [[Developer_Mode|developer mode]] is changed from {{key press|F12}} to {{key press|Ctrl}}+{{key press|F12}} (to reduce activations by accident and to avoid conflicts with other applications).
* Improved ToString representations of collections for better use in DeveloperMode
* Improved the performance and responsiveness when loading large lists.

[[Category:Version 3.6|Version 3.6 (WinX)]]

=== Bugfixes ===
* Fixed an issue when clicking on ListViewItem in ZoomedOutListView it does not navigate, when clicking on the right side of the object
* Fixed an issue where OCR Definitions ("TAG_Chars.xml) generated through the experimental ''TagReader'' App could not be used by the client anymore
* Fixed an issue where UBIK was crashing when repeatedly opening the GuidEditor using the PropertyWizard.

[[Category:Version 3.6|Version 3.6 (WinX)]]

= Build History =

= Xaml Changes =
<br />
We have made some improvements to make some bindings in Xaml code easier and more efficient. Some changes to your existing Xaml customizings might be necessary. Please refer to each section to see if the change is mandatory or not.

== Binding to TemplateService and the templates ==
This change is '''not mandatory''' and your existing Xamls will still work. We do recommend updating them, though.

Previously the TemplateService (the one providing access to all customizable templates) was only available on certain views (e.g. pages, dialogs, etc.). And the binding to it could only be done using named element like
:<source lang = "xml">
<ContentControl ContentTemplate="{Binding ElementName=contentPage, Path=TemplateService.UBIKChildPageActionTemplate}" />
</source>
It is now made accessible from all view models (you can use the [[Developer_Mode|developer mode]] to check its availability). Also, you can now use the exact names of the template files as indexers for binding to those templates. Therefore, the binding can be changed to something like
:<source lang = "xml">
<ContentControl ContentTemplate="{Binding TemplateService[UBIKChildPageAction]}" />
</source>

== Use SelectionBoundListView instead of ListView ==
A SelectionBoundListView was already available in earlier versions but not mandatory. For performance improvements, it is now '''mandatory''' wherever you display {{UBIK}} content (objects, properties, etc.).
You need to add a namespace like <code>xmlns:uc="using:UBIK.WinX.Controls"</code> to your Xaml file and use it like <code><uc:SelectionBoundListView ... /></code>.
{{Hint|Technically speaking, SelectionBoundListView informs item view models when their corresponding items are visualized. This way, view models can skip a lot of unnecessary work (on the UI) when their views are not visible. '''If the regular ListView is used instead, the item views will not reflect content changes until the page is reloaded/refreshed.'''}}

== Customized Sorting ==
Customizers can now specify the sort order of the items in XAML with the help of a ListCollectionView. The path to a comparable property, that is used for comparing can be specified. Multiple properties can be used, whereby the priority goes from the first to the last property. The direction can be specified by either "Ascending" (default) or "Descending".

<source lang="xml">
<collectionview:ListCollectionView x:Key="CustomSortedList" ItemsSource="{Binding Children.Items}">
<collectionview:ListCollectionView.SortParameter>
<collectionview:SortDescriptions>
<collectionview:SortDescription PropertyName="Header" Direction="Ascending"/>
<collectionview:SortDescription PropertyName="Content.UID" Direction="Descending"/>
</collectionview:SortDescriptions>
</collectionview:ListCollectionView.SortParameter>
</collectionview:ListCollectionView>
</source>

<headertabs />

{{Category/Version2|{{PAGENAME}}}}

[[Category:Version 3.6|Version 3.6 (WinX)]]

Version 3.5 (WinX)

2019-08-26T12:43:37Z

CWU: /* Build History */

{{Attention|There are breaking XAML template changes in this version. If you use any customized XAMLs from older versions, they should be updated according to [[XAML_Changes_in_UBIK_WinX_3.5|these instructions]]. }}

= Initial Release =
=== New features ===
* It is now possible to configure complex parameter lists for various commands in XAML, using the new [[KeyValueList]] element
* It is now possible to use [[AR-Marker]]s for [[AR-Marker_Device_Pose_Estimation|device pose estimation]].
* Administrators can now configure the [[UBIK_WinX_Client_Basics#Fit_Mode|fit modes]] which determines how documents are initially displayed.
* You can now find comments on various type list members in the [[Developer_Mode|developer mode]]. This is an ongoing process and more comments will be added/improved after the release.

=== Enhancements ===
* The Camera Access was refactored to provide a proper basis for upcoming features.
* The Rendering Environment was refactored to provide a proper basis for upcoming features.
* The problematic CollectionToViewConverter for content filtering is replaced by the new ListCollectionView. See [[XAML_Changes_in_UBIK_WinX_3.5]] for details.
* Users can now confirm and save their signature before the timer ends.
* The OK button will now stay disabled if there is no signature.
* Improved the way navigation history is maintained so that issues such as wrong navigation destinations upon leaving unsaved changes no longer occur.
* The [[Offline_Query_(UBIK_WinX)#String_criterion|string criteria of offline queries]] are now more restrictive (all sub strings must be found instead of just one).
* Greatly improved the app's performance when loading PDF files with many pages. You might want to check [[XAML_Tips#FlipView|this]] out as well.
* Scanning is now paused when the last search result dialog is still open for user interaction.
* Comma and dot are both accepted as decimal seperators when entering numbers, independent of the current culture.

=== Bugfixes ===
* Fixed an issue where POIs were only rendered in the upper half of the POIPage.
* Fixed an issue where OCR Shapes were rotated in the wrong direction.
* Fixed an issue where Child Informations were not shown in the POIFlyout of the Map Page.
* Fixed an issue where AR Settings were not applied when returning from the Settings to the POI Page.
* Fixed an issue where browsing through local content can be difficult (the content is shown after a substantial delay) when downloading large branches.
* Fixed an issue where branch download is sometimes interrupted by too many file downloading failures.
* Fixed an issue where file downloading events are sometimes not logged.
* Fixed an issue where the compass needle in the POI Page was not updated properly.
* Fixed an issue where POI Icons in the Map Page changed upon selection.
* Fixed an issue where the distance on the POI Flyout was always zero for Geometries.
* Fixed an issue where the POI Flyout Selection was reversed after exiting buildings.
* Fixed an issue where POI poses were not updated once the Building Level or POI Groups changed.
* Fixed an issue where the HideOtherPOIs and ScreenOffset Settings had no effect on POI Rendering.
* Fixed an issue where POIs were rendered upside down when having a negative ScaleX property.
* Fixed an issue where POIs in the Map and POI Page were not updated once infrastructure objects were loaded.
* Fixed an issue where the Geo Editor TeachIn ignored manual positions.
* Fixed an issue where AR-Marker POIs were blinking when they should have been behind the camera.
* Fixed an issue where POIs were visible in the upper left corner of the POI Page if the near and far clipping plane were too close.
* Fixed an issue where camera flash toggle button was not updated when changing the camera.
* Fixed an issue where editor showed wrong content when Not Applicable was checked.
* Fixed an issue where the POI Page was not properly restored after UBIK was minimized.
* Fixed an issue where it was not possible to return to Scan Page after scanning AR-Markers.
* Fixed an issue where the RFID(NFC) Scanner did not show a dialog window with more objects (when tag has targets two objects or more)
* Invalid characters in profile names are escaped/replaced and will no longer break the app.
* Fixed several UI issues in the Gantt chart control. For example, no longer displaying the current date line or the progress bar if it doesn't fall into the project timeline.
* Fixed an issue where the content page displays incorrect title/subtitle right after editing a Guid property using a query.
* Fixed an issue where the user can only browse to the same object once by scanning the QR code (unless a different marker is scanned).
* Fixed an issue where the "Manual" sync mode configured in profiles is ignored during logins.
* Fixed an issue where the toggling of fit-to-width mode for documents doesn't work (when Windows animation is enabled).
* Fixed an issue where the device position calculated from AR-Markers was wrong.
* Fixed an issue where POIs having a negative AR-Marker side length were not shown.

=== Known issues ===
* Project specific resources defined in UBIKThemes might not take effect immediately after switching profiles. Restarting the app solves the problem.
* If a device has multiple cameras of exactly the same model (e.g. Microsoft HD 3000), the wrong one might be used during remote support calls.
* When using the UBIK contrast profile for OCR scanning, the app might crash especially if other marker scanning is also turned on.

=== Additional notes ===

= Build History =
* 3.5.2 on 2019-04-30
** Initial release.
* 3.5.3 on 2019-05-03
** It is now possible to display the distance to AR-Marker POIs.
** The same layer selection button is now also available in the POI page (previously only in the map page).
* 3.5.5 on 2019-06-12
** [[XAML_Tips#Content_creation|Creating child objects under non-context objects]] is now possible.
** Fixed an issue where the Guid property value is not committed if an editing starts from a child item.
** Fixed an issue where Guid properties without original server values can’t be saved.
* 3.5.11 on 2019-07-19
** Fixed an issue so that navigating to a hotspot in a document works again.
** Errors in custom XAML templates are now displayed as red section in the App, including the full exception message (which is typically pointing to the line in the XAML file)
{{Hint|There are still XAML errors that cannot be caught, such as referencing a StaticResource that doesn't exist - in such a case, the App will crash, but it will still write the full exception message to [AppInstallPath]\''LocalState\UBIKDebug.log'' before termination, thus the corrupted line can again be easily identified!}}
* 3.5.13 on 2019-07-19
** Fixed an issue so that navigating to a hotspot in a document works again. (Hotfix for the previous version, now it should work for image documents as well.)
** Fixed an issue where hotspots and annotations are not shown the first time browsing to a document using customized Xamls.
* 3.5.14 on 2019-08-02
** For compatibility reasons, we have reverted one change from 3.5.11, namely "Errors in custom XAML templates..." which will be postponed into the next major release.
* 3.5.18 on 2019-08-20
** It is now possible to disable the automatic filter criteria for queries.
** Fixed an issue where the distance to Direct AR-Markers was shown in Pixels instead of meters
* 3.5.19 on 2019-08-26
** Change the highlighting of selected hotspots

<headertabs />

{{Category/Version2|{{PAGENAME}}}}

[[Category:Version 3.5|Version 3.5 (WinX)]]

XAML Tips

2019-08-08T09:00:41Z

CWU: /* Functionality related */

XAML Tips

2019-08-08T08:48:48Z

CWU: /* Content creation */

Developer Mode

2019-07-26T10:07:41Z

CWU: /* Stages */

== Overview ==
The developer mode provides certain features to help customizing the {{UBIK}} UI and is therefore only meant to be accessed by project engineers and developers.

== Stages ==
The developer mode can be reached by hitting {{key press|F12}} / {{key press|Ctrl}}+{{key press|F12}}{{Version/WinXSince|3.6}}. When hit for the first time, developer mode is in Stage 1, when hit again it will be in Stage 2. When hit for the third time, developer mode is switched off again (Stage 0).

=== Stage 1 ===
If there are lists currently displayed, the templates of the list items will be highlighted.

=== Stage 2 ===
The area templates will be highlighted; if there are lists currently displayed, its item templates will not be visible.

=== Stage 3 {{Version/WinXSince|3.6}} ===
The template of the whole page will be highlighted (Only available on some pages, e.g. ChildPage)

{| class="wikitable" | width = "100%" style="text-align: center;"
|-
! Stage 1 !! Stage 2 !! Stage 3 !! Stage 0 (non-developer mode)
|-
| [[File:Stage 1.png|335x230px]] || [[File:Stage 2.png|335x230px]] || [[File:Stage 3.png|335x230px]] || [[File:Stage 0.png|335x230px]]
|}

[[Category:Pages with broken file links|Developer Mode]]

== Features ==
[[File:UBIK_WinX_UI_DeveloperMode_Template_Button.png|thumb|Template button and its flyout]]
[[File:UBIK_WinX_UI_DeveloperMode_ConText_Button.png|thumb|Context button and its flyout]]
In developer mode, all templates on a certain page will be highlighted as a crossed-out green area with two buttons. The top/template button allows to edit the XAML file behind the respective area, and the bottom/context button allows to browse the properties, methods and commands of the underlying ViewModel/Context.

=== XAML Files ===
When pressing the edit button in the flyout with the name of the XAML file, the following will happen:
* If this template doesn't have a customized XAML file yet, {{UBIK}} will copy its default XAML definition into the customizing folder, open the explorer and highlight it. From there you can use any text editor to modify it;
* If there is already a customized XAML file for this template, UBIK will ask whether you want to open the existing file or if you want to replace the existing file with the default XAML definition of this template again.

{{Hint|If you switch on developer mode stage 2 on a page where a [[SYSCLS_CHILDAREATEMPLATE|custom child area template]] is used, that custom name is displayed instead of the default "UBIKChildArea" text.}}

=== Browsing the ViewModel/Context ===
When pressing the button with the name of the ViewModel/Context, {{UBIK}} will open a browser that allows you to explore all its public properties, methods and commands. Tapping on a member will pin that member and browse a level deeper. Tapping on the button on the left side of the member name, will trigger the following:
* If the member is a property {{key press|P}} or method {{key press|M}} , its path will be copied to the expression field on top of the browser and its result will be instantly evaluated;
* If the member is a command {{key press|C}} the browser will navigate to its respective Execute method. Tapping the button of the Execute method will invoke the command.

Here is a list of all possible member types.
{| class="wikitable" | width = "60%" style="text-align: left;"
|- style="vertical-align: top;"
| Converter || [[File:UI_WinX_DeveloperMode_Converter.png|300x42px]] || All converters that can be used in the current XAML context. They are only displayed at the top level.
|- style="vertical-align: top;"
| Obsolete || [[File:UI_WinX_DeveloperMode_Obsolete.png|300x42px]] || All members marked red are obsolete and recommended not to be used anymore.
|- style="vertical-align: top;"
| Property || [[File:UI_WinX_DeveloperMode_Property.png|300x42px]] || Public properties that can be inspected.
|- style="vertical-align: top;"
| Method || [[File:UI_WinX_DeveloperMode_Method.png|300x42px]] || Includes both the command related methods and all other public methods.
|- style="vertical-align: top;"
| Command || [[File:UI_WinX_DeveloperMode_Command.png|300x42px]] || Performs a certain task, e.g. navigating back to the previous page, taking a picture. Every one of them has a corresponding "Execute''[CommandName]''" method which actually executes the command.
|}

{{Hint|You can hover over a member in the list to get more information such as its description, usage, hints, etc.
* When hovering over an obsolete member, you will find a suggested replacement.}}

[[File:UI_WinX_DeveloperMode_Example.png|thumb|An example of searching & evaluating]]
==== Search field ====
The second text field (the one that says "Search...") in the browser can be used as a filter to reduce the number of members displayed in the list.
* The search occurs as you type and the search text is '''case insensitive''';
* Only members whose names contain the entered search text are shown in the list;
* The already pinned members are not filtered.

==== Expression field ====
The text field on top (the one that says "Enter expression...") allows direct input of an expression to be evaluated.
* The evaluation occurs as you type and the expression text is '''case sensitive''';
* The context used for evaluating the expression does not change as you browse further into the list;
* The result of the evaluation (if there is any and it's not null) is displayed below the expression field.

==== Usage example ====
An example is shown in the picture. The template involved is UBIKChildArea and the context is a ContentPageViewModel.
* The search text "number" filters the list of members under ContentPageViewModel.ClassificationHandler.ChildInformation and only "NumberOfDocuments" and "NumberOfNonDocuments" are shown;
* The expression text "ClassificationHandler.ChildInformation.NumberOfNonDocuments" evaluates to 2 because the context object of this ContentPageViewModel carries [[SYSCLS_CHILDINFOOWNER|child information]] and has two non document child objects;
* The result "2" is a [https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/built-in-types-table primitive type] and the string representations of these values are shown. For other types, you might see their type names instead unless they have their own ToString() implementations;
* You can browse to the level shown in the example and then click on the {{key press|P}} next to "NumberOfNonDocuments". Or you can simply type in the above mentioned expression text at any level. Both would yield the same result;
* If an expression is successfully evaluated here, you can use the same text for bindings in the relevant template (UBIKChildArea in this case) and expect the same result.

{{Hint|You can safely type expressions directly in the field. However, you might be constantly interrupted since the evaluation is done as you type. For example, a dialog can be shown because of a command. In such cases, you might want to finish the expression elsewhere and then copy/paste it into the field.}}

{{Hint|As mentioned, the name of the context is not required at the beginning of the expression. However, it is required when you nest an expression in another one as its parameter. For example, you can enter "ExecuteShowMessageBoxCommand(Context.AppVersion)" to display the app version in a dialog. The "Context" keyword is needed for evaluating the parameter expression "AppVersion".}}

=== Errors {{Version/WinXSince|3.6}} ===

Since custom templates are always loaded on demand, there is no way for UBIK upfront to check whether it contains errors or not. This section lists the possible errors and the respective behavior of UBIK.

[[File:UI_WinX_ErrorTemplateNotFound.png|thumb|Error for a non-existing requested template]]
==== Missing template ====

if an object requests a special template, e.g. through the [[SYSCLS_CHILDAREATEMPLATE|child area template classification]], UBIK will try to locate the respective file in the XAML customizing folder of the current profile. If the file doesn't exist, it will display a red error box in the respective area.

{{Hint|Clicking the {{key press|Edit XAML}} button will in this case create an empty template with the requested template name in the XAML customizing folder!}}

[[File:UI_WInX_ErrorTemplate.png|thumb|Parsing error in a requested template]]
==== Parsing errors ====

If there is a syntax error in the XAML template, UBIK will try to surface the error message into the error template. This will most likely include a reference to the position in the XAML text that caused the error.

==== Runtime errors ====

These are the only errors that will lead inevitably to a crash of the App. An example for this would that your template tries to reference a ''StaticResource'' that doesn't exist.
However, UBIK will still try to write the full exception message to [AppInstallPath]\LocalState\UBIKDebug.log before termination, thus the corrupted line can again be easily identified.

== Other features ==
By hitting {{key press|F5}}, all templates on the currently displayed page will be disposed of and reloaded. So if a customized XAML template file was changed, this change will be immediately reflected in the UI.

[[Category:Pages with broken file links|Developer Mode]]

File:Stage 1.png

2019-07-26T09:46:04Z

CWU: File uploaded with MsUpload

File uploaded with MsUpload

File:Stage 2.png

2019-07-26T09:46:04Z

CWU: File uploaded with MsUpload

File uploaded with MsUpload

File:Stage 0.png

2019-07-26T09:46:03Z

CWU: File uploaded with MsUpload

File uploaded with MsUpload

File:Stage 3.png

2019-07-26T09:46:02Z

CWU: File uploaded with MsUpload

File uploaded with MsUpload

Version 3.6 (WinX)

2019-07-10T13:02:21Z

CWU: /* Initial Release */

{{Attention|There are breaking XAML template changes in this version. If you use any customized XAMLs from older versions, they should be updated according to breaking changes. }}

= Initial Release =
=== New features ===
* Position and Orientation information of seperate source systems (GPS, Compass, AR-Markers, etc.) are now combined based on their probabilistic error levels using an Extended Kalman Filter.
* It is now possible to persist the scroll position of a ListView when browsing through the content hierarchy. But the ListView does need an unique identifying name (x:name) to work properly. Furthermore, if list elements depend on other UI-elements those have to be created above the ListView in the XAML.
* The element in the middle of the screen within a !ListView is memorised. With this information the scroll position is memorised. But the ListView does need an unique identifying name (x:name) to work properly. Furthermore, if list elements depend on other UI-elements those have to be created above the ListView in the XAML.
* The feature of [[Login_View#UWP_.26_Xamarin_clients|remembering user credentials]] is redesigned.
* The GlobalStatusBar can now be fully customized in the template: "UBIKGlobalStatusBar.xaml"

=== Bugfixes ===
* Fixed an issue when clicking on ListViewItem in ZoomedOutListView it does not navigate, when clicking on the right side of the object

[[Category:Version 3.6|Version 3.6 (WinX)]]

= Build History =

= Breaking changes =

* If the template "UBIKMainArea.xaml" has been customized, in the xaml all references to "Root" need to be updated to "contentPage", like: "{Binding ElementName=Root needs to be changed to "{Binding ElementName=contentPage

<headertabs />

{{Category/Version2|{{PAGENAME}}}}

[[Category:Version 3.6|Version 3.6 (WinX)]]

Version 3.6 (WinX)

2019-07-10T12:58:05Z

CWU:

{{Attention|There are breaking XAML template changes in this version. If you use any customized XAMLs from older versions, they should be updated according to breaking changes. }}

= Initial Release =
=== New features ===
* Position and Orientation information of seperate source systems (GPS, Compass, AR-Markers, etc.) are now combined based on their probabilistic error levels using an Extended Kalman Filter.
* It is now possible to persist the scroll position of a ListView when browsing through the content hierarchy. But the ListView does need an unique identifying name (x:name) to work properly. Furthermore, if list elements depend on other UI-elements those have to be created above the ListView in the XAML.
* The element in the middle of the screen within a !ListView is memorised. With this information the scroll position is memorised. But the ListView does need an unique identifying name (x:name) to work properly. Furthermore, if list elements depend on other UI-elements those have to be created above the ListView in the XAML.
* The feature of [[Login_View#UWP_.26_Xamarin_clients|remembering user credentials]] is redesigned.

=== Bugfixes ===
* Fixed an issue when clicking on ListViewItem in ZoomedOutListView it does not navigate, when clicking on the right side of the object

= Build History =

= Breaking changes =

* If the template "UBIKMainArea.xaml" has been customized, in the xaml all references to "Root" need to be updated to "contentPage", like: "{Binding ElementName=Root needs to be changed to "{Binding ElementName=contentPage

<headertabs />

{{Category/Version2|{{PAGENAME}}}}

[[Category:Version 3.6|Version 3.6 (WinX)]]

Version 3.6 (WinX)

2019-07-10T12:51:35Z

CWU:

XAML Tips

2019-05-09T15:09:36Z

CWU: /* Functionality related */

== Functionality related ==

=== Attachable behaviors ===
It's quite often that you need to attach behaviors to certain XAML elements. For example, on a Grid, you want to attach a behavior which executes a command upon a Tapped event like the following.

<source lang = "xml">
<Grid>
<Interactivity:Interaction.Behaviors>
<Core:EventTriggerBehavior EventName="Tapped">
<Core:InvokeCommandAction Command="{Binding NavigateToChildrenCommand}" />
</Core:EventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</source>

Notice here that "Interactivity" and "Core" are both namespaces and you have to make sure that they are defined at the root of your XAMLs like the following.

<source lang = "xml">
<DataTemplate
...
xmlns:Core="using:Microsoft.Xaml.Interactions.Core"
xmlns:Interactivity="using:Microsoft.Xaml.Interactivity">
...
</DataTemplate>
</source>

=== Fit mode ===
If you are using the standard app without XAML customizings, the [[UBIK_WinX_Client_Basics#Fit_Mode|fit mode]] feature should work out of the box.
However, when using a FlipView for displaying documents in your customized XAMLs, you must make sure to include the following binding to the FlipView's ItemTemplate so that the fit modes are properly applied.

<source lang = "xml">
<DataTemplate
...
xmlns:hs="using:UBIK.WinX.HotSpotting.Document">
...
<Grid.Resources>
...
<DataTemplate x:Key="FlipDocItemTemplate">
...
<hs:Document
...
FitMode="{Binding DocumentViewModel.FitMode}" />
</DataTemplate>
</Grid.Resources>
</DataTemplate>
</source>

=== Content creation ===
To directly create an object on a child of the current object, you can define a Button as follows. The method "Item.IsTypeCreationAllowed" used in the expression gets the uid of the type that should be created below a child, if a child does not allow the creation of that type underneath it, the child will be hidden in the selection dialog. To actually create the object, the "CreateChildItemCommand" needs to be passed a KeyValueList with two parameters: The Parent-key is the ContentViewModel of the child underneath the object should be created, the Type-key is the type of object which should be created--this should match the uid passed to the "Item.IsTypeCreationAllowed" method.
<source lang = "xml">
<x:String x:Key="PlantMap">Item.IsTypeCreationAllowed("21fc990a-d064-4bee-8d48-3293351f827a")</x:String>
<cv:ListCollectionView x:Key="PlantMapView" Expression="{StaticResource PlantMap}" ItemsSource="{Binding Children.Items}" />

<AppBarButton>
<AppBarButton.Flyout>
<Flyout Placement="Full">
<ListView ItemsSource="{Binding Source={StaticResource PlantMapView}}">
<ListView.ItemTemplate>
<DataTemplate>
<Button Content="{Binding Header}" Command="{Binding CreateChildItemCommand}" x:Name="CreateButton" Tag="{Binding}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Parent" Value="{Binding Tag, ElementName=CreateButton}"/>
<uc:KeyValueParameter Key="Type" Value="21fc990a-d064-4bee-8d48-3293351f827a"/>
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</Flyout>
</AppBarButton.Flyout>
</AppBarButton>
</source>

=== Hotspotting ===

The hotspotting command is used for hotspotting as well as for annotating, to configure the button for hotspotting, the commandparameter "Mode" should be set to "HotSpotting", for annotating the "Mode" should be "Annotate". The parameter commit is optional, if set to true, the changes get automatically persisted when leaving the editing mode.

<source lang = "xml">
<AppBarToggleButton
IsChecked="{Binding EditingAnnotation, Mode=TwoWay}"
IsEnabled="{Binding IsAnnotatable}"
Command="{Binding HotSpottingCommand}">
<AppBarToggleButton.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Mode" Value="Annotate"/>
<uc:KeyValueParameter Key="Commit" Value="true"/>
</uc:KeyValueList>
</AppBarToggleButton.CommandParameter>
</AppBarToggleButton>
</source>

== Performance related ==

=== FlipView ===
When using the FlipView control in your XAML code, it's better to enable [https://docs.microsoft.com/en-us/windows/uwp/debug-test-perf/optimize-gridview-and-listview#ui-virtualization UI virtualization]. The difference in performance gets more obvious as the number of items in the FlipView increases. Here's how to enable it.

<source lang = "xml">
<FlipView
...
VirtualizingStackPanel.VirtualizationMode="Standard">
<Flipview.ItemsPanel>
<ItemsPanelTemplate>
<VirtualizingStackPanel Orientation="Horizontal" />
</ItemsPanelTemplate>
</Flipview.ItemsPanel>
</FlipView>
</source>

VirtualizingStackPanel.VirtualizationMode offers two possibilities: Standard & Recycling. In case you are interested, here are their [https://docs.microsoft.com/en-us/dotnet/api/system.windows.controls.virtualizationmode?view=netframework-4.7.2 differences].

XAML Tips

2019-05-08T05:10:34Z

CWU: /* Content creation */

== Functionality related ==

=== Attachable behaviors ===
It's quite often that you need to attach behaviors to certain XAML elements. For example, on a Grid, you want to attach a behavior which executes a command upon a Tapped event like the following.

<source lang = "xml">
<Grid>
<Interactivity:Interaction.Behaviors>
<Core:EventTriggerBehavior EventName="Tapped">
<Core:InvokeCommandAction Command="{Binding NavigateToChildrenCommand}" />
</Core:EventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</source>

Notice here that "Interactivity" and "Core" are both namespaces and you have to make sure that they are defined at the root of your XAMLs like the following.

<source lang = "xml">
<DataTemplate
...
xmlns:Core="using:Microsoft.Xaml.Interactions.Core"
xmlns:Interactivity="using:Microsoft.Xaml.Interactivity">
...
</DataTemplate>
</source>

=== Fit mode ===
If you are using the standard app without XAML customizings, the [[UBIK_WinX_Client_Basics#Fit_Mode|fit mode]] feature should work out of the box.
However, when using a FlipView for displaying documents in your customized XAMLs, you must make sure to include the following binding to the FlipView's ItemTemplate so that the fit modes are properly applied.

<source lang = "xml">
<DataTemplate
...
xmlns:hs="using:UBIK.WinX.HotSpotting.Document">
...
<Grid.Resources>
...
<DataTemplate x:Key="FlipDocItemTemplate">
...
<hs:Document
...
FitMode="{Binding DocumentViewModel.FitMode}" />
</DataTemplate>
</Grid.Resources>
</DataTemplate>
</source>

=== Content creation ===
To directly create an object on a child of the current object, you can define a Button as follows. The method "Item.IsTypeCreationAllowed" used in the expression gets the uid of the type that should be created below a child, if a child does not allow the creation of that type underneath it, the child will be hidden in the selection dialog. To actually create the object, the "CreateChildItemCommand" needs to be passed a KeyValueList with two parameters: The Parent-key is the ContentViewModel of the child underneath the object should be created, the Type-key is the type of object which should be created--this should match the uid passed to the "Item.IsTypeCreationAllowed" method.
<source lang = "xml">
<x:String x:Key="PlantMap">Item.IsTypeCreationAllowed("21fc990a-d064-4bee-8d48-3293351f827a")</x:String>
<cv:ListCollectionView x:Key="PlantMapView" Expression="{StaticResource PlantMap}" ItemsSource="{Binding Children.Items}" />

<AppBarButton>
<AppBarButton.Flyout>
<Flyout Placement="Full">
<ListView ItemsSource="{Binding Source={StaticResource PlantMapView}}">
<ListView.ItemTemplate>
<DataTemplate>
<Button Content="{Binding Header}" Command="{Binding CreateChildItemCommand}" x:Name="CreateButton" Tag="{Binding}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Parent" Value="{Binding Tag, ElementName=CreateButton}"/>
<uc:KeyValueParameter Key="Type" Value="21fc990a-d064-4bee-8d48-3293351f827a"/>
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</Flyout>
</AppBarButton.Flyout>
</AppBarButton>
</source>

== Performance related ==

=== FlipView ===
When using the FlipView control in your XAML code, it's better to enable [https://docs.microsoft.com/en-us/windows/uwp/debug-test-perf/optimize-gridview-and-listview#ui-virtualization UI virtualization]. The difference in performance gets more obvious as the number of items in the FlipView increases. Here's how to enable it.

<source lang = "xml">
<FlipView
...
VirtualizingStackPanel.VirtualizationMode="Standard">
<Flipview.ItemsPanel>
<ItemsPanelTemplate>
<VirtualizingStackPanel Orientation="Horizontal" />
</ItemsPanelTemplate>
</Flipview.ItemsPanel>
</FlipView>
</source>

VirtualizingStackPanel.VirtualizationMode offers two possibilities: Standard & Recycling. In case you are interested, here are their [https://docs.microsoft.com/en-us/dotnet/api/system.windows.controls.virtualizationmode?view=netframework-4.7.2 differences].

XAML Tips

2019-05-07T08:31:24Z

CWU: /* Content creation */

== Functionality related ==

=== Attachable behaviors ===
It's quite often that you need to attach behaviors to certain XAML elements. For example, on a Grid, you want to attach a behavior which executes a command upon a Tapped event like the following.

<source lang = "xml">
<Grid>
<Interactivity:Interaction.Behaviors>
<Core:EventTriggerBehavior EventName="Tapped">
<Core:InvokeCommandAction Command="{Binding NavigateToChildrenCommand}" />
</Core:EventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</source>

Notice here that "Interactivity" and "Core" are both namespaces and you have to make sure that they are defined at the root of your XAMLs like the following.

<source lang = "xml">
<DataTemplate
...
xmlns:Core="using:Microsoft.Xaml.Interactions.Core"
xmlns:Interactivity="using:Microsoft.Xaml.Interactivity">
...
</DataTemplate>
</source>

=== Fit mode ===
If you are using the standard app without XAML customizings, the [[UBIK_WinX_Client_Basics#Fit_Mode|fit mode]] feature should work out of the box.
However, when using a FlipView for displaying documents in your customized XAMLs, you must make sure to include the following binding to the FlipView's ItemTemplate so that the fit modes are properly applied.

<source lang = "xml">
<DataTemplate
...
xmlns:hs="using:UBIK.WinX.HotSpotting.Document">
...
<Grid.Resources>
...
<DataTemplate x:Key="FlipDocItemTemplate">
...
<hs:Document
...
FitMode="{Binding DocumentViewModel.FitMode}" />
</DataTemplate>
</Grid.Resources>
</DataTemplate>
</source>

=== Content creation ===
To directly create an object on a child of the current object, you can define a Button as follows. The method "Item.IsTypeCreationAllowed" used in the expression gets the uid of the type that should be created below a child, if a child does not allow the creation of that type underneath it, the child will be hidden in the selection dialog. To actually create the object, the "CreateChildItemCommand" needs to be passed a KeyValueList with two parameters: The Parent-key is the uid of the child underneath the object should be created, the Type-key is the type of object which should be created--this should match the uid passed to the "Item.IsTypeCreationAllowed" method.
<source lang = "xml">
<x:String x:Key="PlantMap">Item.IsTypeCreationAllowed("21fc990a-d064-4bee-8d48-3293351f827a")</x:String>
<cv:ListCollectionView x:Key="PlantMapView" Expression="{StaticResource PlantMap}" ItemsSource="{Binding Children.Items}" />

<AppBarButton Grid.Column="3" Icon="PreviewLink" Style="{ThemeResource UBIKGlobalChildAppBarAppBarButton}" x:Key="createChildButton" Visibility="Visible">
<AppBarButton.Flyout>
<Flyout Placement="Full">
<ListView Margin="-15" BorderThickness="0" ItemsSource="{Binding Source={StaticResource PlantMapView}}" SelectionMode="None">
<ListView.ItemTemplate>
<DataTemplate>
<Button Content="{Binding Header}" Command="{Binding CreateChildItemCommand}" x:Name="CreateButton" Tag="{Binding UID}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Parent" Value="{Binding Tag, ElementName=CreateButton}"/>
<uc:KeyValueParameter Key="Type" Value="21fc990a-d064-4bee-8d48-3293351f827a"/>
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</Flyout>
</AppBarButton.Flyout>
</AppBarButton>
</source>

== Performance related ==

=== FlipView ===
When using the FlipView control in your XAML code, it's better to enable [https://docs.microsoft.com/en-us/windows/uwp/debug-test-perf/optimize-gridview-and-listview#ui-virtualization UI virtualization]. The difference in performance gets more obvious as the number of items in the FlipView increases. Here's how to enable it.

<source lang = "xml">
<FlipView
...
VirtualizingStackPanel.VirtualizationMode="Standard">
<Flipview.ItemsPanel>
<ItemsPanelTemplate>
<VirtualizingStackPanel Orientation="Horizontal" />
</ItemsPanelTemplate>
</Flipview.ItemsPanel>
</FlipView>
</source>

VirtualizingStackPanel.VirtualizationMode offers two possibilities: Standard & Recycling. In case you are interested, here are their [https://docs.microsoft.com/en-us/dotnet/api/system.windows.controls.virtualizationmode?view=netframework-4.7.2 differences].

XAML Tips

2019-05-07T08:29:42Z

CWU: /* Functionality related */

== Functionality related ==

=== Attachable behaviors ===
It's quite often that you need to attach behaviors to certain XAML elements. For example, on a Grid, you want to attach a behavior which executes a command upon a Tapped event like the following.

<source lang = "xml">
<Grid>
<Interactivity:Interaction.Behaviors>
<Core:EventTriggerBehavior EventName="Tapped">
<Core:InvokeCommandAction Command="{Binding NavigateToChildrenCommand}" />
</Core:EventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</source>

Notice here that "Interactivity" and "Core" are both namespaces and you have to make sure that they are defined at the root of your XAMLs like the following.

<source lang = "xml">
<DataTemplate
...
xmlns:Core="using:Microsoft.Xaml.Interactions.Core"
xmlns:Interactivity="using:Microsoft.Xaml.Interactivity">
...
</DataTemplate>
</source>

=== Fit mode ===
If you are using the standard app without XAML customizings, the [[UBIK_WinX_Client_Basics#Fit_Mode|fit mode]] feature should work out of the box.
However, when using a FlipView for displaying documents in your customized XAMLs, you must make sure to include the following binding to the FlipView's ItemTemplate so that the fit modes are properly applied.

<source lang = "xml">
<DataTemplate
...
xmlns:hs="using:UBIK.WinX.HotSpotting.Document">
...
<Grid.Resources>
...
<DataTemplate x:Key="FlipDocItemTemplate">
...
<hs:Document
...
FitMode="{Binding DocumentViewModel.FitMode}" />
</DataTemplate>
</Grid.Resources>
</DataTemplate>
</source>

=== Content creation ===
To directly create an object on a child of the current object, you can define a Button as follows. The method "Item.IsTypeCreationAllowed" used in the expression gets the uid of the type that should be created below a child, if a child does not allow the creation of that type underneath it, the child will be hidden in the selection dialog. To actually create the object, the "CreateChildItemCommand" needs to be passed a KeyValueList with two parameters: The Parent-key is the uid of the child underneath the object should be created, the Type-key is the type of object which should be created--this should match the uid passed to the "Item.IsTypeCreationAllowed" method.

<source lang = "xml">
<x:String x:Key="PlantMap">Item.IsTypeCreationAllowed("21fc990a-d064-4bee-8d48-3293351f827a")</x:String>
<cv:ListCollectionView x:Key="PlantMapView" Expression="{StaticResource PlantMap}" ItemsSource="{Binding Children.Items}" />

<AppBarButton Grid.Column="3" Icon="PreviewLink" Style="{ThemeResource UBIKGlobalChildAppBarAppBarButton}" x:Key="createChildButton" Visibility="Visible">
<AppBarButton.Flyout>
<Flyout Placement="Full">
<ListView Margin="-15" BorderThickness="0" ItemsSource="{Binding Source={StaticResource PlantMapView}}" SelectionMode="None">
<ListView.ItemTemplate>
<DataTemplate>
<Button Content="{Binding Header}" Command="{Binding CreateChildItemCommand}" x:Name="CreateButton" Tag="{Binding UID}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Parent" Value="{Binding Tag, ElementName=CreateButton}"/>
<uc:KeyValueParameter Key="Type" Value="21fc990a-d064-4bee-8d48-3293351f827a"/>
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</Flyout>
</AppBarButton.Flyout>
</AppBarButton>
</source>

== Performance related ==

=== FlipView ===
When using the FlipView control in your XAML code, it's better to enable [https://docs.microsoft.com/en-us/windows/uwp/debug-test-perf/optimize-gridview-and-listview#ui-virtualization UI virtualization]. The difference in performance gets more obvious as the number of items in the FlipView increases. Here's how to enable it.

<source lang = "xml">
<FlipView
...
VirtualizingStackPanel.VirtualizationMode="Standard">
<Flipview.ItemsPanel>
<ItemsPanelTemplate>
<VirtualizingStackPanel Orientation="Horizontal" />
</ItemsPanelTemplate>
</Flipview.ItemsPanel>
</FlipView>
</source>

VirtualizingStackPanel.VirtualizationMode offers two possibilities: Standard & Recycling. In case you are interested, here are their [https://docs.microsoft.com/en-us/dotnet/api/system.windows.controls.virtualizationmode?view=netframework-4.7.2 differences].

UBIK WinX Client Basics

2019-04-03T08:39:28Z

CWU:

{{UBIK}} Client is the mobile application for viewing and modifying data, showing documents, starting navigation, visualizing POIs and much more.

Client applications are available for Android and WinX, however the features available on each of the platform dependent applications might differ. An overview of the available features can be found in the [[Client_Feature_Table|feature comparison table]].

== Login ==
Users need to login in order to access confidential data, this can be done in the [[Login View]].

== Profiles ==
Profiles are used to store connection information for {{UBIK}} services. It specifies the location where to find the service along with other useful informations. Profiles are stored by UBIK whenever the user created connection information and stored it in the settings. However, profiles can also be created and edited with any text editor. Possible settings to be defined are:
* InternalConnectionSettings: Connections settings how to connect to the Content and the USAM service that has been set up.
** Application: the [[APPLICATION]] to use with the service
** AuthenticationPort: Port Number of the authentication (USAM) service (default: 777)
** AuthenticationProtocol: Protocol of the authentication service (default: https)
** AuthenticationServer: the ip address of the authentication server
** AuthenticationService: the path to the authentication service
** ContentPort: Port Number of the content service (default: 777)
** ContentProtocol: Protocol of the content service (default: https)
** ContentServer: the ip address of the content server
** ContentService: the path to the content service
** Context: the [[CONTEXT]] to use with the service
** SyncMode: the used sync mode (Online [= Auto], Manual, Offline; default:Online)
* IsDefault: true, if the profile should be the default profile
* Name: the name of the profile (will also be used to identify the database)
** If the profile name contains invalid characters like: /, ", <, >, ... they will be replaced with %_
* Project: the project name. Use this to share a single project name with more than one profile. If the project is defined, all profile with the same project will share one database.
* Customizing: the XAML subfolder to use for customized UI. This parameter can be used to share one single XAML customizing folder for multiple profiles.
* ShowHiddenSettings: show hidden settings (feault: false)

Example:
<source lang = "xml">
<?xml version="1.0" encoding="utf-8"?>
<Profile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UBIK.WinX.Settings">
<Customizing>MYAPPLICATIONUI</Customizing>
<Description i:nil="true" />
<InternalConnectionSettings>
<Application>APP_DEMO</Application>
<AuthenticationPort>777</AuthenticationPort>
<AuthenticationProtocol>https</AuthenticationProtocol>
<AuthenticationServer>80.243.175.50</AuthenticationServer>
<AuthenticationService>UBIK/DBG/AUG/DEMO.250/USAM/USAM.svc</AuthenticationService>
<ContentPort>777</ContentPort>
<ContentProtocol>https</ContentProtocol>
<ContentServer>80.243.175.50</ContentServer>
<ContentService>UBIK/DBG/AUG/DEMO.250/CONTENT/UBIKContent.svc</ContentService>
<Context>CXT_DEMO</Context>
<SyncMode>Online</SyncMode>
</InternalConnectionSettings>
<IsDefault>true</IsDefault>
<Name>DEMO.250.AT</Name>
<Project>DEMO.250</Project>
<ShowHiddenSettings>false</ShowHiddenSettings>
</Profile>
</source>

== Content Browser ==
Allows to navigate through the entire data model in a hierarchical manner, as it is published by the server.

Initially, a list of objects ("root objects") is shown. Upon selecting an object, a new browser is opened for that object, showing details about it. When an object is selected in the content browser, it is called the browser's context. For such a contextual object, child objects and selected properties are shown. Also, there is a context menu providing actions related to the currently selected object.

=== Status Bar ===
[[File:UI_WinX_DbSavingIndicator.PNG|300 px|thumb|border|alt=Saving Symbol|Saving Symbol]]
{{Version/WinXSince|2.5.4}}Whenever content is being saved into the local database (for example, after a branch is downloaded from the server), there will be a blinking symbol indicating the saving activity is happening in the background.
During that time, the user is advised to not logout or close the app because the content might be lost otherwise. However, it is okay to undertake other tasks such as browsing, editing or downloading branches.

=== Child Page ===

[[File:ChildPage.PNG|400 px|thumb|border|alt=Child Page|Child Page]]

The child page shows the context of a selected object.

The global status bar shows the icon, the name and the description of the selected object. An arrow on the left side allows the user to navigate back to the parent object. On the right side the currently logged-in user is indicated. By clicking on the username one is able to navigate back to the home screen or log off.

The right side of the child page shows child objects of the current object. Each child object is represented by an icon, a name and a description.

On the left side of the child page the current object´s high priority properties are shown. By clicking on a live value property, the live value details dialog opens. By clicking on an editable [[UBIK_WinX_Client_Basics#High_priority_properties| high priority property]], an editor opens {{Version/WinXSince|2.5.4}}. If a property was edited a save button is shown in the lower left corner, allowing the user to commit the changes. If a property of a query object was edited an evaluate button is shown in the lower left corner, allowing the user to run the query with the changed propery.

=== Details Page ===

=== Context Menu ===

=== Objects ===

==== Root objects vs child objects ====

The first entry point in the ''Content Browser'' is the list of root objects.

==== Task objects ====

==== Query objects ====

==== Safety relevant objects ====

==== Commissioning objects ====

==== Locked objects ====

=== Properties ===

==== Live value properties ====

==== High priority properties ====
High priority properties are properities having a priority higher than the [[Settings#Content |priority threshold]].

==== Selective List Properties ====

==== Properties with value records {{Version/WinXSince|2.5.4}} ====
[[File:UI_WinX_PropertyWithValueRecords.png|thumb|A property with value records]]
[[File:UI_WinX_PropertyValueRecords.png|thumb|Property value records dialog]]
In addition to its value, a property might also bring along a series of value records showing "who changed the value at what time".

When such records exist, the property row shows a special symbol on the right side. After a right click (with mouse) or a long tap (with touch) on the property row, a dialog will be shown to present these records (sorted by their time, recent ones on top).

{{Clear}}

==== Editors ====

===== Geo Editor & Teach In =====

==== Guid editor ====
[[File:Guid_property_dialog.PNG|thumb|border|alt=Guid property editor dialog|Guid property editor dialog]]

To edit Guid properties (that do not have a selective list available), we have implemented a special system. Since a Guid property always just contains the Guid as a reference to another object, we can use a query to find the object we want to assign to this property.

When the Guid property has a FilterQuery datamember (which should contain the guid of a query), it will become editable through this query. Note that this FilterQuery guid will not actually be visible in the client. All this should be setup in the backend, the client has no control over this.

When clicking an editable Guid property, you will see a dialog with up to 3 extra buttons added (see image):

;View Object
:This button will be enabled when there is a valid guid assigned to the property. Clicking this button will immediately navigate to the referenced object.
;Edit Property
:If the property has a valid FilterQuery assigned to it, clicking this button will launch that query. If no FilterQuery is assigned, this button will be invisible.
;Clear Property Value
:If the property has a guid assigned, the user can press this button to reset the value back to empty.

Additionally, if a valid FilterQuery is assigned, the user will see the results of that query ''inline'', if the query delivers 200 results or fewer. The user can select an item from this horizontally scrollable list, and press "OK" to assign the UID of the selected object to the Guid property. This is useful for cases where the user does not want to jump into the full query to be able to select an object.

If the user does choose to launch the full query page (or if the query returns over 200 objects), they can click any of the displayed items in the query's child list. When clicking one of them, it will immediately be set as the reference in the original Guid property. To cancel selecting an item (and stop editing the property), simply navigate to any other page (by pressing back, using navigation bar, etc).

{{hint|'''Skipping the dialog'''
If editing the property in a query page without having to go through the dialog is desired, one can customize the boolean variable "SkipQueryDialog" in UBIKThemes.xaml. If none can be found, simply add the following line into its "Default" ResourceDictionary.
<source lang = "xml"><x:Boolean x:Key="SkipQueryDialog">True</x:Boolean></source>
}}

=== Documents ===
UBIK supports and displays document objects and a bunch of actions related to them (editing, redlining, creation, thumbnails, ...).

==== Fit Mode{{Version/WinXSince|3.5}} ====
By default, documents are displayed in their original dimensions. But administrators can also [[SYSCLS_DOCUMENT_FITMODE|configure different fit modes]] for each document. The following demonstrates how documents can look under different fit modes.

{| class="wikitable" | width = "100%" style="text-align: center;"
|-
! Unspecified / Unscaled / Default !! Fit to container !! Fit to width !! Fit to height
|-
| [[File:UI_WinX_FitMode_Unspecified_Small.png|240x225px]] || [[File:UI_WinX_FitMode_Container_Small.png|240x225px]] || [[File:UI_WinX_FitMode_Width_Small.png|240x225px]] || [[File:UI_WinX_FitMode_Height_Small.png|240x225px]]
|-
| [[File:UI_WinX_FitMode_Unspecified_Large.png|240x225px]] || [[File:UI_WinX_FitMode_Container_Large.png|240x225px]] || [[File:UI_WinX_FitMode_Width_Large.png|240x225px]] || [[File:UI_WinX_FitMode_Height_Large.png|240x225px]]
|}

{{Hint|Double tapping on a document toggles the display between "Fit to width" and the fit mode that document is configured with.}}

==== Customizing Possibilities ====

==== Editing{{Version/WinXSince|2.5.4}} ====
[[File:UI_WinX_EditDocumentButton.png|thumb|Button to edit a document]]
For [[SYSCLS_EDITABLEDOCUMENT|editable documents]], there is an {{key press|edit}} button in the bottom app bar. It allows the user to edit a document file using the default app of the OS. If a file is changed during the edit, the same {{key press|save}} button appears just like it does for content with changed properties.
{{Hint|Similar to saving, other app features also apply on edited documents. For example, reverting local changes for an edited document will throw away the changed document file and restore it to the server version.}}
[[File:UI_WinX_EditDocumentOverlayButton.png|thumb|Edit button in thumbnail overlay]]
An alternative way to start editing is to right click on a document's thumbnail, which brings up an overlay of buttons, and then select the {{key press|edit}} button. The difference here is that there is no {{key press|save}} button and any changes are automatically saved (and committed if in online mode).
{{Clear}}

==== Offline availability ====
When a user selects a branch to bring offline, files of all document objects underneath are downloaded in principle. However, they can also be selectively configured to be ignored with a [[SYSCLS_OFFLINE_AVAILABLE_DOCUMENT|classification]] on the server-side. Once a document is classified as offline available, the document file will not be removed when the storage for already synchronized document files is cleared.
{{Hint|This is not to be confused with the accessibility related to [[User_Rights|user rights]]. The logic here is "some documents '''do not have to''' be downloaded", not "some documents '''can not''' be downloaded/accessed". In other words, a user can browse to and open the document regardless of this configuration.}}

==== Clear Online Documents ====
By clearing the online documents, it is possible to free up system memory if needed. It can be triggered by pressing the button "Clear online documents" in the general settings tab. Online documents are documents already uploaded to the server. They can be downloaded anytime agian when the client is connected to the server. However, documents classified as offline available will not be affected and will always stay on the device.

== AR Features ==

=== POI View ===
Brings up the POI View|Augmented Reality view and displays Points of Interest (POI's) related to the current location of the mobile device.

=== Markerless ===

=== Map View ===
Opens the Map View and displays Points of Interest (POI's) related to the current location of the mobile device.

== Positioning ==
{{UBIK}} clients use a [[Location_Manager|Location Manager]] in order to gain knowledge about their position, so it can help the user navigate to his/her target.

The user can choose one of different positioning modes optimized for different environments.
Most of them incorporate multiple technologies for calculating positions or checking their reliability.

=== Positioning modes ===

* ''Use all'' - uses all available position sources
* ''LLA only mode'' - used for positioning using markers only
* ''Beacon Proximity mode'' - uses iBeacon proximity and LLA only

=== Technologies ===

==== GPS ====
GPS is used as a primary positioning input source for outdoor areas. Its precision depends on the environment and satellite availability. With good circumstances, the accuracy varies between 1 and 10 meters.

==== LLA markers ====
LLA markers basically are QR codes with location data encoded into them - which can be used for positioning when they are scanned.

==== Object Proximity Positioning ====
The location of nearby Geo-Objects can be used for positioning.

The position of a Geo-Object can be used manually by pushing the button {{key press|Use Location}} in the [[UBIK_WinX_Client_Basics#Context_Menu|Context Menu]].

The geo information of an object gets used automatically if exactly one single object is found through scanning. If more objects are found, their geo information doesn´t get used. Scanning includes [[UBIK Client Basics#Bar Code|Bar Code]], [[UBIK Client Basics#QR Code|QR Code]], [[UBIK Client Basics#OCR|OCR]] and [[UBIK Client Basics#RFID|RFID]]. The automatic use of Geo-Object´s location can be turned off by disabling the "EnableObjectProximityPositioning" setting.

==== Beacon-Proximity Positioning ====
The Beacon Proximity Mode detects if the user is in the proximity of a beacon. The proximity region is defined by a proximity distance which creates a sphere around the beacon. Whenever the calculated distance to a beacon is smaller than the proximity distance, the user is supposed to be at the position of the beacon. If multiple regions intersect the user is supposed to be at the position of the nearest beacon.
In order to use Beacon Proximity as a Positioning System, Bluetooth Low Energy has to be available and enabled on the mobile device. If a new environment should be equipped with iBeacon-Positioning, an expert has to mount iBeacons on known positions and calibrate the propagation factor of these beacons. Proximity beacons can be configured using [[SYSCLS_PROXIMITY_BEACON]]. {{Version/WinXSince|UWP}}

== Finding Objects ==
=== Free Text Search ===

=== ID Marker ===

=== QR Code ===

=== Bar Code ===

=== RFID Code ===
Provides a fast and convenient way for users to find objects that are identifiable through [[RFID tags|RFID tags]].

=== OCR ===

== See also ==
* [[Client_Feature_Table]]

[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]