UBIK Wiki / Augmensys - User contributions [en]

Active List Client

2026-04-23T13:49:29Z

CWI: /* XAML */

{{UnderConstructionStart}}

==Introduction {{Version/WinXSince|5.1.0.0}} {{Version/MobileSince|5.1.0.0}}==
If an Active List is defined on a [[Instance|Content Object]] that is associated with an [[MetaProperty#Integer|integer]] [[MetaProperty]], the property is displayed like a usual [[UBIK WinX Client Basics#Selective List Properties|SelectiveList]] which is based on a [[MetaProperty]]. An ActiveList (i.e., if it has been configured on the server for a content object) always takes precedence over a MetaProperty SelectiveList. For editing, it behaves exactly the same as with a standard [[SELECTIVELIST|SelectiveList]].

{{Hint|There are no visible differences in the UI between an ActiveList and a MetaProperty SelectiveList.}}

'''Limitations'''
<br>
* [[Multi_Select_%28UBIK_Client%29#Editing_common_properties_of_selected_items_.28UWP_only.29|Mass editing]] is currently not supported for Properties containing Active Lists.
* Copy and Paste for Active Lists is not supported. When copying an object containing Active Lists, the copy of the object will not contain these Active Lists. In this case, the editing UI of the pasted object will appear like that of a standard Integer Property. If a value has already been selected, this value will be copied, though.

=== XAML ===
A new SelectiveItems property was added to the PropertyViewModel to enable access to an ActiveList via XAML. No DataTriggers or additional checks are required, as the correct list selection is handled automatically. As also mentioned [[UBIK_WinX_Client_Basics#Selective_List_Properties|here]], the following XAML changes are necessary:

'''Required adaptions of the ''ItemsSource'' binding:'''
If you have old customizings, the '''ItemsSource''' binding needs to be adapted. Instead of binding to the ''PropertyViewModel'' and using the ''SelectiveListToItemsConverter'', you should now directly bind to ''PropertyViewModel.SelectiveItems'' without the use of a SelectiveListToItemsConverter. In the case of previously binding to ''MetaProperty.SelectiveList.Items'' (or ''MetaProperty.SelectiveList'' plus using the ''SelectiveListToItemsConverter''), the binding should be changed to ''SelectiveItems'' only.
Depending on whether a SelectiveList or an ActiveList is configured, the proper list will be chosen automatically.

'''Refactoring of the ''SelectedItem ConverterParameter'' binding (Mobile only):'''
Instead of binding to the ContentView x:Name (e.g. ''ConverterParameter={Binding Source={x:Reference YourContentView}}''), it should be changed to the x:Name of the SfListViewExt control and adding the ItemsSource as Path (e.g. ''ConverterParameter={Binding Source={x:Reference SelectiveList}, Path=ItemsSource}'').

<tabs>
<tab name="Mobile (MAUI)">
<source lang = "xml">
xmlns:controls="clr-namespace:UBIK.MAUI.Controls"

<controls:SfListViewExt
x:Name="SelectiveList"
BindingContext="{TemplateBinding BindingContext}"
ItemSize="40"
ItemTemplate="{StaticResource PopupSelectiveListItemTemplate}"
ItemsSource="{Binding SelectiveItems}"
SelectedItem="{Binding ValueItem.PropertyValue, Mode=OneWay, Converter={StaticResource PropertyValueToSelectiveItem}, ConverterParameter={Binding Source={x:Reference SelectiveList}, Path=ItemsSource}}"
SelectionBackground="{DynamicResource UBIKAccentColor}"
SelectionMode="Single"
Style="{DynamicResource UBIKListView}" />
</source>
</tab>
<tab name="UWP">
<source lang = "xml">
xmlns:controls="using:UBIK.WinX.Controls"

<controls:ComboBoxExt
x:Name="ComboBox"
Grid.ColumnSpan="2"
HorizontalAlignment="Stretch"
DisplayMemberPath="DisplayText"
ItemsSource="{Binding PropertyViewModel.SelectiveItems}"
PlaceholderText="{Binding PropertyEdit_PickerPlaceholder, Source={StaticResource AppResources}}"
SelectedValue="{Binding PropertyValue, Mode=TwoWay}"
SelectedValuePath="Value"
Visibility="{Binding PropertyViewModel.ShowComboBox, Converter={StaticResource BoolToVisConverter}}" />
</source>
</tab>

<tab name="Mobile (MAUI) before change">
<source lang = "xml">
xmlns:controls="clr-namespace:UBIK.MAUI.Controls"

<ContentView x:Name="YourContentView" ...>
<controls:SfListViewExt
x:Name="SelectiveList"
BindingContext="{TemplateBinding BindingContext}"
ItemSize="40"
ItemTemplate="{StaticResource PopupSelectiveListItemTemplate}"
ItemsSource="{Binding PropertyViewModel, Converter={StaticResource SelectiveListToItems}}"
SelectedItem="{Binding ValueItem.PropertyValue, Mode=OneWay, Converter={StaticResource PropertyValueToSelectiveItem}, ConverterParameter={Binding Source={x:Reference YourContentView}}}"
SelectionBackground="{DynamicResource UBIKAccentColor}"
SelectionMode="Single"
Style="{DynamicResource UBIKListView}" />
...
</ContentView>
</source>
</tab>
<tab name="UWP before change">
<source lang = "xml">
xmlns:controls="using:UBIK.WinX.Controls"

<controls:ComboBoxExt
x:Name="ComboBox"
Grid.ColumnSpan="2"
HorizontalAlignment="Stretch"
DisplayMemberPath="DisplayText"
ItemsSource="{Binding PropertyViewModel, Converter={StaticResource SelectiveListToItemsConverter}}"
PlaceholderText="{Binding PropertyEdit_PickerPlaceholder, Source={StaticResource AppResources}}"
SelectedValue="{Binding PropertyValue, Mode=TwoWay}"
SelectedValuePath="Value"
Visibility="{Binding PropertyViewModel.ShowComboBox, Converter={StaticResource BoolToVisConverter}}" />
</source>
</tab>
</tabs>

[[Category:Client|Active List Client]]
[[Category:Mobile|Active List Client]]
[[Category:Version 5.1|Active List Client]]
[[Category:WinX|Active List Client]]

== See also ==
* [[UBIK Active Lists|Active Lists Server]]
* [[MROCLS PICK LIST TASK|Pick List Task]]
* [[MRO_Objects_(Client)#Pick_List_Task|MRO Objects (Client) Pick List Task]]

{{UnderConstructionEnd}}

[[Category:Client|Active List Client]]
[[Category:Mobile|Active List Client]]
[[Category:Version 5.1|Active List Client]]
[[Category:WinX|Active List Client]]

Active List Client

2026-04-23T13:45:34Z

CWI: /* XAML */

{{UnderConstructionStart}}

==Introduction {{Version/WinXSince|5.1.0.0}} {{Version/MobileSince|5.1.0.0}}==
If an Active List is defined on a [[Instance|Content Object]] that is associated with an [[MetaProperty#Integer|integer]] [[MetaProperty]], the property is displayed like a usual [[UBIK WinX Client Basics#Selective List Properties|SelectiveList]] which is based on a [[MetaProperty]]. An ActiveList (i.e., if it has been configured on the server for a content object) always takes precedence over a MetaProperty SelectiveList. For editing, it behaves exactly the same as with a standard [[SELECTIVELIST|SelectiveList]].

{{Hint|There are no visible differences in the UI between an ActiveList and a MetaProperty SelectiveList.}}

'''Limitations'''
<br>
* [[Multi_Select_%28UBIK_Client%29#Editing_common_properties_of_selected_items_.28UWP_only.29|Mass editing]] is currently not supported for Properties containing Active Lists.
* Copy and Paste for Active Lists is not supported. When copying an object containing Active Lists, the copy of the object will not contain these Active Lists. In this case, the editing UI of the pasted object will appear like that of a standard Integer Property. If a value has already been selected, this value will be copied, though.

=== XAML ===
A new SelectiveItems property was added to the PropertyViewModel to enable access to an ActiveList via XAML. No DataTriggers or additional checks are required, as the correct list selection is handled automatically. As also mentioned [[UBIK_WinX_Client_Basics#Selective_List_Properties|here]], the following XAML changes are necessary:

'''Required adaptions of the ''ItemsSource'' binding:'''
If you have old customizings, the '''ItemsSource''' binding needs to be adapted. Instead of binding to the ''PropertyViewModel'' and using the ''SelectiveListToItemsConverter'', you should now directly bind to ''PropertyViewModel.SelectiveItems'' without the use of a SelectiveListToItemsConverter. In the case of previously binding to ''MetaProperty.SelectiveList.Items'' (or ''MetaProperty.SelectiveList'' plus using the ''SelectiveListToItemsConverter''), the binding should be changed to ''SelectiveItems'' only.
Depending on whether a SelectiveList or an ActiveList is configured, the proper list will be chosen automatically.

'''Refactoring of the ''SelectedItem ConverterParameter'' binding (Mobile only):'''
Instead of binding to the ContentView x:Name (e.g. ''ConverterParameter={Binding Source={x:Reference YourContentView}}''), it is now possible to bind to the x:Name of the SfListViewExt control and adding the ItemsSource as Path (e.g. ''ConverterParameter={Binding Source={x:Reference SelectiveList}, Path=ItemsSource}'').

<tabs>
<tab name="Mobile (MAUI)">
<source lang = "xml">
xmlns:controls="clr-namespace:UBIK.MAUI.Controls"

<controls:SfListViewExt
x:Name="SelectiveList"
BindingContext="{TemplateBinding BindingContext}"
ItemSize="40"
ItemTemplate="{StaticResource PopupSelectiveListItemTemplate}"
ItemsSource="{Binding SelectiveItems}"
SelectedItem="{Binding ValueItem.PropertyValue, Mode=OneWay, Converter={StaticResource PropertyValueToSelectiveItem}, ConverterParameter={Binding Source={x:Reference SelectiveList}, Path=ItemsSource}}"
SelectionBackground="{DynamicResource UBIKAccentColor}"
SelectionMode="Single"
Style="{DynamicResource UBIKListView}" />
</source>
</tab>
<tab name="UWP">
<source lang = "xml">
xmlns:controls="using:UBIK.WinX.Controls"

<controls:ComboBoxExt
x:Name="ComboBox"
Grid.ColumnSpan="2"
HorizontalAlignment="Stretch"
DisplayMemberPath="DisplayText"
ItemsSource="{Binding PropertyViewModel.SelectiveItems}"
PlaceholderText="{Binding PropertyEdit_PickerPlaceholder, Source={StaticResource AppResources}}"
SelectedValue="{Binding PropertyValue, Mode=TwoWay}"
SelectedValuePath="Value"
Visibility="{Binding PropertyViewModel.ShowComboBox, Converter={StaticResource BoolToVisConverter}}" />
</source>
</tab>

<tab name="Mobile (MAUI) before change">
<source lang = "xml">
xmlns:controls="clr-namespace:UBIK.MAUI.Controls"

<ContentView x:Name="YourContentView" ...>
<controls:SfListViewExt
x:Name="SelectiveList"
BindingContext="{TemplateBinding BindingContext}"
ItemSize="40"
ItemTemplate="{StaticResource PopupSelectiveListItemTemplate}"
ItemsSource="{Binding PropertyViewModel, Converter={StaticResource SelectiveListToItems}}"
SelectedItem="{Binding ValueItem.PropertyValue, Mode=OneWay, Converter={StaticResource PropertyValueToSelectiveItem}, ConverterParameter={Binding Source={x:Reference YourContentView}}}"
SelectionBackground="{DynamicResource UBIKAccentColor}"
SelectionMode="Single"
Style="{DynamicResource UBIKListView}" />
...
</ContentView>
</source>
</tab>
<tab name="UWP before change">
<source lang = "xml">
xmlns:controls="using:UBIK.WinX.Controls"

<controls:ComboBoxExt
x:Name="ComboBox"
Grid.ColumnSpan="2"
HorizontalAlignment="Stretch"
DisplayMemberPath="DisplayText"
ItemsSource="{Binding PropertyViewModel, Converter={StaticResource SelectiveListToItemsConverter}}"
PlaceholderText="{Binding PropertyEdit_PickerPlaceholder, Source={StaticResource AppResources}}"
SelectedValue="{Binding PropertyValue, Mode=TwoWay}"
SelectedValuePath="Value"
Visibility="{Binding PropertyViewModel.ShowComboBox, Converter={StaticResource BoolToVisConverter}}" />
</source>
</tab>
</tabs>

[[Category:Client|Active List Client]]
[[Category:Mobile|Active List Client]]
[[Category:Version 5.1|Active List Client]]
[[Category:WinX|Active List Client]]

== See also ==
* [[UBIK Active Lists|Active Lists Server]]
* [[MROCLS PICK LIST TASK|Pick List Task]]
* [[MRO_Objects_(Client)#Pick_List_Task|MRO Objects (Client) Pick List Task]]

{{UnderConstructionEnd}}

[[Category:Client|Active List Client]]
[[Category:Mobile|Active List Client]]
[[Category:Version 5.1|Active List Client]]
[[Category:WinX|Active List Client]]

Active List Client

2026-04-23T13:34:17Z

CWI: /* XAML */

{{UnderConstructionStart}}

==Introduction {{Version/WinXSince|5.1.0.0}} {{Version/MobileSince|5.1.0.0}}==
If an Active List is defined on a [[Instance|Content Object]] that is associated with an [[MetaProperty#Integer|integer]] [[MetaProperty]], the property is displayed like a usual [[UBIK WinX Client Basics#Selective List Properties|SelectiveList]] which is based on a [[MetaProperty]]. An ActiveList (i.e., if it has been configured on the server for a content object) always takes precedence over a MetaProperty SelectiveList. For editing, it behaves exactly the same as with a standard [[SELECTIVELIST|SelectiveList]].

{{Hint|There are no visible differences in the UI between an ActiveList and a MetaProperty SelectiveList.}}

'''Limitations'''
<br>
* [[Multi_Select_%28UBIK_Client%29#Editing_common_properties_of_selected_items_.28UWP_only.29|Mass editing]] is currently not supported for Properties containing Active Lists.
* Copy and Paste for Active Lists is not supported. When copying an object containing Active Lists, the copy of the object will not contain these Active Lists. In this case, the editing UI of the pasted object will appear like that of a standard Integer Property. If a value has already been selected, this value will be copied, though.

=== XAML ===
A new SelectiveItems property was added to the PropertyViewModel to enable access to an ActiveList via XAML. No DataTriggers or additional checks are required, as the correct list selection is handled automatically. As also mentioned [[UBIK_WinX_Client_Basics#Selective_List_Properties|here]], the following XAML changes are necessary:

'''Required adaptions of the ''ItemsSource'' binding:'''
If you have old customizings, the '''ItemsSource''' binding needs to be adapted. Instead of binding to the ''PropertyViewModel'' and using the ''SelectiveListToItemsConverter'', you should now directly bind to ''PropertyViewModel.SelectiveItems'' without the use of a SelectiveListToItemsConverter. In the case of previously binding to ''MetaProperty.SelectiveList.Items'' (or ''MetaProperty.SelectiveList'' plus using the ''SelectiveListToItemsConverter''), the binding should be changed to ''SelectiveItems'' only.
Depending on whether a SelectiveList or an ActiveList is configured, the proper list will be chosen automatically.

'''Optional refactoring of the ''SelectedItem ConverterParameter'' binding (Mobile only):'''
Instead of binding to the ContentView x:Name (e.g. ''ConverterParameter={Binding Source={x:Reference YourContentView}}''), it is now possible to bind to the x:Name of the SfListViewExt control and adding the ItemsSource as Path (e.g. ''ConverterParameter={Binding Source={x:Reference SelectiveList}, Path=ItemsSource}'').

<tabs>
<tab name="Mobile (MAUI)">
<source lang = "xml">
xmlns:controls="clr-namespace:UBIK.MAUI.Controls"

<controls:SfListViewExt
x:Name="SelectiveList"
BindingContext="{TemplateBinding BindingContext}"
ItemSize="40"
ItemTemplate="{StaticResource PopupSelectiveListItemTemplate}"
ItemsSource="{Binding SelectiveItems}"
SelectedItem="{Binding ValueItem.PropertyValue, Mode=OneWay, Converter={StaticResource PropertyValueToSelectiveItem}, ConverterParameter={Binding Source={x:Reference SelectiveList}, Path=ItemsSource}}"
SelectionBackground="{DynamicResource UBIKAccentColor}"
SelectionMode="Single"
Style="{DynamicResource UBIKListView}" />
</source>
</tab>
<tab name="UWP">
<source lang = "xml">
xmlns:controls="using:UBIK.WinX.Controls"

<controls:ComboBoxExt
x:Name="ComboBox"
Grid.ColumnSpan="2"
HorizontalAlignment="Stretch"
DisplayMemberPath="DisplayText"
ItemsSource="{Binding PropertyViewModel.SelectiveItems}"
PlaceholderText="{Binding PropertyEdit_PickerPlaceholder, Source={StaticResource AppResources}}"
SelectedValue="{Binding PropertyValue, Mode=TwoWay}"
SelectedValuePath="Value"
Visibility="{Binding PropertyViewModel.ShowComboBox, Converter={StaticResource BoolToVisConverter}}" />
</source>
</tab>

<tab name="Mobile (MAUI) before change">
<source lang = "xml">
xmlns:controls="clr-namespace:UBIK.MAUI.Controls"

<ContentView x:Name="YourContentView" ...>
<controls:SfListViewExt
x:Name="SelectiveList"
BindingContext="{TemplateBinding BindingContext}"
ItemSize="40"
ItemTemplate="{StaticResource PopupSelectiveListItemTemplate}"
ItemsSource="{Binding PropertyViewModel, Converter={StaticResource SelectiveListToItems}}"
SelectedItem="{Binding ValueItem.PropertyValue, Mode=OneWay, Converter={StaticResource PropertyValueToSelectiveItem}, ConverterParameter={Binding Source={x:Reference YourContentView}}}"
SelectionBackground="{DynamicResource UBIKAccentColor}"
SelectionMode="Single"
Style="{DynamicResource UBIKListView}" />
...
</ContentView>
</source>
</tab>
<tab name="UWP before change">
<source lang = "xml">
xmlns:controls="using:UBIK.WinX.Controls"

<controls:ComboBoxExt
x:Name="ComboBox"
Grid.ColumnSpan="2"
HorizontalAlignment="Stretch"
DisplayMemberPath="DisplayText"
ItemsSource="{Binding PropertyViewModel, Converter={StaticResource SelectiveListToItemsConverter}}"
PlaceholderText="{Binding PropertyEdit_PickerPlaceholder, Source={StaticResource AppResources}}"
SelectedValue="{Binding PropertyValue, Mode=TwoWay}"
SelectedValuePath="Value"
Visibility="{Binding PropertyViewModel.ShowComboBox, Converter={StaticResource BoolToVisConverter}}" />
</source>
</tab>
</tabs>

[[Category:Client|Active List Client]]
[[Category:Mobile|Active List Client]]
[[Category:Version 5.1|Active List Client]]
[[Category:WinX|Active List Client]]

== See also ==
* [[UBIK Active Lists|Active Lists Server]]
* [[MROCLS PICK LIST TASK|Pick List Task]]
* [[MRO_Objects_(Client)#Pick_List_Task|MRO Objects (Client) Pick List Task]]

{{UnderConstructionEnd}}

[[Category:Client|Active List Client]]
[[Category:Mobile|Active List Client]]
[[Category:Version 5.1|Active List Client]]
[[Category:WinX|Active List Client]]

Active List Client

2026-04-23T13:32:01Z

CWI: /* XAML */

{{UnderConstructionStart}}

==Introduction {{Version/WinXSince|5.1.0.0}} {{Version/MobileSince|5.1.0.0}}==
If an Active List is defined on a [[Instance|Content Object]] that is associated with an [[MetaProperty#Integer|integer]] [[MetaProperty]], the property is displayed like a usual [[UBIK WinX Client Basics#Selective List Properties|SelectiveList]] which is based on a [[MetaProperty]]. An ActiveList (i.e., if it has been configured on the server for a content object) always takes precedence over a MetaProperty SelectiveList. For editing, it behaves exactly the same as with a standard [[SELECTIVELIST|SelectiveList]].

{{Hint|There are no visible differences in the UI between an ActiveList and a MetaProperty SelectiveList.}}

'''Limitations'''
<br>
* [[Multi_Select_%28UBIK_Client%29#Editing_common_properties_of_selected_items_.28UWP_only.29|Mass editing]] is currently not supported for Properties containing Active Lists.
* Copy and Paste for Active Lists is not supported. When copying an object containing Active Lists, the copy of the object will not contain these Active Lists. In this case, the editing UI of the pasted object will appear like that of a standard Integer Property. If a value has already been selected, this value will be copied, though.

=== XAML ===
A new SelectiveItems property was added to the PropertyViewModel to enable access to an ActiveList via XAML. No DataTriggers or additional checks are required, as the correct list selection is handled automatically. As also mentioned [[UBIK_WinX_Client_Basics#Selective_List_Properties|here]], the following XAML changes are necessary:

'''Required adaptions of the ''ItemsSource'' binding:'''
If you have old customizings, the '''ItemsSource''' binding needs to be adapted. Instead of binding to the ''PropertyViewModel'' and using the ''SelectiveListToItemsConverter'', you should now directly bind to ''PropertyViewModel.SelectiveItems'' without the use of a SelectiveListToItemsConverter. In the case of previously binding to ''MetaProperty.SelectiveList.Items'' (or ''MetaProperty.SelectiveList'' plus using the ''SelectiveListToItemsConverter''), the binding should be changed to ''SelectiveItems'' only.
Depending on whether a SelectiveList or an ActiveList is configured, the proper list will be chosen automatically.

'''Optional refactoring of the ''SelectedItem ConverterParameter'' binding (Mobile only):'''
Instead of binding to the ContentView x:Name (e.g. ''ConverterParameter={Binding Source={x:Reference YourContentView}}''), it is now possible to bind to the x:Name of the SfListViewExt control and adding the ItemsSource as Path (e.g. ''ConverterParameter={Binding Source={x:Reference SelectiveList}, Path=ItemsSource}'').

<tabs>
<tab name="Mobile (MAUI)">
<source lang = "xml">
xmlns:controls="clr-namespace:UBIK.MAUI.Controls"

<controls:SfListViewExt
x:Name="SelectiveList"
BindingContext="{TemplateBinding BindingContext}"
ItemSize="40"
ItemTemplate="{StaticResource PopupSelectiveListItemTemplate}"
ItemsSource="{Binding SelectiveItems}"
SelectedItem="{Binding ValueItem.PropertyValue, Mode=OneWay, Converter={StaticResource PropertyValueToSelectiveItem}, ConverterParameter={Binding Source={x:Reference SelectiveList}, Path=ItemsSource}}"
SelectionBackground="{DynamicResource UBIKAccentColor}"
SelectionMode="Single"
Style="{DynamicResource UBIKListView}" />
</source>
</tab>
<tab name="UWP">
<source lang = "xml">
xmlns:controls="using:UBIK.WinX.Controls"

<controls:ComboBoxExt
x:Name="ComboBox"
Grid.ColumnSpan="2"
HorizontalAlignment="Stretch"
DisplayMemberPath="DisplayText"
ItemsSource="{Binding PropertyViewModel.SelectiveItems}"
PlaceholderText="{Binding PropertyEdit_PickerPlaceholder, Source={StaticResource AppResources}}"
SelectedValue="{Binding PropertyValue, Mode=TwoWay}"
SelectedValuePath="Value"
Visibility="{Binding PropertyViewModel.ShowComboBox, Converter={StaticResource BoolToVisConverter}}" />
</source>
</tab>

<tab name="Mobile (MAUI) before change">
<source lang = "xml">
xmlns:controls="clr-namespace:UBIK.MAUI.Controls"

<ContentView x:Name="YourContentView" ...>
<controls:SfListViewExt
x:Name="SelectiveList"
BindingContext="{TemplateBinding BindingContext}"
ItemSize="40"
ItemTemplate="{StaticResource PopupSelectiveListItemTemplate}"
ItemsSource="{Binding PropertyViewModel, Converter={StaticResource SelectiveListToItemsConverter}}"
SelectedItem="{Binding ValueItem.PropertyValue, Mode=OneWay, Converter={StaticResource PropertyValueToSelectiveItem}, ConverterParameter={Binding Source={x:Reference YourContentView}}}"
SelectionBackground="{DynamicResource UBIKAccentColor}"
SelectionMode="Single"
Style="{DynamicResource UBIKListView}" />
...
</ContentView>
</source>
</tab>
<tab name="UWP before change">
<source lang = "xml">
xmlns:controls="using:UBIK.WinX.Controls"

<controls:ComboBoxExt
x:Name="ComboBox"
Grid.ColumnSpan="2"
HorizontalAlignment="Stretch"
DisplayMemberPath="DisplayText"
ItemsSource="{Binding PropertyViewModel, Converter={StaticResource SelectiveListToItemsConverter}}"
PlaceholderText="{Binding PropertyEdit_PickerPlaceholder, Source={StaticResource AppResources}}"
SelectedValue="{Binding PropertyValue, Mode=TwoWay}"
SelectedValuePath="Value"
Visibility="{Binding PropertyViewModel.ShowComboBox, Converter={StaticResource BoolToVisConverter}}" />
</source>
</tab>
</tabs>

[[Category:Client|Active List Client]]
[[Category:Mobile|Active List Client]]
[[Category:Version 5.1|Active List Client]]
[[Category:WinX|Active List Client]]

== See also ==
* [[UBIK Active Lists|Active Lists Server]]
* [[MROCLS PICK LIST TASK|Pick List Task]]
* [[MRO_Objects_(Client)#Pick_List_Task|MRO Objects (Client) Pick List Task]]

{{UnderConstructionEnd}}

[[Category:Client|Active List Client]]
[[Category:Mobile|Active List Client]]
[[Category:Version 5.1|Active List Client]]
[[Category:WinX|Active List Client]]

UBIK WinX Client Basics

2026-04-23T12:22:17Z

CWI: /* Selective List Properties */

{{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 Mobile 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]].

== Languages ==
The standard {{UBIK}} client supports multiple languages listed below. {{Version/WinXSince|4.3}}
* Chinese (Simplified)
* Czech
* English
* German
* Polish
* Portuguese
* Spanish
{{Attention|As we found out, you can only switch to one of the supported languages if it is installed as a system language in the Windows "Preferred languages / Add a language" setting. For example, if you have only English installed when you install {{UBIK}}, you won't be able to switch to any other languages even if you add those later. In that case, you need to make sure your language of choice is installed in Windows first, then update or reinstall {{UBIK}}. This is a Microsoft Store practice and does not apply to clients installed through sideloading, e.g. from our AppCenter.}}

== 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 ===
==== Saving Indicator ====
[[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.

==== Uncommitted Changes Indicator ====
{{Version/WinXSince|4.6.0}} When there are uncommitted changes it is indicated by a button in the Status Bar displaying an icon and the number of uncommitted changes. Pressing this button opens a fly out list with all of the objects that have uncommitted changes to them. Pressing one of those list objects navigates directly to the corresponding object. The Uncommitted Changes Indicator button is only shown when there are uncommitted changes otherwise it is not visible. When in online mode all changes should be committed automatically so the Indicator is mainly useful in Manual or Offline Sync Mode.
<br>
{{Version/WinXSince|4.7.0}} Queries are now excluded from uncommitted changes.

=== 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. With the [[SYSCLS_CHILDINFOOWNER|child info owner classification]], one can additionally show the number of documents and regular grandchildren to be expected for a child object.

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.

=== Properties Page ===

On the properties page, one can see a list of all the current object's visible properties, and, given the respective rights, a possibility to edit them.

=== Context Menu ===

For any current object, there is a set of potential context-sensitive actions. These are displayed as buttons in the title bar, with a three-dot overflow menu button aggregating all the actions that wouldn't fit there anymore. There are many potential actions; some of them are only enabled for specifically classified objects, like objects with a geo location. Default actions are refresh, various download options, child object creation, copy/paste, commit/revert changes, geo-related actions, etc.

=== Objects ===

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

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

==== Task objects ====

[[https://wiki.augmensys.com/index.php?title=MRO_Objects_(Client)#Task|Tasks]] and [[https://wiki.augmensys.com/index.php?title=MRO_Objects_(Client)#Work_Package|work packages]] are special types of {{UBIK}} objects used for maintenance, repair and overhaul (MRO) use-cases.

==== Query objects ====

Queries are special types of {{UBIK}} objects with dynamic children. The child objects are looked up depending on the query object's criteria, which can be specified the same as property values for regular objects. There are [[QUERY|online queries]] evaluated by the server, and [[https://wiki.augmensys.com/index.php?title=Offline_Query_(UBIK_WinX)|offline queries]] evaluated on the client, thus requiring no internet connection.

==== Safety relevant objects ====

Object classified as [[SYSCLS_SAFETY_RELEVANT_OBJECT|safety relevant]] require the user to accept safety instructions to access the object, which can be required for hazardous MRO tasks, for example.

==== Commissioning objects ====

Similar to and based on MRO objects, commissioning objects are tasks and work packages for the commissioning use-case, e.g., [[SYSCLS_COMMISSIONINGCHECK|commissioning check tasks]].

==== Locked objects ====
In several use-cases, objects can be [[Locked_Objects|locked]] for editing.

=== Properties ===

==== Authentication Properties ====
[[SYSCLS_REQUIRE_AUTHENTICATION|Authentication Properties]] are properties which need a user authentication (through a password field) to be edited.

==== Min max properties ====
See [[Min_Max_Properties]].

==== Live value properties ====
[[Live_Values]] are specific property values extracted from a process control system like OPC-UA or OSIPI.

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

==== Selective List Properties ====
For some properties, the user should be able to select from a predefined set of values. Such a predefined set is called a "selective list" in {{UBIK}}.
Furthermore, there are [[Dynamic_Selective_List_(Client)|dynamic selective lists]] that can be filtered or assembled based on dependency property values.

{{UnderConstructionStart}}
{{Hint|{{Version/WinXSince|5.1.0.0}}{{Version/MobileSince|5.1.0.0}} The ItemsSource binding of related WinX/Mobile controls in Xaml now requires only '''PropertyViewModel.SelectiveItems''', which will return the items of an [[Active_List_Client|ActiveList]], or the items of a MetaProperty.SelectiveList, depending on the server-side configuration. In this case, the [[Converters_In_Mobile#List_of_Available_Converters|SelectiveListToItemsConverter]] is outdated and should not be used anymore.}}
{{UnderConstructionEnd}}

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

==== 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).

==== String properties with length restrictions ====
A string property can be configured with a [[MetaProperty#Text_2|length restriction]]. The client property editing UI doesn't allow users to confirm values exceeding the limit.

{{Clear}}

==== [[Editors]] ====

See [[Editors]]

=== Documents ===
UBIK supports and displays document objects and a bunch of actions related to them (editing, redlining, creation, thumbnails, ...).
See [[Documents_(Client)|Documents (Client)]]

==== Fit Mode{{Version/WinXSince|3.5}} ====
See [[Documents_(Client)#Fit_Mode|Fit Mode]]

==== Auto zoom {{Version/WinXSince|4.6}}{{Version/XamarinSince|4.6}} ====
See [[Documents_(Client)#Auto_zoom|Auto zoom]]

==== Editing{{Version/WinXSince|2.5.4}} ====
See [[Documents_(Client)#Editing|Editing]]

==== Offline availability ====
See [[Documents_(Client)#Offline/Online|Offline/Online]]

==== Clear Online Documents ====
[[Documents_(Client)#Offline/Online|Offline/Online]]

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

== 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>

== See also ==
* [[Client_Feature_Table]]
* [[SYSCLS_DOCUMENT_FITMODE]]
* [[SYSCLS_SHOWDOCUMENTS]]
* [[SYSCLS_SHOWPROPERTIES]]

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

Active List Client

2026-04-21T08:38:19Z

CWI: /* Introduction {{Version/WinXSince|5.1.0.0}} {{Version/MobileSince|5.1.0.0}} */

UBIK WinX Client Basics

2026-04-20T13:21:21Z

CWI: /* Selective List Properties */

{{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 Mobile 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]].

== Languages ==
The standard {{UBIK}} client supports multiple languages listed below. {{Version/WinXSince|4.3}}
* Chinese (Simplified)
* Czech
* English
* German
* Polish
* Portuguese
* Spanish
{{Attention|As we found out, you can only switch to one of the supported languages if it is installed as a system language in the Windows "Preferred languages / Add a language" setting. For example, if you have only English installed when you install {{UBIK}}, you won't be able to switch to any other languages even if you add those later. In that case, you need to make sure your language of choice is installed in Windows first, then update or reinstall {{UBIK}}. This is a Microsoft Store practice and does not apply to clients installed through sideloading, e.g. from our AppCenter.}}

== 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 ===
==== Saving Indicator ====
[[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.

==== Uncommitted Changes Indicator ====
{{Version/WinXSince|4.6.0}} When there are uncommitted changes it is indicated by a button in the Status Bar displaying an icon and the number of uncommitted changes. Pressing this button opens a fly out list with all of the objects that have uncommitted changes to them. Pressing one of those list objects navigates directly to the corresponding object. The Uncommitted Changes Indicator button is only shown when there are uncommitted changes otherwise it is not visible. When in online mode all changes should be committed automatically so the Indicator is mainly useful in Manual or Offline Sync Mode.
<br>
{{Version/WinXSince|4.7.0}} Queries are now excluded from uncommitted changes.

=== 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. With the [[SYSCLS_CHILDINFOOWNER|child info owner classification]], one can additionally show the number of documents and regular grandchildren to be expected for a child object.

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.

=== Properties Page ===

On the properties page, one can see a list of all the current object's visible properties, and, given the respective rights, a possibility to edit them.

=== Context Menu ===

For any current object, there is a set of potential context-sensitive actions. These are displayed as buttons in the title bar, with a three-dot overflow menu button aggregating all the actions that wouldn't fit there anymore. There are many potential actions; some of them are only enabled for specifically classified objects, like objects with a geo location. Default actions are refresh, various download options, child object creation, copy/paste, commit/revert changes, geo-related actions, etc.

=== Objects ===

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

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

==== Task objects ====

[[https://wiki.augmensys.com/index.php?title=MRO_Objects_(Client)#Task|Tasks]] and [[https://wiki.augmensys.com/index.php?title=MRO_Objects_(Client)#Work_Package|work packages]] are special types of {{UBIK}} objects used for maintenance, repair and overhaul (MRO) use-cases.

==== Query objects ====

Queries are special types of {{UBIK}} objects with dynamic children. The child objects are looked up depending on the query object's criteria, which can be specified the same as property values for regular objects. There are [[QUERY|online queries]] evaluated by the server, and [[https://wiki.augmensys.com/index.php?title=Offline_Query_(UBIK_WinX)|offline queries]] evaluated on the client, thus requiring no internet connection.

==== Safety relevant objects ====

Object classified as [[SYSCLS_SAFETY_RELEVANT_OBJECT|safety relevant]] require the user to accept safety instructions to access the object, which can be required for hazardous MRO tasks, for example.

==== Commissioning objects ====

Similar to and based on MRO objects, commissioning objects are tasks and work packages for the commissioning use-case, e.g., [[SYSCLS_COMMISSIONINGCHECK|commissioning check tasks]].

==== Locked objects ====
In several use-cases, objects can be [[Locked_Objects|locked]] for editing.

=== Properties ===

==== Authentication Properties ====
[[SYSCLS_REQUIRE_AUTHENTICATION|Authentication Properties]] are properties which need a user authentication (through a password field) to be edited.

==== Min max properties ====
See [[Min_Max_Properties]].

==== Live value properties ====
[[Live_Values]] are specific property values extracted from a process control system like OPC-UA or OSIPI.

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

==== Selective List Properties ====
For some properties, the user should be able to select from a predefined set of values. Such a predefined set is called a "selective list" in {{UBIK}}.
Furthermore, there are [[Dynamic_Selective_List_(Client)|dynamic selective lists]] that can be filtered or assembled based on dependency property values.

{{UnderConstructionStart}}
{{Hint|{{Version/WinXSince|5.1.0.0}}{{Version/MobileSince|5.1.0.0}} The ItemsSource binding of related WinX/Mobile controls in Xaml now requires only '''PropertyViewModel.SelectiveItems''', which will return the items of an [[Active_List_Client|ActiveList]], or the items of a MetaProperty.SelectiveList, depending on the server-side configuration. Mobile only: In this case, the [[Converters_In_Mobile#List_of_Available_Converters|SelectiveListToItemsConverter]] is outdated and should not be used anymore.}}
{{UnderConstructionEnd}}

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

==== 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).

==== String properties with length restrictions ====
A string property can be configured with a [[MetaProperty#Text_2|length restriction]]. The client property editing UI doesn't allow users to confirm values exceeding the limit.

{{Clear}}

==== [[Editors]] ====

See [[Editors]]

=== Documents ===
UBIK supports and displays document objects and a bunch of actions related to them (editing, redlining, creation, thumbnails, ...).
See [[Documents_(Client)|Documents (Client)]]

==== Fit Mode{{Version/WinXSince|3.5}} ====
See [[Documents_(Client)#Fit_Mode|Fit Mode]]

==== Auto zoom {{Version/WinXSince|4.6}}{{Version/XamarinSince|4.6}} ====
See [[Documents_(Client)#Auto_zoom|Auto zoom]]

==== Editing{{Version/WinXSince|2.5.4}} ====
See [[Documents_(Client)#Editing|Editing]]

==== Offline availability ====
See [[Documents_(Client)#Offline/Online|Offline/Online]]

==== Clear Online Documents ====
[[Documents_(Client)#Offline/Online|Offline/Online]]

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

== 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>

== See also ==
* [[Client_Feature_Table]]
* [[SYSCLS_DOCUMENT_FITMODE]]
* [[SYSCLS_SHOWDOCUMENTS]]
* [[SYSCLS_SHOWPROPERTIES]]

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

Converters In Mobile

2026-04-20T13:19:26Z

CWI: /* List of Available Converters */

'''Converters''' are used to prepare application data to format a UI defined by a XAML markup. These converters make it possible to show elements only when specific conditions (like data being available) are met. This allows the creation of a good UI with XAML code only, improving code readability while also decreasing code complexity.

This page explains how to properly use converters for customizing the UBIK Mobile User Interface. Furthermore, all available converters are listed to provide a good reference.

= Definition =
In Mobile clients, before converters can be used, they need to be defined in the page's ''Resources'' tag. Make sure to include the <code>UBIK.CPL.Converters</code> namespace in the namespace definitions!
The following example shows how the <code>NullToBoolConverter</code> can be defined:
<syntaxhighlight lang="xml">
Mobile(Xamarin):

<ContentView x:Class="UBIK.CPL.Resources.UBIKChildArea"
xmlns="http://xamarin.com/schemas/2014/forms"
xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
xmlns:converters="clr-namespace:UBIK.CPL.Converters;assembly=UBIK.CPL">
<ContentView.Resources>
<ResourceDictionary>
<converters:NullToBoolConverter x:Key="NullToBool" />
</ResourceDictionary>
</ContentView.Resources>



</ContentView>
</syntaxhighlight>
The key ''NullToBool'' makes this converter accessible from the customizing in this page.
== Definition With Properties ==
In the following example, which is the same example from above, the '''StringFormatConverter''' will be additionally defined. To add more formatting possibilities, it has two extra properties, which need to be prefilled during initialization. Henceforth, these properties can be prefilled with static values or with static references.
<syntaxhighlight lang="xml">
Mobile(Xamarin):

<ContentView x:Class="UBIK.CPL.Resources.UBIKChildArea"
xmlns="http://xamarin.com/schemas/2014/forms"
xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
xmlns:converters="clr-namespace:UBIK.CPL.Converters;assembly=UBIK.CPL">
<ContentView.Resources>
<ResourceDictionary>
<converters:NullToBoolConverter x:Key="NullToBool" />
<converters:StringFormatConverter x:Key="Formatter" Parameter1="5" Parameter2="{Binding Children.Items.Count}" />
</ResourceDictionary>
</ContentView.Resources>



</ContentView>
</syntaxhighlight>
Whereever this converter is used within the file it was defined in, ''Formatter'' will always have its ''Parameter1'' set to ''5'' and its ''Parameter2'' to the number of children of the currently viewed UBIK object. If this behavior is not intended, consider defining another ''StringFormatConverter'' with a '''different Key''' in the same way as shown above.<br/>
See below to find out how to use this converter!
= Usage =
A converter can only be used in conjunction with a <code>{Binding}</code>. The following is an easy example, showing how the ''NullToBool'' converter, defined above, can be used.
<syntaxhighlight lang="xml">
<Label Text="My Text" IsVisible="{Binding MyBindableProperty, Converter={StaticResource NullToBool}}"/>
</syntaxhighlight>
If '''MyBindableProperty''' is ''null'' or an empty string, the converter will return '''true''', making the Label visible!
== Parameter ==
Some converters accept a '''ConverterParameter''', that passes additional information. Closely read the description of the available converters to find out which accept or even require a parameter to work properly. In Ubik, some converters accept a string parameter, consisting of multiple individual parameters separated by <code>|</code>.

An example of this behavior is the '''ContainsToBoolConverter''', which checks if the current value is contained within a collection of values (passed as the ''parameter''):
<syntaxhighlight lang="xml">
<Label Text="My Text" IsVisible="{Binding MyValue, Converter={StaticResource ContainsToBool}, ConverterParameter=1|2|3|4|5|6|7|8|9}"/>
</syntaxhighlight>
The label will only be visible if the ''MyValue'' property (which is expected to parse as an Integer in this example) is one of the values of the parameter.<br/>
Again, to get the converter working, don't forget to define it in the page's resources!

== FallbackValue ==
In some rare cases, a converter might not return anything desired (like ''null'') if some condition doesn't work out as it should (e.g. ''value'' is ''null''). To still be able to get a usable return value, it's possible to define a '''FallbackValue'''.

== Example Usage of StringFormatConverter ==
This converter can take up to two additional parameters during definition. Please see [[#Definition With Properties|Definition With Properties]] for more information!
<syntaxhighlight lang="xml">
<Label Text="{Binding MyValue, Converter={StaticResource Formatter}, ConverterParameter=The Value of my value is \{0\}\, compared to \{1\} and \{2\}!}"/>
</syntaxhighlight>
It's important to note that special characters, like <code><nowiki>{</nowiki></code>, <code><nowiki>}</nowiki></code> and <code><nowiki>,</nowiki></code>, need to be escaped using a <code><nowiki>\</nowiki></code>, else the expression will be wrongly interpreted (and nothing happens)!

The text of the '''ConverterParameter''' will be analyzed, and any occurrance (including duplicates) of <code><nowiki>{0}</nowiki></code>, <code><nowiki>{1}</nowiki></code> and <code><nowiki>{2}</nowiki></code> replaced with the '''binding value''', '''Formatter.Parameter1''' and '''Formatter.Parameter2''' respectively!

Make sure to note, that Maui has a native '''[https://learn.microsoft.com/en-us/dotnet/maui/fundamentals/data-binding/string-formatting?view=net-maui-9.0 string formatting]''' option as well, that is probably way faster than using a converter for it. Furthermore, it supports formatting options!

= Data Source =
Although technically not a converter, the '''SfDataSourceExt''' control is currently on the way of replacing the '''SfDataSourceConverter''', due to improved performance.
The usage is pretty simple: Similar to the converters, it needs to be defined in the '''Page Resources'''. Then, a '''Key''' and '''Expression''', as well as an '''ItemsSource''' have to be defined. Last, but not least, the the converter can be used within the '''ItemsSource''' property of a Syncfusion '''SfListView'''. See the following example:
<syntaxhighlight lang="xml">
Mobile(Xamarin):

<ContentView x:Class="UBIK.CPL.Resources.UBIKChildArea"
xmlns="http://xamarin.com/schemas/2014/forms"
xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
xmlns:controls="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL">
<ContentView.Resources>
<ResourceDictionary>
<controls:SfDataSourceExt
x:Key="MyDataSource"
ItemsSource="{Binding Children.Items}"
Expression="Item.Content.MetaUID.ToString().ToLower()=="85a50533-3817-4a0b-84cd-615b48b62565" && Item["ORGA_STATUS"]!=100" />
</ResourceDictionary>
</ContentView.Resources>
<sync:SfListView
x:Name="ListView1"
AllowSwiping="True"
ItemSize="60"
ItemTemplate="{StaticResource ChildTemplateSelector}"
ItemsSource="{Binding DisplayItems, Source={StaticResource MyDataSource}}"
LeftSwipeTemplate="{StaticResource SwipeLeftTemplateSelector}"
RightSwipeTemplate="{StaticResource SwipeRightTemplateSelector}"
SelectionMode="None">
</ContentView>
</syntaxhighlight>
Thanks to the given expression, filtering is applied once the data source is evaluated. It's important to have [https://www.advancedinstaller.com/user-guide/xml-escaped-chars.html XML special characters] correctly escaped, like the example shows.

= List of Available Converters =
The following list contains all currently available converters for UBIK Mobile customizing.

'''Two-way''' converters can be used with two-way bindings, e.g. a text-box displaying an editable value. If the value updates in the model, the text-box text changes. If the user edits the value, the value in the model behind also gets updated.
As a clarification, '''Value''' refers to the '''Binding Value''', and '''parameter''' to the '''ConverterParameter'''!

{{UnderConstructionStart}}

{| class="wikitable sortable" style="width:100%"
|-
! Converter !! 2-Way !! Output Type || Input Type || Parameter Type || Description
|-
| BooleanConverter || style="text-align: center;" | ✓ || Boolean || Boolean, String || ||
Interprets a '''boolean value''' or a '''String value''' and returns it. If the value cannot be interpreted, ''false'' is returned.
|-
| BooleanInvertConverter || style="text-align: center;" | ✓ || Boolean || Boolean, String || ||
Interprets a '''boolean value''' or a '''String value''' and converts it into its '''inverted value'''. If the value cannot be interpreted, ''false'' is returned.
|-
| BooleanToFontAttributeConverter || style="text-align: center;" | ✗ || FontAttribute || Boolean || ||
Converts a '''boolean''' into a '''[https://docs.microsoft.com/en-us/dotnet/api/xamarin.forms.fontattributes?view=xamarin-forms font attribute]''' value. In detail, if the value is ''true'', the parameter is interpreted (''Bold'', ''Italic'', ''None'') and returned. The default returned font-attribute is ''None''.
|-
| ByteToImageSourceValueConverter || style="text-align: center;" | ✗ || ImageSource || Byte[ ],<br/>Byte Stream || ||
Converts a '''byte stream''' value into an '''image source'''.
|-
| ChildAreaTemplateConverter || style="text-align: center;" | ✗ || Child<wbr/>Area<wbr/>Template || Content<wbr/>ViewModel || ||
Returns a '''ChildAreaTemplate''' from a '''Content<wbr/>ViewModel''' or ''null'' if the ViewModel cannot be interpreted.
|-
| ChildItem<wbr/>SelectionMode<wbr/>To<wbr/>SfListView<wbr/>SelectionMode<wbr/>Converter || style="text-align: center;" | ✓ || [https://help.syncfusion.com/cr/cref_files/xamarin/Syncfusion.SfListView.XForms~Syncfusion.ListView.XForms.SfListView~SelectionMode.html ListView<wbr/>SelectionMode] || ChildItem<wbr/>SelectionMode || ||
Converts a '''ChildItem<wbr/>SelectionMode''' to a Syncfusion '''[https://help.syncfusion.com/cr/cref_files/xamarin/Syncfusion.SfListView.XForms~Syncfusion.ListView.XForms.SfListView~SelectionMode.html ListView<wbr/>SelectionMode]'''. Default is "Single".
|-
| ClassificationToBoolConverter || style="text-align: center;" | ✗ || Boolean || ContentViewModel || ||
Returns a '''boolean''' indicating whether the given '''ContentViewModel''' is successfully classified.
|-
| ContainsToBoolConverter || style="text-align: center;" | ✗ || Boolean || String,<br/>Guid,<br/>Object || ||
Checks if the delivered value is '''contained''' within a collection of values (delivered in the parameter, seperated with <code><nowiki>|</nowiki></code>). If the value is contained, ''true'' will be returned, else ''false''. The functionality is similar to the ''ContainsToVisibilityConverter'' in the WinX project.
|-
| ContainsToInvertedBoolConverter || style="text-align: center;" | ✗ || Boolean || String,<br/>Guid,<br/>Object || ||
Same as the ''ContainsToBoolConverter'', but with '''inverted output'''.
|-
| ContentAreaTeamplateConverter || style="text-align: center;" | ✗ || UBIKContentArea || ContentViewModel || || This converter is '''not yet finished''' and just returns the ''UBIKContentArea'' if the value is a ''ContentViewModel''.
|-
| StringToDateTimeTypesConverter || style="text-align: center;" | ✓ || [https://docs.microsoft.com/en-us/dotnet/api/system.datetime DateTime], [https://docs.microsoft.com/en-us/dotnet/api/system.timespan TimeSpan] || String || ||
Converts a String to the correct DateType, which can be either '''[https://docs.microsoft.com/en-us/dotnet/api/system.datetime DateTime]''' or '''[https://docs.microsoft.com/en-us/dotnet/api/system.timespan TimeSpan]'''. If the value cannot be interpreted, the unchanged String value is returned. The Converter can also be used to convert DateTime or TimeSpan into a string. The Format will be determined by the current culture.
|-
| DateTimeOffsetToDateConverter || style="text-align: center;" | ✓ || [https://docs.microsoft.com/en-us/dotnet/api/system.datetime DateTime] || [https://docs.microsoft.com/en-us/dotnet/api/system.datetimeoffset DateTimeOffset] || ||
Converts a '''[https://docs.microsoft.com/en-us/dotnet/api/system.datetimeoffset DateTimeOffset]''' to the correct '''[https://docs.microsoft.com/en-us/dotnet/api/system.datetime DateTime]''', applied to the current date and time. If the value cannot be interpreted, a new ''DateTime'', generated from the device's current time (<code>DateTime.Now</code>) is returned.
|-
| DateTimeToFromNowStringConverter || style="text-align: center;" | ✗ || String || [https://docs.microsoft.com/en-us/dotnet/api/system.datetime DateTime] || ||
Returns a '''[https://docs.microsoft.com/en-us/dotnet/api/system.datetime DateTime]''' into a human-readable and easily understandable ''string message'' (the last applying one will be taken):
* Less than 5 minutes in the past: ''Just now''
* Less than 10 minutes in the past: ''A few minutes ago''
* Less than 1 hour in the past: ''An hour ago''
* Less than 23 Hours in the past: ''Some hours ago''
* Less than 1 day in the past: ''Yesterday''
* More than 1 day in the past: The ''DateTime'' value formatted according to the device's localization rules.
* Not interpretable: ''???''
|-
| DebugConverter || style="text-align: center;" | ✓ || Object || Object || ||
A converter returning the given value for '''debug reasons'''.
|-
| DistanceToStringConverter || style="text-align: center;" | ✗ || String || Double || ||
Returns the given value interpreted as '''length'''. Values are returned in kilometers with two comma digits (e.g. 2.84km), values smaller than 1km are returned as meters and ''NaN'' will be returned as ''infinity''. If the value cannot be interpreted, an empty string will be returned.
|-
| EqualityToBoolConverter || style="text-align: center;" | ✗ || Boolean || Object,<br/>String || Object,<br/>String ||
Returns ''true'' if the given value and parameter are '''equal to each other''', ''false'' otherwise.
|-
| EqualityToInvertedBoolConverter || style="text-align: center;" | ✗ || Boolean || Object,<br/>String || Object,<br/>String ||
Returns ''true'' if the given value and parameter are '''not equal to each other''', ''false'' otherwise.
|-
| SelectionChangedEventArgsConverter || style="text-align: center;" | ✗ || [https://docs.microsoft.com/en-us/dotnet/api/system.windows.controls.selectionchangedeventargs List<wbr/>Selection<wbr/>Changed<wbr/>EventArgs] || [https://help.syncfusion.com/cr/cref_files/xamarin/Syncfusion.SfListView.XForms~Syncfusion.ListView.XForms.ItemSelectionChangedEventArgs.html Item<wbr/>Selection<wbr/>Changed<wbr/>EventArgs] || ||
Converts an Syncfusion '''[https://help.syncfusion.com/cr/cref_files/xamarin/Syncfusion.SfListView.XForms~Syncfusion.ListView.XForms.ItemSelectionChangedEventArgs.html Item<wbr/>Selection<wbr/>Changed<wbr/>EventArgs]''' to a '''[https://docs.microsoft.com/en-us/dotnet/api/system.windows.controls.selectionchangedeventargs List<wbr/>Selection<wbr/>Changed<wbr/>EventArgs]'''. <br/>The use-case of this converter is highly specific.
|-
| FilterCriterionToValueConverter || style="text-align: center;" | ✓ || String || FilterCriterion || ||
Converts a [[Property_Based_Content_Filters|'''FilterCriterion''']] to its value. The functionality is similar to UWP's FilterCriterionToValueConverter.
|-
| GuidPropertyValueConverter || style="text-align: center;" | ✓ || String || Guid || Binding, where source is ContentViewModel ||
Returns the '''first item''' of the parameter's ''Source-ViewModel'' that '''matches the given GUID''' value. If none is found, ''null'' is returned.
|-
| IntToColorConverter || style="text-align: center;" | ✗ || Color || Integer || ||
Converts an ARGB '''integer''' value to a '''color'''. If the value cannot be interpreted, the converter tries to parse the parameter as a ''color'' to return it. If everything fails, ''transparent'' is returned.
|-
| ItemCountToBoolConverter || style="text-align: center;" | ✗ || Boolean || Integer || Integer ||
This converter has a '''property''' to set the '''boolean return value''', called ''LesserOrEqualReturnValue''. This property-value will be returned if the given value is '''smaller than or equal to''' the threshold (parameter, defaults to 0). If the value is '''bigger than''' the threshold, the '''inverted''' ''LesserOrEqualReturnValue'' will be returned.<br/>
In any other case (like the value cannot be interpreted), ''false'' is returned, so it's a good idea to set the converter's property in a way that the return is only ''true'' if you need it.
|-
| ItemCountToOverflowConverter || style="text-align: center;" | ✗ || String || Integer || Integer || Creates a '''human-readable text''' indicating '''how many items are available'''. The value will be interpreted as the '''total item count''' and the parameter as '''overflow threshold''' (defaults to 99). <br/>If there are more items than the overflow, the overflow value with a + sign will be returned (e.g. 99+). If not, the value itself will be returned. If everything fails, ''null'' is returned.
|-
| NullToBoolConverter || style="text-align: center;" | ✓ || Boolean || Object,<br/>String|| ||
''Null'' or an '''empty string''' value get converted to ''true'', and everything else to ''false''.
|-
| NullToInvertedBoolConverter || style="text-align: center;" | ✓ || Boolean || Object,<br/>String || ||
''Null'' or an '''empty string''' value get converted to ''false'', and everything else to ''true''.
|-
| PathToImageSourceValueConverter || style="text-align: center;" | ✗ || Image Source || String || ||
Reads the '''path''' provided as parameter and creates an '''image source''' from it.
|-
| PercentageToProgressConverter || style="text-align: center;" | ✗ || Double || Integer,<br/>Double || ||
The '''numeric value''' (int or double), interpreted as '''percentage from 0 to 100''', get converted to a '''progress level''' (0 to 1). Values outside this range will be contained.
|-
| PropertyNameExistsToBoolConverter || style="text-align: center;" | ✗ || Boolean (Nullable) || ContentViewModel,<br/>IContent || ||
Converts a property to a '''boolean''' based on its '''existence'''. If it exists, ''true'' will be returned, else ''false'' or ''null'' (if something couldn't be properly interpreted).
|-
| PropertyNameExistsToInvertedBoolConverter || style="text-align: center;" | ✗ || Boolean (Nullable) || ContentViewModel,<br/>IContent || ||
Converts a property to a '''boolean''' based on its '''existence'''. If it exists, ''false'' will be returned, else ''true'' or ''null'' (if something couldn't be properly interpreted).
|-

| PropertyValueToSelectiveItemConverter || style="text-align: center;" | ✓ || Boolean,<br/>String,<br/>Integer,<br/>Double,<br/>DateTime,<br/>Guid,<br/>FileReferenceData,<br/>GeoData,<br/>Object || Boolean,<br/>String,<br/>Integer,<br/>Double,<br/>DateTime,<br/>Guid,<br/>FileReferenceData,<br/>GeoData,<br/>Object || ||
Converts a '''item''' of an [[Active List Client]] or a [[MetaProperty]] [[MetaProperty#Selective List|Selective List]] to its value. If none is found, null will be returned.
|-

| RootAreaTemplateConverter || style="text-align: center;" | ✗ || ContentView || Object || ||
If the provided value is '''not null''', the '''UBIKRootArea template''' will be returned.
|-
| SelectiveItemToValueConverter || style="text-align: center;" | ✓ || Boolean,<br/>String,<br/>Integer,<br/>Double,<br/>DateTime,<br/>Guid,<br/>FileReferenceData,<br/>GeoData,<br/>Object || Boolean,<br/>String,<br/>Integer,<br/>Double,<br/>DateTime,<br/>Guid,<br/>FileReferenceData,<br/>GeoData,<br/>Object || Binding, where source is ContentViewModel ||
Converts a '''item''' of a '''selective list''' to its value. If none is found, the passed ''value'' will be returned.
|-
| SelectiveListToItemsConverter || style="text-align: center;" | ✗ || List of PropertyItems || IPropertyItem || ||
Returns all items from a selective list. The converter can only be used in combination with a standard MetaProperty level [[SELECTIVELIST|SelectiveList]], not with an instance level [[Active_List_Client|Active list]]. Further infos see in [[UBIK_WinX_Client_Basics#Selective_List_Properties|Selective List Properties]].
|-
| SfDataSourceConverter || style="text-align: center;" | ✗ || DataSource (for ListView) || Double || String (Expression) ||
It's an advanced converter used for '''loading items''' and '''applying filters''' on it. It replaces to ''CollectionToViewConverter'' from the WinX.UWP project. The data source can be directly used with a ''[https://help.syncfusion.com/xamarin/sflistview/overview SfListView]''.<br/><br/>
'''This converter is obsolete!'''<br/>Use '''SfDataSourceExt''' (see [[#Data Source|Data Source]]) instead!
|-
| StringContainsToBoolConverter || style="text-align: center;" | ✗ || Boolean || String || String ||
Returns a '''boolean''' indicating whether the parameter string is included in the value string.
|-
| StringContainsToInvertedBoolConverter || style="text-align: center;" | ✗ || Boolean || String || String ||
Same as the ''StringContainsToBoolConverter'' but with '''inverted output'''.
|-
| StringFormatConverter || style="text-align: center;" | ✗ || String || Object || String || Allows the creation of a '''nicely formatted ''string'' message''', similar to [https://docs.microsoft.com/en-us/dotnet/api/system.string.format C#'s String.Format method].<br/>The value will be interpreted as the <code><nowiki>{0}</nowiki></code> element, and the parameter is the template string (e.g. <code><nowiki>The total count is: {0}!</nowiki></code>. Up to two additional parameters, named ''Parameter1'' and ''Parameter2'', can be defined at the converter declaration. Adding formatting options to the <code><nowiki>{0}</nowiki></code> notation is not possible.<br/><br/>
'''Attention''', using the native '''[https://docs.microsoft.com/en-us/xamarin/xamarin-forms/app-fundamentals/data-binding/string-formatting StringFormat]''' option is not only faster, but it also offers more customizability of the value!<br/>
You might still want to use the ''StringFormatConverter'' in rare cases, though!
|-
| ToStringFormatConverter || style="text-align: center;" | ✗ || String || Double,<br/>Float,<br/>Integer,<br/>DateTime,<br/>String || String || Converts '''primitives''' or '''[https://docs.microsoft.com/en-us/dotnet/api/system.datetime DateTime]''' to string and allows the application of '''[https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings formatting options]''' (as parameter). <br/>Adding a <code>.</code> to the end of the format-parameter allows '''[https://docs.microsoft.com/en-us/dotnet/api/system.math.truncate truncation]''' of all decimal places.
|-
| TypeNameToBoolConverter || style="text-align: center;" | ✗ || Boolean || Object || String || Returns ''true'' if the type name of the value is present in the parameter-string (seperated by <code><nowiki>|</nowiki></code>).
|-
| TypeNameToInvertedBoolConverter || style="text-align: center;" | ✗ || Boolean || Object || String || Inverted ''TypeNameTo<wbr/>BoolConverter''.
|-
| DataTemplateItemTemplateSelectorConverter || style="text-align: center;" | ✗ || ChildItem<wbr/>Template<wbr/>Selector || String || String || Chooses what '''ChildItem<wbr/>Template<wbr/>Selector''' to return. Having a parameter with the content "Small" returns the small item template selector.
|-
| DataTemplateItemsPanelConverter || style="text-align: center;" | ✗ || ItemsPanelTemplate || Query<wbr/>Details<wbr/>Page<wbr/>ViewModel || || Chooses what '''ItemPanel<wbr/>Template''' to return. Having a parameter with the content "Small" returns the small item template selector.
|}

{{UnderConstructionEnd}}

[[Category:Client|Converters In Xamarin]]
[[Category:Mobile|Converters In Xamarin]]
[[Category:XAML|Converters In Xamarin]]

= See also =
[[XAML#Converters|Converters in UWP/WinX]]

[[Category:Client | XAML | Xamarin]]

[[Category:Client|Converters In Xamarin]]
[[Category:Mobile|Converters In Xamarin]]
[[Category:XAML|Converters In Xamarin]]

UBIK WinX Client Basics

2026-04-20T13:16:57Z

CWI: /* Selective List Properties */

{{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 Mobile 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]].

== Languages ==
The standard {{UBIK}} client supports multiple languages listed below. {{Version/WinXSince|4.3}}
* Chinese (Simplified)
* Czech
* English
* German
* Polish
* Portuguese
* Spanish
{{Attention|As we found out, you can only switch to one of the supported languages if it is installed as a system language in the Windows "Preferred languages / Add a language" setting. For example, if you have only English installed when you install {{UBIK}}, you won't be able to switch to any other languages even if you add those later. In that case, you need to make sure your language of choice is installed in Windows first, then update or reinstall {{UBIK}}. This is a Microsoft Store practice and does not apply to clients installed through sideloading, e.g. from our AppCenter.}}

== 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 ===
==== Saving Indicator ====
[[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.

==== Uncommitted Changes Indicator ====
{{Version/WinXSince|4.6.0}} When there are uncommitted changes it is indicated by a button in the Status Bar displaying an icon and the number of uncommitted changes. Pressing this button opens a fly out list with all of the objects that have uncommitted changes to them. Pressing one of those list objects navigates directly to the corresponding object. The Uncommitted Changes Indicator button is only shown when there are uncommitted changes otherwise it is not visible. When in online mode all changes should be committed automatically so the Indicator is mainly useful in Manual or Offline Sync Mode.
<br>
{{Version/WinXSince|4.7.0}} Queries are now excluded from uncommitted changes.

=== 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. With the [[SYSCLS_CHILDINFOOWNER|child info owner classification]], one can additionally show the number of documents and regular grandchildren to be expected for a child object.

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.

=== Properties Page ===

On the properties page, one can see a list of all the current object's visible properties, and, given the respective rights, a possibility to edit them.

=== Context Menu ===

For any current object, there is a set of potential context-sensitive actions. These are displayed as buttons in the title bar, with a three-dot overflow menu button aggregating all the actions that wouldn't fit there anymore. There are many potential actions; some of them are only enabled for specifically classified objects, like objects with a geo location. Default actions are refresh, various download options, child object creation, copy/paste, commit/revert changes, geo-related actions, etc.

=== Objects ===

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

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

==== Task objects ====

[[https://wiki.augmensys.com/index.php?title=MRO_Objects_(Client)#Task|Tasks]] and [[https://wiki.augmensys.com/index.php?title=MRO_Objects_(Client)#Work_Package|work packages]] are special types of {{UBIK}} objects used for maintenance, repair and overhaul (MRO) use-cases.

==== Query objects ====

Queries are special types of {{UBIK}} objects with dynamic children. The child objects are looked up depending on the query object's criteria, which can be specified the same as property values for regular objects. There are [[QUERY|online queries]] evaluated by the server, and [[https://wiki.augmensys.com/index.php?title=Offline_Query_(UBIK_WinX)|offline queries]] evaluated on the client, thus requiring no internet connection.

==== Safety relevant objects ====

Object classified as [[SYSCLS_SAFETY_RELEVANT_OBJECT|safety relevant]] require the user to accept safety instructions to access the object, which can be required for hazardous MRO tasks, for example.

==== Commissioning objects ====

Similar to and based on MRO objects, commissioning objects are tasks and work packages for the commissioning use-case, e.g., [[SYSCLS_COMMISSIONINGCHECK|commissioning check tasks]].

==== Locked objects ====
In several use-cases, objects can be [[Locked_Objects|locked]] for editing.

=== Properties ===

==== Authentication Properties ====
[[SYSCLS_REQUIRE_AUTHENTICATION|Authentication Properties]] are properties which need a user authentication (through a password field) to be edited.

==== Min max properties ====
See [[Min_Max_Properties]].

==== Live value properties ====
[[Live_Values]] are specific property values extracted from a process control system like OPC-UA or OSIPI.

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

==== Selective List Properties ====
For some properties, the user should be able to select from a predefined set of values. Such a predefined set is called a "selective list" in {{UBIK}}.
Furthermore, there are [[Dynamic_Selective_List_(Client)|dynamic selective lists]] that can be filtered or assembled based on dependency property values.

{{UnderConstructionStart}}
{{Hint|{{Version/WinXSince|5.1.0.0}}{{Version/MobileSince|5.1.0.0}} The ItemsSource binding of related WinX/Mobile controls in Xaml now requires only '''PropertyViewModel.SelectiveItems''', which will return the items of an [[Active_List_Client|ActiveList]], or the items of a MetaProperty.SelectiveList, depending on the server-side configuration. In this case, the SelectiveListToItemsConverter is outdated and should not be used anymore.}}
{{UnderConstructionEnd}}

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

==== 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).

==== String properties with length restrictions ====
A string property can be configured with a [[MetaProperty#Text_2|length restriction]]. The client property editing UI doesn't allow users to confirm values exceeding the limit.

{{Clear}}

==== [[Editors]] ====

See [[Editors]]

=== Documents ===
UBIK supports and displays document objects and a bunch of actions related to them (editing, redlining, creation, thumbnails, ...).
See [[Documents_(Client)|Documents (Client)]]

==== Fit Mode{{Version/WinXSince|3.5}} ====
See [[Documents_(Client)#Fit_Mode|Fit Mode]]

==== Auto zoom {{Version/WinXSince|4.6}}{{Version/XamarinSince|4.6}} ====
See [[Documents_(Client)#Auto_zoom|Auto zoom]]

==== Editing{{Version/WinXSince|2.5.4}} ====
See [[Documents_(Client)#Editing|Editing]]

==== Offline availability ====
See [[Documents_(Client)#Offline/Online|Offline/Online]]

==== Clear Online Documents ====
[[Documents_(Client)#Offline/Online|Offline/Online]]

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

== 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>

== See also ==
* [[Client_Feature_Table]]
* [[SYSCLS_DOCUMENT_FITMODE]]
* [[SYSCLS_SHOWDOCUMENTS]]
* [[SYSCLS_SHOWPROPERTIES]]

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

UBIK WinX Client Basics

2026-04-20T13:09:46Z

CWI: /* Selective List Properties */

{{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 Mobile 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]].

== Languages ==
The standard {{UBIK}} client supports multiple languages listed below. {{Version/WinXSince|4.3}}
* Chinese (Simplified)
* Czech
* English
* German
* Polish
* Portuguese
* Spanish
{{Attention|As we found out, you can only switch to one of the supported languages if it is installed as a system language in the Windows "Preferred languages / Add a language" setting. For example, if you have only English installed when you install {{UBIK}}, you won't be able to switch to any other languages even if you add those later. In that case, you need to make sure your language of choice is installed in Windows first, then update or reinstall {{UBIK}}. This is a Microsoft Store practice and does not apply to clients installed through sideloading, e.g. from our AppCenter.}}

== 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 ===
==== Saving Indicator ====
[[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.

==== Uncommitted Changes Indicator ====
{{Version/WinXSince|4.6.0}} When there are uncommitted changes it is indicated by a button in the Status Bar displaying an icon and the number of uncommitted changes. Pressing this button opens a fly out list with all of the objects that have uncommitted changes to them. Pressing one of those list objects navigates directly to the corresponding object. The Uncommitted Changes Indicator button is only shown when there are uncommitted changes otherwise it is not visible. When in online mode all changes should be committed automatically so the Indicator is mainly useful in Manual or Offline Sync Mode.
<br>
{{Version/WinXSince|4.7.0}} Queries are now excluded from uncommitted changes.

=== 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. With the [[SYSCLS_CHILDINFOOWNER|child info owner classification]], one can additionally show the number of documents and regular grandchildren to be expected for a child object.

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.

=== Properties Page ===

On the properties page, one can see a list of all the current object's visible properties, and, given the respective rights, a possibility to edit them.

=== Context Menu ===

For any current object, there is a set of potential context-sensitive actions. These are displayed as buttons in the title bar, with a three-dot overflow menu button aggregating all the actions that wouldn't fit there anymore. There are many potential actions; some of them are only enabled for specifically classified objects, like objects with a geo location. Default actions are refresh, various download options, child object creation, copy/paste, commit/revert changes, geo-related actions, etc.

=== Objects ===

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

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

==== Task objects ====

[[https://wiki.augmensys.com/index.php?title=MRO_Objects_(Client)#Task|Tasks]] and [[https://wiki.augmensys.com/index.php?title=MRO_Objects_(Client)#Work_Package|work packages]] are special types of {{UBIK}} objects used for maintenance, repair and overhaul (MRO) use-cases.

==== Query objects ====

Queries are special types of {{UBIK}} objects with dynamic children. The child objects are looked up depending on the query object's criteria, which can be specified the same as property values for regular objects. There are [[QUERY|online queries]] evaluated by the server, and [[https://wiki.augmensys.com/index.php?title=Offline_Query_(UBIK_WinX)|offline queries]] evaluated on the client, thus requiring no internet connection.

==== Safety relevant objects ====

Object classified as [[SYSCLS_SAFETY_RELEVANT_OBJECT|safety relevant]] require the user to accept safety instructions to access the object, which can be required for hazardous MRO tasks, for example.

==== Commissioning objects ====

Similar to and based on MRO objects, commissioning objects are tasks and work packages for the commissioning use-case, e.g., [[SYSCLS_COMMISSIONINGCHECK|commissioning check tasks]].

==== Locked objects ====
In several use-cases, objects can be [[Locked_Objects|locked]] for editing.

=== Properties ===

==== Authentication Properties ====
[[SYSCLS_REQUIRE_AUTHENTICATION|Authentication Properties]] are properties which need a user authentication (through a password field) to be edited.

==== Min max properties ====
See [[Min_Max_Properties]].

==== Live value properties ====
[[Live_Values]] are specific property values extracted from a process control system like OPC-UA or OSIPI.

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

==== Selective List Properties ====
For some properties, the user should be able to select from a predefined set of values. Such a predefined set is called a "selective list" in {{UBIK}}.
Furthermore, there are [[Dynamic_Selective_List_(Client)|dynamic selective lists]] that can be filtered or assembled based on dependency property values.

{{UnderConstructionStart}}
{{Hint|{{Version/WinXSince|5.1.0.0}}{{Version/MobileSince|5.1.0.0}} The ItemsSource binding of related WinX/Mobile controls in Xaml now requires only PropertyViewModel.SelectiveItems, which will return the items of an [[Active_List_Client|ActiveList]] or of MetaProperty.SelectiveList without a SelectiveListToItemsConverter required.}}
{{UnderConstructionEnd}}

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

==== 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).

==== String properties with length restrictions ====
A string property can be configured with a [[MetaProperty#Text_2|length restriction]]. The client property editing UI doesn't allow users to confirm values exceeding the limit.

{{Clear}}

==== [[Editors]] ====

See [[Editors]]

=== Documents ===
UBIK supports and displays document objects and a bunch of actions related to them (editing, redlining, creation, thumbnails, ...).
See [[Documents_(Client)|Documents (Client)]]

==== Fit Mode{{Version/WinXSince|3.5}} ====
See [[Documents_(Client)#Fit_Mode|Fit Mode]]

==== Auto zoom {{Version/WinXSince|4.6}}{{Version/XamarinSince|4.6}} ====
See [[Documents_(Client)#Auto_zoom|Auto zoom]]

==== Editing{{Version/WinXSince|2.5.4}} ====
See [[Documents_(Client)#Editing|Editing]]

==== Offline availability ====
See [[Documents_(Client)#Offline/Online|Offline/Online]]

==== Clear Online Documents ====
[[Documents_(Client)#Offline/Online|Offline/Online]]

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

== 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>

== See also ==
* [[Client_Feature_Table]]
* [[SYSCLS_DOCUMENT_FITMODE]]
* [[SYSCLS_SHOWDOCUMENTS]]
* [[SYSCLS_SHOWPROPERTIES]]

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

UBIK WinX Client Basics

2026-04-20T13:09:26Z

CWI: /* Selective List Properties */

{{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 Mobile 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]].

== Languages ==
The standard {{UBIK}} client supports multiple languages listed below. {{Version/WinXSince|4.3}}
* Chinese (Simplified)
* Czech
* English
* German
* Polish
* Portuguese
* Spanish
{{Attention|As we found out, you can only switch to one of the supported languages if it is installed as a system language in the Windows "Preferred languages / Add a language" setting. For example, if you have only English installed when you install {{UBIK}}, you won't be able to switch to any other languages even if you add those later. In that case, you need to make sure your language of choice is installed in Windows first, then update or reinstall {{UBIK}}. This is a Microsoft Store practice and does not apply to clients installed through sideloading, e.g. from our AppCenter.}}

== 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 ===
==== Saving Indicator ====
[[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.

==== Uncommitted Changes Indicator ====
{{Version/WinXSince|4.6.0}} When there are uncommitted changes it is indicated by a button in the Status Bar displaying an icon and the number of uncommitted changes. Pressing this button opens a fly out list with all of the objects that have uncommitted changes to them. Pressing one of those list objects navigates directly to the corresponding object. The Uncommitted Changes Indicator button is only shown when there are uncommitted changes otherwise it is not visible. When in online mode all changes should be committed automatically so the Indicator is mainly useful in Manual or Offline Sync Mode.
<br>
{{Version/WinXSince|4.7.0}} Queries are now excluded from uncommitted changes.

=== 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. With the [[SYSCLS_CHILDINFOOWNER|child info owner classification]], one can additionally show the number of documents and regular grandchildren to be expected for a child object.

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.

=== Properties Page ===

On the properties page, one can see a list of all the current object's visible properties, and, given the respective rights, a possibility to edit them.

=== Context Menu ===

For any current object, there is a set of potential context-sensitive actions. These are displayed as buttons in the title bar, with a three-dot overflow menu button aggregating all the actions that wouldn't fit there anymore. There are many potential actions; some of them are only enabled for specifically classified objects, like objects with a geo location. Default actions are refresh, various download options, child object creation, copy/paste, commit/revert changes, geo-related actions, etc.

=== Objects ===

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

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

==== Task objects ====

[[https://wiki.augmensys.com/index.php?title=MRO_Objects_(Client)#Task|Tasks]] and [[https://wiki.augmensys.com/index.php?title=MRO_Objects_(Client)#Work_Package|work packages]] are special types of {{UBIK}} objects used for maintenance, repair and overhaul (MRO) use-cases.

==== Query objects ====

Queries are special types of {{UBIK}} objects with dynamic children. The child objects are looked up depending on the query object's criteria, which can be specified the same as property values for regular objects. There are [[QUERY|online queries]] evaluated by the server, and [[https://wiki.augmensys.com/index.php?title=Offline_Query_(UBIK_WinX)|offline queries]] evaluated on the client, thus requiring no internet connection.

==== Safety relevant objects ====

Object classified as [[SYSCLS_SAFETY_RELEVANT_OBJECT|safety relevant]] require the user to accept safety instructions to access the object, which can be required for hazardous MRO tasks, for example.

==== Commissioning objects ====

Similar to and based on MRO objects, commissioning objects are tasks and work packages for the commissioning use-case, e.g., [[SYSCLS_COMMISSIONINGCHECK|commissioning check tasks]].

==== Locked objects ====
In several use-cases, objects can be [[Locked_Objects|locked]] for editing.

=== Properties ===

==== Authentication Properties ====
[[SYSCLS_REQUIRE_AUTHENTICATION|Authentication Properties]] are properties which need a user authentication (through a password field) to be edited.

==== Min max properties ====
See [[Min_Max_Properties]].

==== Live value properties ====
[[Live_Values]] are specific property values extracted from a process control system like OPC-UA or OSIPI.

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

==== Selective List Properties ====
For some properties, the user should be able to select from a predefined set of values. Such a predefined set is called a "selective list" in {{UBIK}}.
Furthermore, there are [[Dynamic_Selective_List_(Client)|dynamic selective lists]] that can be filtered or assembled based on dependency property values.

{{UnderConstructionStart}}
{{Hint|{{Version/WinXSince|5.1.0.0}}{{Version/MobileSince|5.1.0.0}} The ItemsSource binding of related WinX/Mobile controls in Xaml now requires only PropertyViewModel.SelectiveItems, which will return the items of an [[Active_List_Client|ActiveList]]or of MetaProperty.SelectiveList without a SelectiveListToItemsConverter required.}}
{{UnderConstructionEnd}}

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

==== 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).

==== String properties with length restrictions ====
A string property can be configured with a [[MetaProperty#Text_2|length restriction]]. The client property editing UI doesn't allow users to confirm values exceeding the limit.

{{Clear}}

==== [[Editors]] ====

See [[Editors]]

=== Documents ===
UBIK supports and displays document objects and a bunch of actions related to them (editing, redlining, creation, thumbnails, ...).
See [[Documents_(Client)|Documents (Client)]]

==== Fit Mode{{Version/WinXSince|3.5}} ====
See [[Documents_(Client)#Fit_Mode|Fit Mode]]

==== Auto zoom {{Version/WinXSince|4.6}}{{Version/XamarinSince|4.6}} ====
See [[Documents_(Client)#Auto_zoom|Auto zoom]]

==== Editing{{Version/WinXSince|2.5.4}} ====
See [[Documents_(Client)#Editing|Editing]]

==== Offline availability ====
See [[Documents_(Client)#Offline/Online|Offline/Online]]

==== Clear Online Documents ====
[[Documents_(Client)#Offline/Online|Offline/Online]]

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

== 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>

== See also ==
* [[Client_Feature_Table]]
* [[SYSCLS_DOCUMENT_FITMODE]]
* [[SYSCLS_SHOWDOCUMENTS]]
* [[SYSCLS_SHOWPROPERTIES]]

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

UBIK WinX Client Basics

2026-04-20T13:08:40Z

CWI: /* Selective List Properties */

{{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 Mobile 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]].

== Languages ==
The standard {{UBIK}} client supports multiple languages listed below. {{Version/WinXSince|4.3}}
* Chinese (Simplified)
* Czech
* English
* German
* Polish
* Portuguese
* Spanish
{{Attention|As we found out, you can only switch to one of the supported languages if it is installed as a system language in the Windows "Preferred languages / Add a language" setting. For example, if you have only English installed when you install {{UBIK}}, you won't be able to switch to any other languages even if you add those later. In that case, you need to make sure your language of choice is installed in Windows first, then update or reinstall {{UBIK}}. This is a Microsoft Store practice and does not apply to clients installed through sideloading, e.g. from our AppCenter.}}

== 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 ===
==== Saving Indicator ====
[[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.

==== Uncommitted Changes Indicator ====
{{Version/WinXSince|4.6.0}} When there are uncommitted changes it is indicated by a button in the Status Bar displaying an icon and the number of uncommitted changes. Pressing this button opens a fly out list with all of the objects that have uncommitted changes to them. Pressing one of those list objects navigates directly to the corresponding object. The Uncommitted Changes Indicator button is only shown when there are uncommitted changes otherwise it is not visible. When in online mode all changes should be committed automatically so the Indicator is mainly useful in Manual or Offline Sync Mode.
<br>
{{Version/WinXSince|4.7.0}} Queries are now excluded from uncommitted changes.

=== 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. With the [[SYSCLS_CHILDINFOOWNER|child info owner classification]], one can additionally show the number of documents and regular grandchildren to be expected for a child object.

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.

=== Properties Page ===

On the properties page, one can see a list of all the current object's visible properties, and, given the respective rights, a possibility to edit them.

=== Context Menu ===

For any current object, there is a set of potential context-sensitive actions. These are displayed as buttons in the title bar, with a three-dot overflow menu button aggregating all the actions that wouldn't fit there anymore. There are many potential actions; some of them are only enabled for specifically classified objects, like objects with a geo location. Default actions are refresh, various download options, child object creation, copy/paste, commit/revert changes, geo-related actions, etc.

=== Objects ===

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

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

==== Task objects ====

[[https://wiki.augmensys.com/index.php?title=MRO_Objects_(Client)#Task|Tasks]] and [[https://wiki.augmensys.com/index.php?title=MRO_Objects_(Client)#Work_Package|work packages]] are special types of {{UBIK}} objects used for maintenance, repair and overhaul (MRO) use-cases.

==== Query objects ====

Queries are special types of {{UBIK}} objects with dynamic children. The child objects are looked up depending on the query object's criteria, which can be specified the same as property values for regular objects. There are [[QUERY|online queries]] evaluated by the server, and [[https://wiki.augmensys.com/index.php?title=Offline_Query_(UBIK_WinX)|offline queries]] evaluated on the client, thus requiring no internet connection.

==== Safety relevant objects ====

Object classified as [[SYSCLS_SAFETY_RELEVANT_OBJECT|safety relevant]] require the user to accept safety instructions to access the object, which can be required for hazardous MRO tasks, for example.

==== Commissioning objects ====

Similar to and based on MRO objects, commissioning objects are tasks and work packages for the commissioning use-case, e.g., [[SYSCLS_COMMISSIONINGCHECK|commissioning check tasks]].

==== Locked objects ====
In several use-cases, objects can be [[Locked_Objects|locked]] for editing.

=== Properties ===

==== Authentication Properties ====
[[SYSCLS_REQUIRE_AUTHENTICATION|Authentication Properties]] are properties which need a user authentication (through a password field) to be edited.

==== Min max properties ====
See [[Min_Max_Properties]].

==== Live value properties ====
[[Live_Values]] are specific property values extracted from a process control system like OPC-UA or OSIPI.

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

==== Selective List Properties ====
For some properties, the user should be able to select from a predefined set of values. Such a predefined set is called a "selective list" in {{UBIK}}.
Furthermore, there are [[Dynamic_Selective_List_(Client)|dynamic selective lists]] that can be filtered or assembled based on dependency property values.

{{UnderConstructionStart}}
{{Hint|{{Version/WinXSince|5.1.0.0}}{{Version/MobileSince|5.1.0.0}} The ItemsSource binding of related WinX/Mobile controls in Xaml now requires only PropertyViewModel.SelectiveItems, which will return the items of an ActiveList or of MetaProperty.SelectiveList without a SelectiveListToItemsConverter required.}}
{{UnderConstructionEnd}}

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

==== 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).

==== String properties with length restrictions ====
A string property can be configured with a [[MetaProperty#Text_2|length restriction]]. The client property editing UI doesn't allow users to confirm values exceeding the limit.

{{Clear}}

==== [[Editors]] ====

See [[Editors]]

=== Documents ===
UBIK supports and displays document objects and a bunch of actions related to them (editing, redlining, creation, thumbnails, ...).
See [[Documents_(Client)|Documents (Client)]]

==== Fit Mode{{Version/WinXSince|3.5}} ====
See [[Documents_(Client)#Fit_Mode|Fit Mode]]

==== Auto zoom {{Version/WinXSince|4.6}}{{Version/XamarinSince|4.6}} ====
See [[Documents_(Client)#Auto_zoom|Auto zoom]]

==== Editing{{Version/WinXSince|2.5.4}} ====
See [[Documents_(Client)#Editing|Editing]]

==== Offline availability ====
See [[Documents_(Client)#Offline/Online|Offline/Online]]

==== Clear Online Documents ====
[[Documents_(Client)#Offline/Online|Offline/Online]]

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

== 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>

== See also ==
* [[Client_Feature_Table]]
* [[SYSCLS_DOCUMENT_FITMODE]]
* [[SYSCLS_SHOWDOCUMENTS]]
* [[SYSCLS_SHOWPROPERTIES]]

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

UBIK Active Lists

2026-04-20T12:47:22Z

CWI: /* Further Notes */

{{UBIK}} ActiveLists provide the possibility to configure instance-specific lists for integer MetaProperties.

= Purpose =
In some cases it is required to define a list of selectable values for an integer MetaProperty that is specific to a single instance rather than globally defined at the MetaClass level. For example, two instances of the same MetaClass can offer different selectable values for the same MetaProperty.

{{UBIK}} ActiveLists are the representation of such lists. They update dynamically on the client side without requiring an ACM rebuild and can be maintained per instance through server methods.

{{UnderConstructionStart}}

If a MetaProperty has both a SelectiveList and an ActiveList, the ActiveList takes precedence when data is displayed on the client, and the SelectiveList is ignored.

[[Category:ActiveList|UBIK Active Lists]]
[[Category:Server|UBIK Active Lists]]

= Client Behavior =
When the user opens an ActiveList:
* The label for each option is shown in the language configured on the web service. If a translation for the configured language is unavailable, the label is displayed in the default language.
* Each option in the ActiveList has an associated unique integer value that is set to the MetaProperty when selected.
* Only one option can be selected at a time. Selecting an option updates the MetaProperty value immediately.

Sorting of items in the dropdown:

* If all options in the ActiveList have unique sort order values, they are displayed in ascending order of these sort order values.
* If sort orders are not unique, options with the same sort order are sorted in ascending order by their label.

For more details see: [[Active List Client]]

{{UnderConstructionEnd}}

= Server-Side Concept =
ActiveLists are stored in serialized JSON form in the '''ACTIVE_LISTS''' property of the instance.

* Each list is associated with exactly one integer MetaProperty of the instance.
* An instance can have multiple ActiveLists, one for each integer MetaProperty.
* ActiveLists can be viewed in UBIK.Studio in the Object Explorer under “ActiveLists” for the instance, but they cannot be edited there.

= Managing {{UBIK}} ActiveLists =
ActiveLists are managed entirely through server methods. The most relevant methods are:

=== AddOrUpdateActiveList(metaProperty, value, labels, sortOrder) ===
Adds a new list item or updates the labels of an existing one. Optionally repositions the item according to sortOrder.

=== SortActiveList(metaProperty, orderedValues) ===
Reorders the items of a list according to the specified sequence. Items not included in '''orderedValues''' are appended in their current order.

=== RemoveActiveListItem(metaProperty, value) ===
Removes a single list item by its integer value.

=== RemoveActiveList(metaProperty) ===
Removes the entire list for the given MetaProperty.

=== GetActiveLists() ===
Returns all ActiveLists defined on the instance as '''UbikActiveList''' objects, each containing the MetaProperty name and its list items.

= Who-Bert Example =
The following Who-Bert snippet demonstrates how to work with an ActiveList for a MetaProperty named "'''MP_INT_A'''":

<syntaxhighlight lang="csharp">
using System;
using System.Windows.Forms;
using System.Linq;
using System.Collections.Generic;
using UBIK.Kernel;
using UBIK.Runtime;
using UBIK.Runtime.Sys;
using UBIK.Compiler;
using UBIK.Content;

namespace Studio
{
public class ObjectTest
{
public void TestObject(params BaseClass[] InVariables)
{
Debugger.Output(this, "*** Started ActiveList Example");
foreach (BaseClass obj in InVariables)
{
ContentClass c = obj as ContentClass;

var labels1 = new Dictionary<string, string> { { "en", "One" }, { "de", "Eins" } };
var labels2 = new Dictionary<string, string> { { "en", "Two" }, { "de", "Zwei" } };
var labels3 = new Dictionary<string, string> { { "en", "Three" }, { "de", "Drei" } };

// Add items
c.AddOrUpdateActiveList("MP_INT_A", 1, labels1);
c.AddOrUpdateActiveList("MP_INT_A", 2, labels2);
c.AddOrUpdateActiveList("MP_INT_A", 3, labels3);

// Update labels and move item 3 to index 0
var labels3Updated = new Dictionary<string, string> { { "en", "Three Updated" }, { "de", "Drei Aktualisiert" } };
c.AddOrUpdateActiveList("MP_INT_A", 3, labels3Updated, 0);

// Sort items: 2, 1, 3
c.SortActiveList("MP_INT_A", new int[] { 2, 1, 3 });

// Remove item 1
c.RemoveActiveListItem("MP_INT_A", 1);

c.Save();
}
Debugger.Output(this, "*** Finished ActiveList Example");
}
}
} </syntaxhighlight>

= Further Notes =

* ActiveLists are designed for lightweight, instance-specific value lists that can be updated without ACM rebuilds.
* They are ideal for use cases where list content varies between instances of the same MetaClass.
* When both an ActiveList and a SelectiveList are defined for the same MetaProperty, the ActiveList overrides the SelectiveList on the client.

[[Category:ActiveList|UBIK Active Lists]]
[[Category:Server|UBIK Active Lists]]

UBIK Active Lists

2026-04-20T12:44:49Z

CWI: /* Purpose */

{{UBIK}} ActiveLists provide the possibility to configure instance-specific lists for integer MetaProperties.

= Purpose =
In some cases it is required to define a list of selectable values for an integer MetaProperty that is specific to a single instance rather than globally defined at the MetaClass level. For example, two instances of the same MetaClass can offer different selectable values for the same MetaProperty.

{{UBIK}} ActiveLists are the representation of such lists. They update dynamically on the client side without requiring an ACM rebuild and can be maintained per instance through server methods.

{{UnderConstructionStart}}

If a MetaProperty has both a SelectiveList and an ActiveList, the ActiveList takes precedence when data is displayed on the client, and the SelectiveList is ignored.

[[Category:ActiveList|UBIK Active Lists]]
[[Category:Server|UBIK Active Lists]]

= Client Behavior =
When the user opens an ActiveList:
* The label for each option is shown in the language configured on the web service. If a translation for the configured language is unavailable, the label is displayed in the default language.
* Each option in the ActiveList has an associated unique integer value that is set to the MetaProperty when selected.
* Only one option can be selected at a time. Selecting an option updates the MetaProperty value immediately.

Sorting of items in the dropdown:

* If all options in the ActiveList have unique sort order values, they are displayed in ascending order of these sort order values.
* If sort orders are not unique, options with the same sort order are sorted in ascending order by their label.

For more details see: [[Active List Client]]

{{UnderConstructionEnd}}

= Server-Side Concept =
ActiveLists are stored in serialized JSON form in the '''ACTIVE_LISTS''' property of the instance.

* Each list is associated with exactly one integer MetaProperty of the instance.
* An instance can have multiple ActiveLists, one for each integer MetaProperty.
* ActiveLists can be viewed in UBIK.Studio in the Object Explorer under “ActiveLists” for the instance, but they cannot be edited there.

= Managing {{UBIK}} ActiveLists =
ActiveLists are managed entirely through server methods. The most relevant methods are:

=== AddOrUpdateActiveList(metaProperty, value, labels, sortOrder) ===
Adds a new list item or updates the labels of an existing one. Optionally repositions the item according to sortOrder.

=== SortActiveList(metaProperty, orderedValues) ===
Reorders the items of a list according to the specified sequence. Items not included in '''orderedValues''' are appended in their current order.

=== RemoveActiveListItem(metaProperty, value) ===
Removes a single list item by its integer value.

=== RemoveActiveList(metaProperty) ===
Removes the entire list for the given MetaProperty.

=== GetActiveLists() ===
Returns all ActiveLists defined on the instance as '''UbikActiveList''' objects, each containing the MetaProperty name and its list items.

= Who-Bert Example =
The following Who-Bert snippet demonstrates how to work with an ActiveList for a MetaProperty named "'''MP_INT_A'''":

<syntaxhighlight lang="csharp">
using System;
using System.Windows.Forms;
using System.Linq;
using System.Collections.Generic;
using UBIK.Kernel;
using UBIK.Runtime;
using UBIK.Runtime.Sys;
using UBIK.Compiler;
using UBIK.Content;

namespace Studio
{
public class ObjectTest
{
public void TestObject(params BaseClass[] InVariables)
{
Debugger.Output(this, "*** Started ActiveList Example");
foreach (BaseClass obj in InVariables)
{
ContentClass c = obj as ContentClass;

var labels1 = new Dictionary<string, string> { { "en", "One" }, { "de", "Eins" } };
var labels2 = new Dictionary<string, string> { { "en", "Two" }, { "de", "Zwei" } };
var labels3 = new Dictionary<string, string> { { "en", "Three" }, { "de", "Drei" } };

// Add items
c.AddOrUpdateActiveList("MP_INT_A", 1, labels1);
c.AddOrUpdateActiveList("MP_INT_A", 2, labels2);
c.AddOrUpdateActiveList("MP_INT_A", 3, labels3);

// Update labels and move item 3 to index 0
var labels3Updated = new Dictionary<string, string> { { "en", "Three Updated" }, { "de", "Drei Aktualisiert" } };
c.AddOrUpdateActiveList("MP_INT_A", 3, labels3Updated, 0);

// Sort items: 2, 1, 3
c.SortActiveList("MP_INT_A", new int[] { 2, 1, 3 });

// Remove item 1
c.RemoveActiveListItem("MP_INT_A", 1);

c.Save();
}
Debugger.Output(this, "*** Finished ActiveList Example");
}
}
} </syntaxhighlight>

= Further Notes =

* ActiveLists are designed for lightweight, instance-specific value lists that can be updated without ACM rebuilds.
* They are ideal for use cases where list content varies between instances of the same MetaClass.
* When both an ActiveList and a SelectiveList are defined for the same MetaProperty, the SelectiveList overrides the ActiveList on the client.

[[Category:ActiveList|UBIK Active Lists]]
[[Category:Server|UBIK Active Lists]]

Active List Client

2026-04-20T10:01:32Z

CWI:

MRO Objects (Client)

2026-04-20T09:54:49Z

CWI: /* See also */

[[File:MRO_WinX.png|thumb|alt=MRO Child List UI (WinX)|MRO UI (WinX)]]
[[File:MRO_MAUI1.jpeg|thumb|alt=MRO Child List UI (Android)|MRO UI (Android)]]
The WinX client UI displays MRO configured objects like any other root- or child-object enriched by some additional logic and features.

== Basic User Interface ==
The representation of MRO features comprises some indicators and interactive controls. In the {{UBIK}} child list, the main object displays cumulated technical and organisational status as well as the overall work progress based on the underlying data branch. Objects classified as MRO objects in general provide indicators for the MRO status. This means the status is shown next to the main icon of a child-/details-/documents-page as well as next to the icons of the child list items:

=== Technical Status ===

The technical status indicator is shown on all objects that represent a technical state or receive the technical status from subsequent objects in the underlying data branch. If e.g. a inventory object is reported as damaged, its parent objects will all display the exclamation mark symbol to indicate that a problem was reported in the child items.

[[File:TechStats_WinX.png|100px|Technical Status Indicator (Winx & Mobile)]]

=== Organisational Status ===
The organisational status indicates the amount of confirmed work within the data branch, including already confirmed work packages as well as tasks that are locked by their owning work package. The organisational status indicator is displayed on all objects that represent an organisational state or receive the organisational status from subsequent objects in the underlying data branch, and visualizes the amount of confirmed work performed within that branch.
<gallery>
File:UI_WinX_MRO_OrganisationalStatusIndicator.png|Organisational Status Indicator (WinX)
File:ConfirmedWP_WinX.png|MRO Workpackage Confirmed (Flag) Indicator (WinX)
File:Android_orga_status.PNG|Organisational Status Indicator (Android)
File:ConfirmedWP_MAUI.jpeg|MRO Workpackage Confirmed Indicator (Mobile)
</gallery>

=== Work Progress ===
The work progress is calculated from the current work progress and from the progress cumulated from subsequent objects in the underlying data branch. This indicator shows the amount of work done in the data branch.

{{Version/WinXSince|5.0}} {{Version/MobileSince|5.0}} By default, the progress is displayed with maximum one decimal place. For example, 99.75% is displayed as 99.8%. The format string used to achieve this is <code>{0:0.#}%</code>.

If other numeric formats are preferred in your usecases, you can refer to [https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-numeric-format-strings custom numeric format strings] for more information. The template to customize for this is the UBIKMROProgressBadge within UBIKThemes.

{{Clear}}

== MRO Objects ==
A set of specific objects can be used to provide the required structure for MRO:

=== Task Owner ===
A [[MROCLS_MRO_TASKOWNER|Task Owner]] is an object having a substructure of jobs to be done. It can have a tree of other task owners or work packages underneath that will update the status of the task owner. This status consists of technical, organisational and progress information. With a task owner a user can get an overview of all the work to be done in the underlying job structure.

=== Work Package===
A [[MROCLS_MRO_WORKPACKAGE|Work Package]] is a collection of objects to collect and summarize other task owning objects, workpackages, or tasks. A simple workpackage has a certain amount of tasks that have to be finished in order to confirm the workpackage as done. More complex workpackages can also own other underlying workpackages that have to be confirmed. Confirming a workpackage itself requires a progress of 100% of all related tasks, as well as 100% confirmed sub work packages.

<gallery>
File:ConfirmingWP_WinX.png|MRO Workpackage confirm button (WinX)
File:MRORevoke_WinX.png|MRO Workpackage revoke confirmation button (WinX)
File:ConfirmingWP_MAUI.jpeg|MRO Workpackage confirm button (Android)
File:MRORevoke_MAUI.jpeg|MRO Workpackage revoke confirmation button (Android)
</gallery>

=== Task ===
A [[MROCLS_MRO_TASK|Task]] is an object reporting a certain progress to the owning workpackage. There are several specialized types of task objects. All kinds of tasks have a property called '''VALUE''' in common. It is very important, that this property is able to be validated. Therefore, a MetaAttribute (providing a validation timestamp by default) has to be attached on the used MetaProperty.

On both clients, a Task can be reverted by clicking twice on the Not Applicable button.

{{Attention|The MetaProperty ''VALUE'' has to use [[Attributes]] in order to be validated. Otherwise, the calculation of work progress will not be possible.}}

==== Measurement Task ====

A [[MROCLS_MRO_MEASUREMENT_TASK|Measurement Task]] inherits from [[MROCLS_MRO_TASK|Task]] and documents a measured value (e.g. read from a pressure gauge). Therefore, clicking the value on the shown task opens an editor to enter the desired value. If no value was entered before, an empty line will be shown. Once a value has been entered, the task is finished. Alternatively, the task can also be closed by the option ''Not Applicable'' to document the situation of not being able to fullfill the measurement (e.g. the pressure gauge is broken). An additional small value indicator below the main value can report e.g. the previously entered value. The behaviour of this previous value indicator has to be specified separately in the customizing.
{{Clear}}

<gallery widths=497px heights=69px>
File:Measurment Task Empty UWP.png|Measurement Task without a reported value (WinX)
File:Measurment Task Not Empty UWP.png|Measurement Task with a reported value (WinX)
File:Measurment Task Empty Android.jpg|Measurement Task without a reported value (Android)
</gallery>

==== Progress Task ====

[[MROCLS_MRO_PROGRESS_TASK| Progress Task]] inherits from [[MROCLS_MRO_MEASUREMENT_TASK|Task]] and reports a certain progress while fullfilling a task. The progress will influence the overall progress of the owning workpackage. If the task cannot be fullfilled, it can also be finished with the option ''Not Applicable''.

There is also an [[MRO_PROGRESS_TASK_EDITOR|alternative editor]] available for progress tasks.{{Version/WinXSince|2.5.4}}
{{Clear}}

<gallery widths=497px heights=69px>
File:Progress Task UWP.png|Progress Task with a reported work progress (WinX)
File:Progress Task Android.jpg|Progress Task with a reported work progress and a previous progress(Android)
</gallery>

==== Check Task ====

A [[MROCLS_MRO_CHECK_TASK|Check Task]] inherits from [[MROCLS_MRO_TASK|Task]] and is finished by reporting ''Done'' or ''Not Applicable''. This is intended for a simple To-Do task that is either done or not.
{{Clear}}

<gallery widths=497px heights=69px>
File:Check Task finished UWP.png|Unfinished MRO CheckTask (WinX)
File:Check Task android.jpg|Not Applicable MRO CheckTask (Android)
</gallery>

==== Inspection Task ====

[[MROCLS_MRO_INSPECTION_TASK|Inspection Task]] inherits from [[MROCLS_MRO_TASK|Task]] and is finished, when the user reports with a positive or negative answer or ''Not Applicable'' (e.g. reporting a yes/no answer for existing equipment).
{{Clear}}

<gallery widths=497px heights=69px>
File:Finished Inspection Task UWP.png|Finished MRO InspectionTask (WinX)
File:Inspection task android.jpg|Finished MRO InspectionTask (Android)
</gallery>

==== Sequential Task ====
The [[MROCLS_SEQUENTIALTASK|sequential task classification]] allows you to pre-define a sequence in which tasks are to be resolved by users. This means that it is required for one or multiple tasks to be finished in order for other tasks to become "unlocked" and editable. A task can have any number of "predecessors". Predecessors are the tasks that are required to be finished first.

A task can have predecessors that live anywhere else in the object hierarchy. It is not necessary for a task and its predecessors to be part of the same work package, even though this is likely the most common use case.

The state of a sequential task is evaluated both offline and online to get the best possible user experience. The user will see dependent tasks update immediately if their successors were finished, if those tasks are currently visible in the UI. There is 1 case in which the server-side state will override the client-side (offline) evaluation, discussed below.
The state of each sequential task is evaluated the following way:

# If the server-side state says the task is open, we consider this as the truthful state and don't do any other evaluation.
# Check if the task has any predecessors.
# Try to load each predecessor task.
#* If loading of any predecessor fails (the object is not available offline), the task will be locked.
# If all predecessor tasks are finished, the task is open and can be edited. Otherwise, the task is locked.

The customizer setting up the task dependency relations needs to ensure that the dependencies are not cyclical. In this case, it would be impossible for any tasks in the "cycle" to be finished.

'''Example'''

As a demonstration of this feature, see [[Media:Sequential_tasks_winx.mp4|this video]]. The relations between tasks are defined as in [[Media:Task_relations.png|this image]], starting at A1 and A2, which are not dependent on any other tasks. The lines (from left to right) indicate dependencies. This means that B2 has tasks A1 and A2 as its predecessors, for example.

==== Grouped Task {{Version/WinXSince|4.2}}{{Version/XamarinSince|4.2}} ====
Sometimes, not all tasks have to be finished. More specifically, there might be a predefined condition where you only need to finish a certain number of tasks among a group of them. These are known in {{UBIK}} as [[MROCLS_GROUPEDTASK|grouped tasks]].

The idea is, a group of tasks can be defined as siblings to each other and they also share the same server configured threshold. When the number of finished tasks among that group exceeds the threshold, the entire group is considered as no longer necessary. When reflected in the overall status of the task owner(s), these tasks would appear as if they are finished.

{{Hint|Technically speaking, the finished status is completely independent from the not necessary status on a task. A grouped task which is no longer necessary can be both finished or not yet finished. In other words, users don't have to finish a not necessary grouped task, but they still can.}}

{{Hint|The precise status calculation for grouped tasks and their task owners requires the knowledge of all siblings tasks. Imagine 2 out of 3 tasks must be finished but the client only knows 1 in total and the others are only available at the server at that time. This makes it impossible to draw conclusions whether the task(s) should be necessary or not. Under such circumstances, the local status calculation is done as if these are just regular tasks.}}

{{Hint|Like with the other MRO objects, the client always chooses the best available statuses for grouped tasks to present to the users. More specifically, it uses the statuses calculated by the server when the client is not offline and there are no uncommitted local changes on the involved objects. Otherwise, it uses the statuses calculated locally to the best of its knowledge.}}

A task can also be a grouped and a sequential one at the same time. In such a case, the grouped nature of the sibling tasks will affect the way the task sequence completes.

For example, task A1, A2 and A3 are 3 grouped sibling tasks and only 1 of them needs to be finished. At the same time, they are all predecessors of task B. Normally, all predecessors must be finished (and locked) before task B becomes the next one in the sequence and therefore unlocked. In this case, however, as soon as one of the predecessors is finished, all three become unnecessary (and locked) and task B unlocks as a result of that.

==== Supervisor Task {{Version/XamarinSince|4.8}} ====
As the name suggests, supervisor tasks are those that must be finished under supervision. When users want to finish a [[MROCLS_MRO_SUPERVISOR_TASK|supervisor task]], they must hand over their work devices to a supervisor. The latter checks the work status and scans an NFC tag if the work is approved. If the [[MROCLS_MRO_SUPERVISOR|supervisor]] has sufficient permissions for the task and the correct supervisor PIN is given, the task gets unlocked and the users can proceed to finish it.

<gallery widths=300px heights=300px>
File:UI_Xamarin_Supervisor_Task_Before_Verification.jpg|Supervisor Task Before Verification/Unlocking (Mobile)
File:UI_Xamarin_Supervisor_Task_Enter_PIN.jpg|Supervisor Task Enter PIN (Mobile)
File:UI_Xamarin_Supervisor_Task_After_Verification.jpg|Supervisor Task After Verification/Unlocking (Mobile)
</gallery>

A thing to note is that while the need to verify a supervisor task can be seen as a type of locking, it's certainly not the only reason for a [[Locked_Objects|locked object]]. This means a supervisor task can remain locked (although for different reasons) even after a supervisor has successfully verified it. This can often be the case if you use it in combination with other features such as [[MRO_Objects_(Client)#Sequential_Task|sequential tasks]], [[User_Rights|user rights]].

{{Hint|For security reasons, the verification process is cancelled if the supervisor enters the wrong PIN for three times. Scanning the tag again is required in that case.}}
{{Hint|A setting controls [[RFID_tags#Choose_which_information_to_use_from_a_tag|which information in a scanned tag is used]] during this process.}}

==== Signature Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

The Signature Task is a task type that is completed by capturing a handwritten signature from the user. The task contains an editor field that serves as the entry point for the signing process. When the user clicks (or taps) on the editor field, a signature dialog opens. Within this dialog, the user can provide their signature. After confirming the input, the signature is saved and the task is automatically marked as completed.

If the task is signed while the client is online:
* The User (signee) is resolved immediately by the server and displayed.
* The ValidationTimestamp is generated and displayed.
* Both values are shown directly in the editor field after signing.

{{Hint|The User only gets resolved by the server and displayed once you're in online mode}}

If the displayed User and/or ValidationTimestamp cannot be fully shown due to limited space in the editor field, the complete information can be accessed via a tooltip.

* In '''UBIK WinX (UWP)''', hover over the editor field with the mouse.
* In '''UBIK Mobile''', perform a long press on the editor field.
A tooltip will appear, displaying the full User and ValidationTimestamp without truncation.

==== Picture Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

A [[MROCLS_PICTURE_TASK|picture task]] is a check task which can only be finished when it has at least one child document containing a valid file. In the UI, an additional photo button is presented next to the check so users can easily take photos before finishing the tasks.
* As any other objects, picture tasks can carry and display [[SYSCLS_CHILDINFOOWNER|child count information]]. But that is not a mandatory part of the feature. Even when it's not configured and not visible in the UI, you can still finish the tasks.
* In WinX/UWP, the UI also presents an expander which allows you to display the child documents of picture tasks. This is not present by default in the Mobile app due to the screen size limit but [[Object_hierarchy_in_XAML:_NextLevel,_ParentLevel,_LinkedLevel#Show_NextLevel_Children.2FDocuments|can be easily customized]].

{{Hint|The task is named as such because pictures are the most commonly used types, but the child documents can be of other types as well. }}

When a user tries to finish a picture task by tapping the check, the app might perform some data synchronization first if in online mode, which includes
* Syncing the child objects (including documents) of the task.
* Downloading the file(s) of the child documents.
During data synchronization, the check button on that task turns into a wait indicator. Afterwards, the app checks if the prerequisites to finish the task are met.
* If there are no child documents or no local files for the child documents, the task remains unfinished and the user gets informed about the reasons.
* Otherwise, the task gets finished and the photo button gets disabled.

{{Hint|Setting NA (not applicable) on a picture task is always possible, regardless of the condition of child documents.}}

{{UnderConstructionStart}}
==== Numeric Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

A [[MROCLS_MRO_NUMERIC_TASK|numeric task]] is a task which records a double value (e.g. from a temperature sensor). Entering the value (including Not Applicable) completes the task.
* The value is compared against an accaptable value range which is not editable on the client.
* Deviation from this range results in visual feedback as well as the [[#Tech Status|tech status]] being set to display an issue.
* If the configured value range is invalid (e.g. min > max) and the user enters a value, the [[#Tech Status|tech status]] will also be set to display an issue.
* A numeric task also has a special value unit that can be set per task instance. If set, it overrides the standard value unit defined on the [[MetaProperty#Unit_Item|MetaProperty]].
{{UnderConstructionEnd}}

{{UnderConstructionStart}}
==== Pick List Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

A [[MROCLS_PICK_LIST_TASK|Pick List task]] looks and behaves the same like a standard Integer Task with SelectiveList. Other than the standard Integer Task, the Pick List Task has an [[UBIK_Active_Lists|Active List]] defined on instance level to pick from for its value property. The task counts as finished as soon as a list item has been selected, or when pressing ''Not Applicable''.
{{UnderConstructionEnd}}

[[Category:Android|MRO Objects (UBIK WinX)]]
[[Category:Client|MRO Objects (Client)]]
[[Category:Mobile|MRO Objects (Client)]]
[[Category:Pages with broken file links|MRO Objects (Client)]]
[[Category:WinX|MRO Objects (UBIK WinX)]]

=== MRO objects with project information (WinX only) {{Version/WinXSince|2.5.4}} ===
[[File:UI_WinX_MRO_ProjectInfo.png|thumb|MRO Object with Project Info (WinX)]]
An MRO object (except tasks) might also bring along [[MROCLS_PROJECTINFORMATION|project information]]. In this case, the project information together with the MRO progress are displayed in a bar chart. The start & end dates of the MRO object are displayed on the progress bar. The length and the position of the progress bar, together with the current date mark indicate the timeline.
{{Clear}}

== Locking ==
When an (MRO) object is locked, editing it becomes impossible. More details about [[Locked_Objects|locked objects]].

== See also ==
* [[MRO (Plugin)]]
* [[MROCLS_PROJECT]]
* [[MROCLS_PROJECTINFORMATION]]
* [[MROCLS_SEQUENTIALTASK]]
* [[MROCLS_GROUPEDTASK]]
* [[MROCLS_MRO_CHECK_TASK]]
* [[MROCLS_MRO_INSPECTION_TASK]]
* [[MROCLS_MRO_MEASUREMENT_TASK]]
* [[MROCLS_MRO_PROGRESS_TASK]]
* [[MROCLS_MRO_TASK]]
* [[MROCLS_MRO_TASKOWNER]]
* [[MROCLS_MRO_WORKPACKAGE]]
* [[MROCLS_PROCEDURE#Procedure Workpackage]] (Classification)
* [[MROCLS_SWITCH_TASK#Switch Task]] (Classification)
* [[MROCLS_SWITCH_END_TASK#Switch End Task]] (Classification)
* [[MROCLS_CALCULATION_TASK#Calculation Task]] (Classification)
* [[MROCLS_PICK_LIST_TASK]] (Classification)

[[Category:Android|MRO Objects (UBIK WinX)]]
[[Category:Client|MRO Objects (Client)]]
[[Category:Mobile|MRO Objects (Client)]]
[[Category:Pages with broken file links|MRO Objects (Client)]]
[[Category:WinX|MRO Objects (UBIK WinX)]]

Category:Active List

2026-04-20T09:52:53Z

CWI: Blanked the page

Active List Client

2026-04-20T09:52:11Z

CWI:

Active List Client

2026-04-20T09:39:36Z

CWI: /* See also */

MRO Objects (Client)

2026-04-20T09:32:15Z

CWI: /* Task */

[[File:MRO_WinX.png|thumb|alt=MRO Child List UI (WinX)|MRO UI (WinX)]]
[[File:MRO_MAUI1.jpeg|thumb|alt=MRO Child List UI (Android)|MRO UI (Android)]]
The WinX client UI displays MRO configured objects like any other root- or child-object enriched by some additional logic and features.

== Basic User Interface ==
The representation of MRO features comprises some indicators and interactive controls. In the {{UBIK}} child list, the main object displays cumulated technical and organisational status as well as the overall work progress based on the underlying data branch. Objects classified as MRO objects in general provide indicators for the MRO status. This means the status is shown next to the main icon of a child-/details-/documents-page as well as next to the icons of the child list items:

=== Technical Status ===

The technical status indicator is shown on all objects that represent a technical state or receive the technical status from subsequent objects in the underlying data branch. If e.g. a inventory object is reported as damaged, its parent objects will all display the exclamation mark symbol to indicate that a problem was reported in the child items.

[[File:TechStats_WinX.png|100px|Technical Status Indicator (Winx & Mobile)]]

=== Organisational Status ===
The organisational status indicates the amount of confirmed work within the data branch, including already confirmed work packages as well as tasks that are locked by their owning work package. The organisational status indicator is displayed on all objects that represent an organisational state or receive the organisational status from subsequent objects in the underlying data branch, and visualizes the amount of confirmed work performed within that branch.
<gallery>
File:UI_WinX_MRO_OrganisationalStatusIndicator.png|Organisational Status Indicator (WinX)
File:ConfirmedWP_WinX.png|MRO Workpackage Confirmed (Flag) Indicator (WinX)
File:Android_orga_status.PNG|Organisational Status Indicator (Android)
File:ConfirmedWP_MAUI.jpeg|MRO Workpackage Confirmed Indicator (Mobile)
</gallery>

=== Work Progress ===
The work progress is calculated from the current work progress and from the progress cumulated from subsequent objects in the underlying data branch. This indicator shows the amount of work done in the data branch.

{{Version/WinXSince|5.0}} {{Version/MobileSince|5.0}} By default, the progress is displayed with maximum one decimal place. For example, 99.75% is displayed as 99.8%. The format string used to achieve this is <code>{0:0.#}%</code>.

If other numeric formats are preferred in your usecases, you can refer to [https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-numeric-format-strings custom numeric format strings] for more information. The template to customize for this is the UBIKMROProgressBadge within UBIKThemes.

{{Clear}}

== MRO Objects ==
A set of specific objects can be used to provide the required structure for MRO:

=== Task Owner ===
A [[MROCLS_MRO_TASKOWNER|Task Owner]] is an object having a substructure of jobs to be done. It can have a tree of other task owners or work packages underneath that will update the status of the task owner. This status consists of technical, organisational and progress information. With a task owner a user can get an overview of all the work to be done in the underlying job structure.

=== Work Package===
A [[MROCLS_MRO_WORKPACKAGE|Work Package]] is a collection of objects to collect and summarize other task owning objects, workpackages, or tasks. A simple workpackage has a certain amount of tasks that have to be finished in order to confirm the workpackage as done. More complex workpackages can also own other underlying workpackages that have to be confirmed. Confirming a workpackage itself requires a progress of 100% of all related tasks, as well as 100% confirmed sub work packages.

<gallery>
File:ConfirmingWP_WinX.png|MRO Workpackage confirm button (WinX)
File:MRORevoke_WinX.png|MRO Workpackage revoke confirmation button (WinX)
File:ConfirmingWP_MAUI.jpeg|MRO Workpackage confirm button (Android)
File:MRORevoke_MAUI.jpeg|MRO Workpackage revoke confirmation button (Android)
</gallery>

=== Task ===
A [[MROCLS_MRO_TASK|Task]] is an object reporting a certain progress to the owning workpackage. There are several specialized types of task objects. All kinds of tasks have a property called '''VALUE''' in common. It is very important, that this property is able to be validated. Therefore, a MetaAttribute (providing a validation timestamp by default) has to be attached on the used MetaProperty.

On both clients, a Task can be reverted by clicking twice on the Not Applicable button.

{{Attention|The MetaProperty ''VALUE'' has to use [[Attributes]] in order to be validated. Otherwise, the calculation of work progress will not be possible.}}

==== Measurement Task ====

A [[MROCLS_MRO_MEASUREMENT_TASK|Measurement Task]] inherits from [[MROCLS_MRO_TASK|Task]] and documents a measured value (e.g. read from a pressure gauge). Therefore, clicking the value on the shown task opens an editor to enter the desired value. If no value was entered before, an empty line will be shown. Once a value has been entered, the task is finished. Alternatively, the task can also be closed by the option ''Not Applicable'' to document the situation of not being able to fullfill the measurement (e.g. the pressure gauge is broken). An additional small value indicator below the main value can report e.g. the previously entered value. The behaviour of this previous value indicator has to be specified separately in the customizing.
{{Clear}}

<gallery widths=497px heights=69px>
File:Measurment Task Empty UWP.png|Measurement Task without a reported value (WinX)
File:Measurment Task Not Empty UWP.png|Measurement Task with a reported value (WinX)
File:Measurment Task Empty Android.jpg|Measurement Task without a reported value (Android)
</gallery>

==== Progress Task ====

[[MROCLS_MRO_PROGRESS_TASK| Progress Task]] inherits from [[MROCLS_MRO_MEASUREMENT_TASK|Task]] and reports a certain progress while fullfilling a task. The progress will influence the overall progress of the owning workpackage. If the task cannot be fullfilled, it can also be finished with the option ''Not Applicable''.

There is also an [[MRO_PROGRESS_TASK_EDITOR|alternative editor]] available for progress tasks.{{Version/WinXSince|2.5.4}}
{{Clear}}

<gallery widths=497px heights=69px>
File:Progress Task UWP.png|Progress Task with a reported work progress (WinX)
File:Progress Task Android.jpg|Progress Task with a reported work progress and a previous progress(Android)
</gallery>

==== Check Task ====

A [[MROCLS_MRO_CHECK_TASK|Check Task]] inherits from [[MROCLS_MRO_TASK|Task]] and is finished by reporting ''Done'' or ''Not Applicable''. This is intended for a simple To-Do task that is either done or not.
{{Clear}}

<gallery widths=497px heights=69px>
File:Check Task finished UWP.png|Unfinished MRO CheckTask (WinX)
File:Check Task android.jpg|Not Applicable MRO CheckTask (Android)
</gallery>

==== Inspection Task ====

[[MROCLS_MRO_INSPECTION_TASK|Inspection Task]] inherits from [[MROCLS_MRO_TASK|Task]] and is finished, when the user reports with a positive or negative answer or ''Not Applicable'' (e.g. reporting a yes/no answer for existing equipment).
{{Clear}}

<gallery widths=497px heights=69px>
File:Finished Inspection Task UWP.png|Finished MRO InspectionTask (WinX)
File:Inspection task android.jpg|Finished MRO InspectionTask (Android)
</gallery>

==== Sequential Task ====
The [[MROCLS_SEQUENTIALTASK|sequential task classification]] allows you to pre-define a sequence in which tasks are to be resolved by users. This means that it is required for one or multiple tasks to be finished in order for other tasks to become "unlocked" and editable. A task can have any number of "predecessors". Predecessors are the tasks that are required to be finished first.

A task can have predecessors that live anywhere else in the object hierarchy. It is not necessary for a task and its predecessors to be part of the same work package, even though this is likely the most common use case.

The state of a sequential task is evaluated both offline and online to get the best possible user experience. The user will see dependent tasks update immediately if their successors were finished, if those tasks are currently visible in the UI. There is 1 case in which the server-side state will override the client-side (offline) evaluation, discussed below.
The state of each sequential task is evaluated the following way:

# If the server-side state says the task is open, we consider this as the truthful state and don't do any other evaluation.
# Check if the task has any predecessors.
# Try to load each predecessor task.
#* If loading of any predecessor fails (the object is not available offline), the task will be locked.
# If all predecessor tasks are finished, the task is open and can be edited. Otherwise, the task is locked.

The customizer setting up the task dependency relations needs to ensure that the dependencies are not cyclical. In this case, it would be impossible for any tasks in the "cycle" to be finished.

'''Example'''

As a demonstration of this feature, see [[Media:Sequential_tasks_winx.mp4|this video]]. The relations between tasks are defined as in [[Media:Task_relations.png|this image]], starting at A1 and A2, which are not dependent on any other tasks. The lines (from left to right) indicate dependencies. This means that B2 has tasks A1 and A2 as its predecessors, for example.

==== Grouped Task {{Version/WinXSince|4.2}}{{Version/XamarinSince|4.2}} ====
Sometimes, not all tasks have to be finished. More specifically, there might be a predefined condition where you only need to finish a certain number of tasks among a group of them. These are known in {{UBIK}} as [[MROCLS_GROUPEDTASK|grouped tasks]].

The idea is, a group of tasks can be defined as siblings to each other and they also share the same server configured threshold. When the number of finished tasks among that group exceeds the threshold, the entire group is considered as no longer necessary. When reflected in the overall status of the task owner(s), these tasks would appear as if they are finished.

{{Hint|Technically speaking, the finished status is completely independent from the not necessary status on a task. A grouped task which is no longer necessary can be both finished or not yet finished. In other words, users don't have to finish a not necessary grouped task, but they still can.}}

{{Hint|The precise status calculation for grouped tasks and their task owners requires the knowledge of all siblings tasks. Imagine 2 out of 3 tasks must be finished but the client only knows 1 in total and the others are only available at the server at that time. This makes it impossible to draw conclusions whether the task(s) should be necessary or not. Under such circumstances, the local status calculation is done as if these are just regular tasks.}}

{{Hint|Like with the other MRO objects, the client always chooses the best available statuses for grouped tasks to present to the users. More specifically, it uses the statuses calculated by the server when the client is not offline and there are no uncommitted local changes on the involved objects. Otherwise, it uses the statuses calculated locally to the best of its knowledge.}}

A task can also be a grouped and a sequential one at the same time. In such a case, the grouped nature of the sibling tasks will affect the way the task sequence completes.

For example, task A1, A2 and A3 are 3 grouped sibling tasks and only 1 of them needs to be finished. At the same time, they are all predecessors of task B. Normally, all predecessors must be finished (and locked) before task B becomes the next one in the sequence and therefore unlocked. In this case, however, as soon as one of the predecessors is finished, all three become unnecessary (and locked) and task B unlocks as a result of that.

==== Supervisor Task {{Version/XamarinSince|4.8}} ====
As the name suggests, supervisor tasks are those that must be finished under supervision. When users want to finish a [[MROCLS_MRO_SUPERVISOR_TASK|supervisor task]], they must hand over their work devices to a supervisor. The latter checks the work status and scans an NFC tag if the work is approved. If the [[MROCLS_MRO_SUPERVISOR|supervisor]] has sufficient permissions for the task and the correct supervisor PIN is given, the task gets unlocked and the users can proceed to finish it.

<gallery widths=300px heights=300px>
File:UI_Xamarin_Supervisor_Task_Before_Verification.jpg|Supervisor Task Before Verification/Unlocking (Mobile)
File:UI_Xamarin_Supervisor_Task_Enter_PIN.jpg|Supervisor Task Enter PIN (Mobile)
File:UI_Xamarin_Supervisor_Task_After_Verification.jpg|Supervisor Task After Verification/Unlocking (Mobile)
</gallery>

A thing to note is that while the need to verify a supervisor task can be seen as a type of locking, it's certainly not the only reason for a [[Locked_Objects|locked object]]. This means a supervisor task can remain locked (although for different reasons) even after a supervisor has successfully verified it. This can often be the case if you use it in combination with other features such as [[MRO_Objects_(Client)#Sequential_Task|sequential tasks]], [[User_Rights|user rights]].

{{Hint|For security reasons, the verification process is cancelled if the supervisor enters the wrong PIN for three times. Scanning the tag again is required in that case.}}
{{Hint|A setting controls [[RFID_tags#Choose_which_information_to_use_from_a_tag|which information in a scanned tag is used]] during this process.}}

==== Signature Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

The Signature Task is a task type that is completed by capturing a handwritten signature from the user. The task contains an editor field that serves as the entry point for the signing process. When the user clicks (or taps) on the editor field, a signature dialog opens. Within this dialog, the user can provide their signature. After confirming the input, the signature is saved and the task is automatically marked as completed.

If the task is signed while the client is online:
* The User (signee) is resolved immediately by the server and displayed.
* The ValidationTimestamp is generated and displayed.
* Both values are shown directly in the editor field after signing.

{{Hint|The User only gets resolved by the server and displayed once you're in online mode}}

If the displayed User and/or ValidationTimestamp cannot be fully shown due to limited space in the editor field, the complete information can be accessed via a tooltip.

* In '''UBIK WinX (UWP)''', hover over the editor field with the mouse.
* In '''UBIK Mobile''', perform a long press on the editor field.
A tooltip will appear, displaying the full User and ValidationTimestamp without truncation.

==== Picture Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

A [[MROCLS_PICTURE_TASK|picture task]] is a check task which can only be finished when it has at least one child document containing a valid file. In the UI, an additional photo button is presented next to the check so users can easily take photos before finishing the tasks.
* As any other objects, picture tasks can carry and display [[SYSCLS_CHILDINFOOWNER|child count information]]. But that is not a mandatory part of the feature. Even when it's not configured and not visible in the UI, you can still finish the tasks.
* In WinX/UWP, the UI also presents an expander which allows you to display the child documents of picture tasks. This is not present by default in the Mobile app due to the screen size limit but [[Object_hierarchy_in_XAML:_NextLevel,_ParentLevel,_LinkedLevel#Show_NextLevel_Children.2FDocuments|can be easily customized]].

{{Hint|The task is named as such because pictures are the most commonly used types, but the child documents can be of other types as well. }}

When a user tries to finish a picture task by tapping the check, the app might perform some data synchronization first if in online mode, which includes
* Syncing the child objects (including documents) of the task.
* Downloading the file(s) of the child documents.
During data synchronization, the check button on that task turns into a wait indicator. Afterwards, the app checks if the prerequisites to finish the task are met.
* If there are no child documents or no local files for the child documents, the task remains unfinished and the user gets informed about the reasons.
* Otherwise, the task gets finished and the photo button gets disabled.

{{Hint|Setting NA (not applicable) on a picture task is always possible, regardless of the condition of child documents.}}

{{UnderConstructionStart}}
==== Numeric Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

A [[MROCLS_MRO_NUMERIC_TASK|numeric task]] is a task which records a double value (e.g. from a temperature sensor). Entering the value (including Not Applicable) completes the task.
* The value is compared against an accaptable value range which is not editable on the client.
* Deviation from this range results in visual feedback as well as the [[#Tech Status|tech status]] being set to display an issue.
* If the configured value range is invalid (e.g. min > max) and the user enters a value, the [[#Tech Status|tech status]] will also be set to display an issue.
* A numeric task also has a special value unit that can be set per task instance. If set, it overrides the standard value unit defined on the [[MetaProperty#Unit_Item|MetaProperty]].
{{UnderConstructionEnd}}

{{UnderConstructionStart}}
==== Pick List Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

A [[MROCLS_PICK_LIST_TASK|Pick List task]] looks and behaves the same like a standard Integer Task with SelectiveList. Other than the standard Integer Task, the Pick List Task has an [[UBIK_Active_Lists|Active List]] defined on instance level to pick from for its value property. The task counts as finished as soon as a list item has been selected, or when pressing ''Not Applicable''.
{{UnderConstructionEnd}}

[[Category:Android|MRO Objects (UBIK WinX)]]
[[Category:Client|MRO Objects (Client)]]
[[Category:Mobile|MRO Objects (Client)]]
[[Category:Pages with broken file links|MRO Objects (Client)]]
[[Category:WinX|MRO Objects (UBIK WinX)]]

=== MRO objects with project information (WinX only) {{Version/WinXSince|2.5.4}} ===
[[File:UI_WinX_MRO_ProjectInfo.png|thumb|MRO Object with Project Info (WinX)]]
An MRO object (except tasks) might also bring along [[MROCLS_PROJECTINFORMATION|project information]]. In this case, the project information together with the MRO progress are displayed in a bar chart. The start & end dates of the MRO object are displayed on the progress bar. The length and the position of the progress bar, together with the current date mark indicate the timeline.
{{Clear}}

== Locking ==
When an (MRO) object is locked, editing it becomes impossible. More details about [[Locked_Objects|locked objects]].

== See also ==
* [[MRO (Plugin)]]
* [[MROCLS_PROJECT]]
* [[MROCLS_PROJECTINFORMATION]]
* [[MROCLS_SEQUENTIALTASK]]
* [[MROCLS_GROUPEDTASK]]
* [[MROCLS_MRO_CHECK_TASK]]
* [[MROCLS_MRO_INSPECTION_TASK]]
* [[MROCLS_MRO_MEASUREMENT_TASK]]
* [[MROCLS_MRO_PROGRESS_TASK]]
* [[MROCLS_MRO_TASK]]
* [[MROCLS_MRO_TASKOWNER]]
* [[MROCLS_MRO_WORKPACKAGE]]
* [[MROCLS_PROCEDURE#Procedure Workpackage]] (Classification)
* [[MROCLS_SWITCH_TASK#Switch Task]] (Classification)
* [[MROCLS_SWITCH_END_TASK#Switch End Task]] (Classification)
* [[MROCLS_CALCULATION_TASK#Calculation Task]] (Classification)

[[Category:Android|MRO Objects (UBIK WinX)]]
[[Category:Client|MRO Objects (Client)]]
[[Category:Mobile|MRO Objects (Client)]]
[[Category:Pages with broken file links|MRO Objects (Client)]]
[[Category:WinX|MRO Objects (UBIK WinX)]]

MROCLS PICK LIST TASK

2026-04-20T09:04:12Z

CWI:

{{ClassificationInfoBox
| title = Pick list classification object
| name = {{PAGENAMEE}}
| inheritance = [[MROCLS_MRO_TASK]]
| namespace = MRO.Classification
| purpose = Classify tasks as pick list tasks
| version = 5.0.0
| id = {AC61934E-DDFD-4FAE-A28F-2F19EE70E0EE}
}}

Classifies an object as a Pick List Task.
A Pick List Task needs a predefined [[UBIK_Active_Lists|Active List]] to pick from for its value property. The task counts as finished as soon as a list item has been selected. Each List item needs an integer value assigned to it. The value 0 is reserved for the server since it is used to provide a reopening functionality for the task.

== MetaProperties ==
{| class="wikitable" width=50%
|-
! width=30% | Name !! width=20% | Data type !! Comment
|-
| VALUE || {{Integer}} || Selected item (Undefined = 0)
|}

== See also ==
* [[MROCLS_MRO_TASKOWNER#Task Owner]] (Classification)
* [[MROCLS_MRO_TASK#Task]] (Classification)
* [[MROCLS_MRO_MEASUREMENT_TASK#Measurement Task]] (Classification)
* [[MROCLS_MRO_PROGRESS_TASK# Progress Task]] (Classification)
* [[MROCLS_MRO_CHECK_TASK#Check Task]] (Classification)
* [[MROCLS_MRO_INSPECTION_TASK#Inspection Task]] (Classification)
* [[MROCLS_MRO_WORKPACKAGE#Work Package]] (Classification)
* [[MROCLS_SEQUENTIALTASK#Sequential Task]] (Classification)
* [[MROCLS_SWITCH_TASK#Switch Start Task]] (Classification)
* [[MROCLS_SWITCH_END_TASK#Switch End Task]] (Classification)
* [[MRO_Objects_(Client)#Work_Package]]
* [[MRO_(Plugin)#Work_Package]]
* [[MROCLS_PROCEDURE#Procedure Workpackage]] (Classification)
* [[MROCLS_CALCULATION_TASK#Calculation Task]] (Classification)
* [[UBIK_Active_Lists]]
* [[Active_List_Client]]

[[Category:Classifications|MROCLS PICK LIST TASK]]
[[Category:Plugin|MROCLS PICK LIST TASK]]

Converters In Mobile

2026-04-20T08:48:31Z

CWI: /* List of Available Converters */

'''Converters''' are used to prepare application data to format a UI defined by a XAML markup. These converters make it possible to show elements only when specific conditions (like data being available) are met. This allows the creation of a good UI with XAML code only, improving code readability while also decreasing code complexity.

This page explains how to properly use converters for customizing the UBIK Mobile User Interface. Furthermore, all available converters are listed to provide a good reference.

= Definition =
In Mobile clients, before converters can be used, they need to be defined in the page's ''Resources'' tag. Make sure to include the <code>UBIK.CPL.Converters</code> namespace in the namespace definitions!
The following example shows how the <code>NullToBoolConverter</code> can be defined:
<syntaxhighlight lang="xml">
Mobile(Xamarin):

<ContentView x:Class="UBIK.CPL.Resources.UBIKChildArea"
xmlns="http://xamarin.com/schemas/2014/forms"
xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
xmlns:converters="clr-namespace:UBIK.CPL.Converters;assembly=UBIK.CPL">
<ContentView.Resources>
<ResourceDictionary>
<converters:NullToBoolConverter x:Key="NullToBool" />
</ResourceDictionary>
</ContentView.Resources>



</ContentView>
</syntaxhighlight>
The key ''NullToBool'' makes this converter accessible from the customizing in this page.
== Definition With Properties ==
In the following example, which is the same example from above, the '''StringFormatConverter''' will be additionally defined. To add more formatting possibilities, it has two extra properties, which need to be prefilled during initialization. Henceforth, these properties can be prefilled with static values or with static references.
<syntaxhighlight lang="xml">
Mobile(Xamarin):

<ContentView x:Class="UBIK.CPL.Resources.UBIKChildArea"
xmlns="http://xamarin.com/schemas/2014/forms"
xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
xmlns:converters="clr-namespace:UBIK.CPL.Converters;assembly=UBIK.CPL">
<ContentView.Resources>
<ResourceDictionary>
<converters:NullToBoolConverter x:Key="NullToBool" />
<converters:StringFormatConverter x:Key="Formatter" Parameter1="5" Parameter2="{Binding Children.Items.Count}" />
</ResourceDictionary>
</ContentView.Resources>



</ContentView>
</syntaxhighlight>
Whereever this converter is used within the file it was defined in, ''Formatter'' will always have its ''Parameter1'' set to ''5'' and its ''Parameter2'' to the number of children of the currently viewed UBIK object. If this behavior is not intended, consider defining another ''StringFormatConverter'' with a '''different Key''' in the same way as shown above.<br/>
See below to find out how to use this converter!
= Usage =
A converter can only be used in conjunction with a <code>{Binding}</code>. The following is an easy example, showing how the ''NullToBool'' converter, defined above, can be used.
<syntaxhighlight lang="xml">
<Label Text="My Text" IsVisible="{Binding MyBindableProperty, Converter={StaticResource NullToBool}}"/>
</syntaxhighlight>
If '''MyBindableProperty''' is ''null'' or an empty string, the converter will return '''true''', making the Label visible!
== Parameter ==
Some converters accept a '''ConverterParameter''', that passes additional information. Closely read the description of the available converters to find out which accept or even require a parameter to work properly. In Ubik, some converters accept a string parameter, consisting of multiple individual parameters separated by <code>|</code>.

An example of this behavior is the '''ContainsToBoolConverter''', which checks if the current value is contained within a collection of values (passed as the ''parameter''):
<syntaxhighlight lang="xml">
<Label Text="My Text" IsVisible="{Binding MyValue, Converter={StaticResource ContainsToBool}, ConverterParameter=1|2|3|4|5|6|7|8|9}"/>
</syntaxhighlight>
The label will only be visible if the ''MyValue'' property (which is expected to parse as an Integer in this example) is one of the values of the parameter.<br/>
Again, to get the converter working, don't forget to define it in the page's resources!

== FallbackValue ==
In some rare cases, a converter might not return anything desired (like ''null'') if some condition doesn't work out as it should (e.g. ''value'' is ''null''). To still be able to get a usable return value, it's possible to define a '''FallbackValue'''.

== Example Usage of StringFormatConverter ==
This converter can take up to two additional parameters during definition. Please see [[#Definition With Properties|Definition With Properties]] for more information!
<syntaxhighlight lang="xml">
<Label Text="{Binding MyValue, Converter={StaticResource Formatter}, ConverterParameter=The Value of my value is \{0\}\, compared to \{1\} and \{2\}!}"/>
</syntaxhighlight>
It's important to note that special characters, like <code><nowiki>{</nowiki></code>, <code><nowiki>}</nowiki></code> and <code><nowiki>,</nowiki></code>, need to be escaped using a <code><nowiki>\</nowiki></code>, else the expression will be wrongly interpreted (and nothing happens)!

The text of the '''ConverterParameter''' will be analyzed, and any occurrance (including duplicates) of <code><nowiki>{0}</nowiki></code>, <code><nowiki>{1}</nowiki></code> and <code><nowiki>{2}</nowiki></code> replaced with the '''binding value''', '''Formatter.Parameter1''' and '''Formatter.Parameter2''' respectively!

Make sure to note, that Maui has a native '''[https://learn.microsoft.com/en-us/dotnet/maui/fundamentals/data-binding/string-formatting?view=net-maui-9.0 string formatting]''' option as well, that is probably way faster than using a converter for it. Furthermore, it supports formatting options!

= Data Source =
Although technically not a converter, the '''SfDataSourceExt''' control is currently on the way of replacing the '''SfDataSourceConverter''', due to improved performance.
The usage is pretty simple: Similar to the converters, it needs to be defined in the '''Page Resources'''. Then, a '''Key''' and '''Expression''', as well as an '''ItemsSource''' have to be defined. Last, but not least, the the converter can be used within the '''ItemsSource''' property of a Syncfusion '''SfListView'''. See the following example:
<syntaxhighlight lang="xml">
Mobile(Xamarin):

<ContentView x:Class="UBIK.CPL.Resources.UBIKChildArea"
xmlns="http://xamarin.com/schemas/2014/forms"
xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
xmlns:controls="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL">
<ContentView.Resources>
<ResourceDictionary>
<controls:SfDataSourceExt
x:Key="MyDataSource"
ItemsSource="{Binding Children.Items}"
Expression="Item.Content.MetaUID.ToString().ToLower()=="85a50533-3817-4a0b-84cd-615b48b62565" && Item["ORGA_STATUS"]!=100" />
</ResourceDictionary>
</ContentView.Resources>
<sync:SfListView
x:Name="ListView1"
AllowSwiping="True"
ItemSize="60"
ItemTemplate="{StaticResource ChildTemplateSelector}"
ItemsSource="{Binding DisplayItems, Source={StaticResource MyDataSource}}"
LeftSwipeTemplate="{StaticResource SwipeLeftTemplateSelector}"
RightSwipeTemplate="{StaticResource SwipeRightTemplateSelector}"
SelectionMode="None">
</ContentView>
</syntaxhighlight>
Thanks to the given expression, filtering is applied once the data source is evaluated. It's important to have [https://www.advancedinstaller.com/user-guide/xml-escaped-chars.html XML special characters] correctly escaped, like the example shows.

= List of Available Converters =
The following list contains all currently available converters for UBIK Mobile customizing.

'''Two-way''' converters can be used with two-way bindings, e.g. a text-box displaying an editable value. If the value updates in the model, the text-box text changes. If the user edits the value, the value in the model behind also gets updated.
As a clarification, '''Value''' refers to the '''Binding Value''', and '''parameter''' to the '''ConverterParameter'''!

{| class="wikitable sortable" style="width:100%"
|-
! Converter !! 2-Way !! Output Type || Input Type || Parameter Type || Description
|-
| BooleanConverter || style="text-align: center;" | ✓ || Boolean || Boolean, String || ||
Interprets a '''boolean value''' or a '''String value''' and returns it. If the value cannot be interpreted, ''false'' is returned.
|-
| BooleanInvertConverter || style="text-align: center;" | ✓ || Boolean || Boolean, String || ||
Interprets a '''boolean value''' or a '''String value''' and converts it into its '''inverted value'''. If the value cannot be interpreted, ''false'' is returned.
|-
| BooleanToFontAttributeConverter || style="text-align: center;" | ✗ || FontAttribute || Boolean || ||
Converts a '''boolean''' into a '''[https://docs.microsoft.com/en-us/dotnet/api/xamarin.forms.fontattributes?view=xamarin-forms font attribute]''' value. In detail, if the value is ''true'', the parameter is interpreted (''Bold'', ''Italic'', ''None'') and returned. The default returned font-attribute is ''None''.
|-
| ByteToImageSourceValueConverter || style="text-align: center;" | ✗ || ImageSource || Byte[ ],<br/>Byte Stream || ||
Converts a '''byte stream''' value into an '''image source'''.
|-
| ChildAreaTemplateConverter || style="text-align: center;" | ✗ || Child<wbr/>Area<wbr/>Template || Content<wbr/>ViewModel || ||
Returns a '''ChildAreaTemplate''' from a '''Content<wbr/>ViewModel''' or ''null'' if the ViewModel cannot be interpreted.
|-
| ChildItem<wbr/>SelectionMode<wbr/>To<wbr/>SfListView<wbr/>SelectionMode<wbr/>Converter || style="text-align: center;" | ✓ || [https://help.syncfusion.com/cr/cref_files/xamarin/Syncfusion.SfListView.XForms~Syncfusion.ListView.XForms.SfListView~SelectionMode.html ListView<wbr/>SelectionMode] || ChildItem<wbr/>SelectionMode || ||
Converts a '''ChildItem<wbr/>SelectionMode''' to a Syncfusion '''[https://help.syncfusion.com/cr/cref_files/xamarin/Syncfusion.SfListView.XForms~Syncfusion.ListView.XForms.SfListView~SelectionMode.html ListView<wbr/>SelectionMode]'''. Default is "Single".
|-
| ClassificationToBoolConverter || style="text-align: center;" | ✗ || Boolean || ContentViewModel || ||
Returns a '''boolean''' indicating whether the given '''ContentViewModel''' is successfully classified.
|-
| ContainsToBoolConverter || style="text-align: center;" | ✗ || Boolean || String,<br/>Guid,<br/>Object || ||
Checks if the delivered value is '''contained''' within a collection of values (delivered in the parameter, seperated with <code><nowiki>|</nowiki></code>). If the value is contained, ''true'' will be returned, else ''false''. The functionality is similar to the ''ContainsToVisibilityConverter'' in the WinX project.
|-
| ContainsToInvertedBoolConverter || style="text-align: center;" | ✗ || Boolean || String,<br/>Guid,<br/>Object || ||
Same as the ''ContainsToBoolConverter'', but with '''inverted output'''.
|-
| ContentAreaTeamplateConverter || style="text-align: center;" | ✗ || UBIKContentArea || ContentViewModel || || This converter is '''not yet finished''' and just returns the ''UBIKContentArea'' if the value is a ''ContentViewModel''.
|-
| StringToDateTimeTypesConverter || style="text-align: center;" | ✓ || [https://docs.microsoft.com/en-us/dotnet/api/system.datetime DateTime], [https://docs.microsoft.com/en-us/dotnet/api/system.timespan TimeSpan] || String || ||
Converts a String to the correct DateType, which can be either '''[https://docs.microsoft.com/en-us/dotnet/api/system.datetime DateTime]''' or '''[https://docs.microsoft.com/en-us/dotnet/api/system.timespan TimeSpan]'''. If the value cannot be interpreted, the unchanged String value is returned. The Converter can also be used to convert DateTime or TimeSpan into a string. The Format will be determined by the current culture.
|-
| DateTimeOffsetToDateConverter || style="text-align: center;" | ✓ || [https://docs.microsoft.com/en-us/dotnet/api/system.datetime DateTime] || [https://docs.microsoft.com/en-us/dotnet/api/system.datetimeoffset DateTimeOffset] || ||
Converts a '''[https://docs.microsoft.com/en-us/dotnet/api/system.datetimeoffset DateTimeOffset]''' to the correct '''[https://docs.microsoft.com/en-us/dotnet/api/system.datetime DateTime]''', applied to the current date and time. If the value cannot be interpreted, a new ''DateTime'', generated from the device's current time (<code>DateTime.Now</code>) is returned.
|-
| DateTimeToFromNowStringConverter || style="text-align: center;" | ✗ || String || [https://docs.microsoft.com/en-us/dotnet/api/system.datetime DateTime] || ||
Returns a '''[https://docs.microsoft.com/en-us/dotnet/api/system.datetime DateTime]''' into a human-readable and easily understandable ''string message'' (the last applying one will be taken):
* Less than 5 minutes in the past: ''Just now''
* Less than 10 minutes in the past: ''A few minutes ago''
* Less than 1 hour in the past: ''An hour ago''
* Less than 23 Hours in the past: ''Some hours ago''
* Less than 1 day in the past: ''Yesterday''
* More than 1 day in the past: The ''DateTime'' value formatted according to the device's localization rules.
* Not interpretable: ''???''
|-
| DebugConverter || style="text-align: center;" | ✓ || Object || Object || ||
A converter returning the given value for '''debug reasons'''.
|-
| DistanceToStringConverter || style="text-align: center;" | ✗ || String || Double || ||
Returns the given value interpreted as '''length'''. Values are returned in kilometers with two comma digits (e.g. 2.84km), values smaller than 1km are returned as meters and ''NaN'' will be returned as ''infinity''. If the value cannot be interpreted, an empty string will be returned.
|-
| EqualityToBoolConverter || style="text-align: center;" | ✗ || Boolean || Object,<br/>String || Object,<br/>String ||
Returns ''true'' if the given value and parameter are '''equal to each other''', ''false'' otherwise.
|-
| EqualityToInvertedBoolConverter || style="text-align: center;" | ✗ || Boolean || Object,<br/>String || Object,<br/>String ||
Returns ''true'' if the given value and parameter are '''not equal to each other''', ''false'' otherwise.
|-
| SelectionChangedEventArgsConverter || style="text-align: center;" | ✗ || [https://docs.microsoft.com/en-us/dotnet/api/system.windows.controls.selectionchangedeventargs List<wbr/>Selection<wbr/>Changed<wbr/>EventArgs] || [https://help.syncfusion.com/cr/cref_files/xamarin/Syncfusion.SfListView.XForms~Syncfusion.ListView.XForms.ItemSelectionChangedEventArgs.html Item<wbr/>Selection<wbr/>Changed<wbr/>EventArgs] || ||
Converts an Syncfusion '''[https://help.syncfusion.com/cr/cref_files/xamarin/Syncfusion.SfListView.XForms~Syncfusion.ListView.XForms.ItemSelectionChangedEventArgs.html Item<wbr/>Selection<wbr/>Changed<wbr/>EventArgs]''' to a '''[https://docs.microsoft.com/en-us/dotnet/api/system.windows.controls.selectionchangedeventargs List<wbr/>Selection<wbr/>Changed<wbr/>EventArgs]'''. <br/>The use-case of this converter is highly specific.
|-
| FilterCriterionToValueConverter || style="text-align: center;" | ✓ || String || FilterCriterion || ||
Converts a [[Property_Based_Content_Filters|'''FilterCriterion''']] to its value. The functionality is similar to UWP's FilterCriterionToValueConverter.
|-
| GuidPropertyValueConverter || style="text-align: center;" | ✓ || String || Guid || Binding, where source is ContentViewModel ||
Returns the '''first item''' of the parameter's ''Source-ViewModel'' that '''matches the given GUID''' value. If none is found, ''null'' is returned.
|-
| IntToColorConverter || style="text-align: center;" | ✗ || Color || Integer || ||
Converts an ARGB '''integer''' value to a '''color'''. If the value cannot be interpreted, the converter tries to parse the parameter as a ''color'' to return it. If everything fails, ''transparent'' is returned.
|-
| ItemCountToBoolConverter || style="text-align: center;" | ✗ || Boolean || Integer || Integer ||
This converter has a '''property''' to set the '''boolean return value''', called ''LesserOrEqualReturnValue''. This property-value will be returned if the given value is '''smaller than or equal to''' the threshold (parameter, defaults to 0). If the value is '''bigger than''' the threshold, the '''inverted''' ''LesserOrEqualReturnValue'' will be returned.<br/>
In any other case (like the value cannot be interpreted), ''false'' is returned, so it's a good idea to set the converter's property in a way that the return is only ''true'' if you need it.
|-
| ItemCountToOverflowConverter || style="text-align: center;" | ✗ || String || Integer || Integer || Creates a '''human-readable text''' indicating '''how many items are available'''. The value will be interpreted as the '''total item count''' and the parameter as '''overflow threshold''' (defaults to 99). <br/>If there are more items than the overflow, the overflow value with a + sign will be returned (e.g. 99+). If not, the value itself will be returned. If everything fails, ''null'' is returned.
|-
| NullToBoolConverter || style="text-align: center;" | ✓ || Boolean || Object,<br/>String|| ||
''Null'' or an '''empty string''' value get converted to ''true'', and everything else to ''false''.
|-
| NullToInvertedBoolConverter || style="text-align: center;" | ✓ || Boolean || Object,<br/>String || ||
''Null'' or an '''empty string''' value get converted to ''false'', and everything else to ''true''.
|-
| PathToImageSourceValueConverter || style="text-align: center;" | ✗ || Image Source || String || ||
Reads the '''path''' provided as parameter and creates an '''image source''' from it.
|-
| PercentageToProgressConverter || style="text-align: center;" | ✗ || Double || Integer,<br/>Double || ||
The '''numeric value''' (int or double), interpreted as '''percentage from 0 to 100''', get converted to a '''progress level''' (0 to 1). Values outside this range will be contained.
|-
| PropertyNameExistsToBoolConverter || style="text-align: center;" | ✗ || Boolean (Nullable) || ContentViewModel,<br/>IContent || ||
Converts a property to a '''boolean''' based on its '''existence'''. If it exists, ''true'' will be returned, else ''false'' or ''null'' (if something couldn't be properly interpreted).
|-
| PropertyNameExistsToInvertedBoolConverter || style="text-align: center;" | ✗ || Boolean (Nullable) || ContentViewModel,<br/>IContent || ||
Converts a property to a '''boolean''' based on its '''existence'''. If it exists, ''false'' will be returned, else ''true'' or ''null'' (if something couldn't be properly interpreted).
|-
| RootAreaTemplateConverter || style="text-align: center;" | ✗ || ContentView || Object || ||
If the provided value is '''not null''', the '''UBIKRootArea template''' will be returned.
|-
| SelectiveItemToValueConverter || style="text-align: center;" | ✓ || Boolean,<br/>String,<br/>Integer,<br/>Double,<br/>DateTime,<br/>Guid,<br/>FileReferenceData,<br/>GeoData,<br/>Object || Boolean,<br/>String,<br/>Integer,<br/>Double,<br/>DateTime,<br/>Guid,<br/>FileReferenceData,<br/>GeoData,<br/>Object || Binding, where source is ContentViewModel ||
Converts a '''item''' of a '''selective list''' to its value. If none is found, the passed ''value'' will be returned.
|-
| SelectiveListToItemsConverter || style="text-align: center;" | ✗ || List of PropertyItems || IPropertyItem || ||
Returns all items from a selective list. The converter can only be used in combination with a standard MetaProperty level [[SELECTIVELIST|SelectiveList]], not with an instance level [[Active_List_Client|Active list]].
|-
| SfDataSourceConverter || style="text-align: center;" | ✗ || DataSource (for ListView) || Double || String (Expression) ||
It's an advanced converter used for '''loading items''' and '''applying filters''' on it. It replaces to ''CollectionToViewConverter'' from the WinX.UWP project. The data source can be directly used with a ''[https://help.syncfusion.com/xamarin/sflistview/overview SfListView]''.<br/><br/>
'''This converter is obsolete!'''<br/>Use '''SfDataSourceExt''' (see [[#Data Source|Data Source]]) instead!
|-
| StringContainsToBoolConverter || style="text-align: center;" | ✗ || Boolean || String || String ||
Returns a '''boolean''' indicating whether the parameter string is included in the value string.
|-
| StringContainsToInvertedBoolConverter || style="text-align: center;" | ✗ || Boolean || String || String ||
Same as the ''StringContainsToBoolConverter'' but with '''inverted output'''.
|-
| StringFormatConverter || style="text-align: center;" | ✗ || String || Object || String || Allows the creation of a '''nicely formatted ''string'' message''', similar to [https://docs.microsoft.com/en-us/dotnet/api/system.string.format C#'s String.Format method].<br/>The value will be interpreted as the <code><nowiki>{0}</nowiki></code> element, and the parameter is the template string (e.g. <code><nowiki>The total count is: {0}!</nowiki></code>. Up to two additional parameters, named ''Parameter1'' and ''Parameter2'', can be defined at the converter declaration. Adding formatting options to the <code><nowiki>{0}</nowiki></code> notation is not possible.<br/><br/>
'''Attention''', using the native '''[https://docs.microsoft.com/en-us/xamarin/xamarin-forms/app-fundamentals/data-binding/string-formatting StringFormat]''' option is not only faster, but it also offers more customizability of the value!<br/>
You might still want to use the ''StringFormatConverter'' in rare cases, though!
|-
| ToStringFormatConverter || style="text-align: center;" | ✗ || String || Double,<br/>Float,<br/>Integer,<br/>DateTime,<br/>String || String || Converts '''primitives''' or '''[https://docs.microsoft.com/en-us/dotnet/api/system.datetime DateTime]''' to string and allows the application of '''[https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings formatting options]''' (as parameter). <br/>Adding a <code>.</code> to the end of the format-parameter allows '''[https://docs.microsoft.com/en-us/dotnet/api/system.math.truncate truncation]''' of all decimal places.
|-
| TypeNameToBoolConverter || style="text-align: center;" | ✗ || Boolean || Object || String || Returns ''true'' if the type name of the value is present in the parameter-string (seperated by <code><nowiki>|</nowiki></code>).
|-
| TypeNameToInvertedBoolConverter || style="text-align: center;" | ✗ || Boolean || Object || String || Inverted ''TypeNameTo<wbr/>BoolConverter''.
|-
| DataTemplateItemTemplateSelectorConverter || style="text-align: center;" | ✗ || ChildItem<wbr/>Template<wbr/>Selector || String || String || Chooses what '''ChildItem<wbr/>Template<wbr/>Selector''' to return. Having a parameter with the content "Small" returns the small item template selector.
|-
| DataTemplateItemsPanelConverter || style="text-align: center;" | ✗ || ItemsPanelTemplate || Query<wbr/>Details<wbr/>Page<wbr/>ViewModel || || Chooses what '''ItemPanel<wbr/>Template''' to return. Having a parameter with the content "Small" returns the small item template selector.
|}

[[Category:Client|Converters In Xamarin]]
[[Category:Mobile|Converters In Xamarin]]
[[Category:XAML|Converters In Xamarin]]

= See also =
[[XAML#Converters|Converters in UWP/WinX]]

[[Category:Client | XAML | Xamarin]]

[[Category:Client|Converters In Xamarin]]
[[Category:Mobile|Converters In Xamarin]]
[[Category:XAML|Converters In Xamarin]]

MROCLS PICK LIST TASK

2026-04-15T12:40:04Z

CWI: /* See also */

{{ClassificationInfoBox
| title = Pick list classification object
| name = {{PAGENAMEE}}
| inheritance = [[MROCLS_MRO_TASK]]
| namespace = MRO.Classification
| purpose = Classify tasks as pick list tasks
| version = 5.0.0
| id = {AC61934E-DDFD-4FAE-A28F-2F19EE70E0EE}
}}

Classifies an object as a Pick List Task.
A Pick List Task needs a predefined List to pick from for its value property. The task counts as finished as soon as a list item has been selected. Each List item needs an integer value assigned to it. The value 0 is reserved for the server since it is used to provide a reopening functionality for the task.

== MetaProperties ==
{| class="wikitable" width=50%
|-
! width=30% | Name !! width=20% | Data type !! Comment
|-
| VALUE || {{Integer}} || Selected item (Undefined = 0)
|}

== See also ==
* [[MROCLS_MRO_TASKOWNER#Task Owner]] (Classification)
* [[MROCLS_MRO_TASK#Task]] (Classification)
* [[MROCLS_MRO_MEASUREMENT_TASK#Measurement Task]] (Classification)
* [[MROCLS_MRO_PROGRESS_TASK# Progress Task]] (Classification)
* [[MROCLS_MRO_CHECK_TASK#Check Task]] (Classification)
* [[MROCLS_MRO_INSPECTION_TASK#Inspection Task]] (Classification)
* [[MROCLS_MRO_WORKPACKAGE#Work Package]] (Classification)
* [[MROCLS_SEQUENTIALTASK#Sequential Task]] (Classification)
* [[MROCLS_SWITCH_TASK#Switch Start Task]] (Classification)
* [[MROCLS_SWITCH_END_TASK#Switch End Task]] (Classification)
* [[MRO_Objects_(Client)#Work_Package]]
* [[MRO_(Plugin)#Work_Package]]
* [[MROCLS_PROCEDURE#Procedure Workpackage]] (Classification)
* [[MROCLS_CALCULATION_TASK#Calculation Task]] (Classification)
* [[UBIK_Active_Lists]]

[[Category:Classifications|MROCLS PICK LIST TASK]]
[[Category:Plugin|MROCLS PICK LIST TASK]]

Multi Select (UBIK Client)

2026-04-14T09:53:27Z

CWI: /* Editing common properties of selected items (UWP only) */

The Multi Select mode aims to improve the efficiency of performing actions on a large number of selected objects (Mobile & UWP), as well as changing property values for a large number of selected objects (UWP only). Editing property values for a large number of objects was known in some previous UWP versions as Mass Editing. Currently, the Multi Select mode is available for lists of children (including task and query objects) and documents.

== Activating the multi select mode ==

<tabs>
<tab name="UWP">
Clicking on a Multi Select button, which will appear when hovering over a list, activates the Multi Select mode. A panel at the left side gets displayed.
</tab>

<tab name="Mobile">
The Multi Select mode gets enabled by holding (long tapping) an item. As soon as it is active, a panel on the bottom gets displayed.
</tab>
</tabs>

In XAML code, you can use <code>ListViewModel.BulkOperation.ToggleMultiSelectCommand</code> to (de)activate the multi select mode.

== Multi select panel ==

<tabs>
<tab name="UWP">
The header displays the count of the currently selected items and three buttons.
The first one is for selecting all items, the second for deselecting all items at one click. The {{key press|x}} button closes the panel and deactivates the Multi Select mode.
Further, the panel contains two tabs.
The "properties" tab displays all common editable properties of the selected items. If none are selected, or if the selected items don't share any common properties, it will remain empty.
The "other options" tab contains buttons to perform actions on all selected items.
</tab>

<tab name="Mobile">
The Multi Select panel in the Mobile client is located at the bottom.
It displays the count of selected items, command buttons for Copy, Discard, Delete and Download actions and a close button to deactivate the Multi Select mode.
</tab>
</tabs>

[[File:UBIKWinXUI_MultiSelect1.JPG|thumb|Multi Select mode (UWP)]]

{{Hint|Note: Please only use the buttons in the Multi Select Panel to perform actions on the selected objects. Others, like content area / context menu button actions are still related to the content page and do not work for the selected objects.}}

For the current usecase and the standard client, the Multi Select mode can be activated for Document and Children objects in parallel, hence when activating the Multi Select mode in the Children tab and then switching to Documents tab, it is possible to enable a separate Multi Select panel there.

By navigating away from the related content page, all active Multi Select modes get deactivated automatically.

== Selection ==

[[File:UBIKCPLXUI_MultiSelect1.JPG|thumb|Multi Select mode (Mobile)]]

By default, all objects are deselected when the Multi Select Mode gets invoked. Items can be selected by tapping on them. Therefore, navigating into an object in the list by tapping on it is no longer available. To be able to navigate again, the Multi Select mode needs to be turned off.

To select or deselect all items, <code>ListViewModel.BulkOperation.SelectAllCommand</code> or <code>ListViewModel.BulkOperation.DeselectAllCommand</code> can be used as command binding. These options are currently not presented in the standard Mobile UI.

In UWP, there are some additional selection related options besides "Select All" and "Deselect All". Selecting or deselecting a bunch of items in a row can be achieved by holding shift and first clicking on the first required item and then clicking on the last required item.

== Performing actions on selected items ==

The following actions are currently available in Multi Select mode:
* Copy / Paste
* Download Branches
* Discard Content
* Delete Content
* Download and Checkout (*)
* Checkout (*)
* Release (*)
* Revert local changes (*)

Actions marked with (*) are currently not presented in the standard Mobile UI. But they can be easily customized in XAML code with the following commands.

=== Copy and paste ===
To copy multiple branches, the <code>ListViewModel.BulkOperation.CopyBranchesCommand</code> can be used without any additional CommandParameters.
The <code>ContentViewModel.PasteBranchCommand</code> already supports pasting multiple branches, therefore, it can be used to paste the previously copied objects. To clarify, the UI (Mobile & UWP) does not include pasting content into the selected objects, rather pasting multiple, previously copied branches into one object. This can be done eg. via the Paste option in the Context Menu.

=== Download branches ===
To download multiple branches, <code>ListViewModel.BulkOperation.InvokeOnItemsCommand</code> with a KeyValueList containing <code>Key="Command"</code> and <code>Value="BranchDownloadCommand"</code> as CommandParameter can be used.

=== Discard content ===
To discard selected objects, <code>ListViewModel.BulkOperation.InvokeOnItemsCommand</code> with a KeyValueList containing <code>Key="Command"</code> and <code>Value="DiscardContentCommand"</code> as CommandParameter can be used.

=== Delete content ===
To delete selected objects, <code>ListViewModel.BulkOperation.InvokeOnItemsCommand</code> with a KeyValueList containing <code>Key="Command"</code> and <code>Value="DeleteContentCommand"</code> as CommandParameter can be used.

=== Download and checkout ===
This can be achieved by using the command for downloading, just with an additional KeyValueParameter to set the <code>Key="CheckOut"</code> to "True" as CommandParameter:
<source lang = "xml">
<Button ... Command="{Binding ListViewModel.BulkOperation.InvokeOnItemsCommand}">
<Button.CommandParameter>
<controls:KeyValueList>
<controls:KeyValueParameter Key="Command" Value="BranchDownloadCommand" />
<controls:KeyValueParameter Key="CheckOut" Value="True" />
</controls:KeyValueList>
</Button.CommandParameter>
</Button>
</source>

=== Checkout ===
To checkout selected objects, <code>ListViewModel.BulkOperation.InvokeOnItemsCommand</code> with a KeyValueList containing <code>Key="Command"</code> and <code>Value="CheckOutContentCommand"</code> as CommandParameter can be used.

=== Release ===
To release selected objects, <code>ListViewModel.BulkOperation.InvokeOnItemsCommand</code> with a KeyValueList containing <code>Key="Command"</code> and <code>Value="ReleaseContentCommand"</code> as CommandParameter can be used.

=== Revert local changes ===
To revert local changes on objects, <code>ListViewModel.BulkOperation.InvokeOnItemsCommand</code> with a KeyValueList containing <code>Key="Command"</code> and <code>Value="RevertLocalChangesCommand"</code> as CommandParameter can be used.

== Editing common properties of selected items (UWP only) ==

When selecting or deselecting objects, the commonly shared properties on the left side are constantly updated during that process.

{{Hint|For such a property, if all selected objects share the same property value, that value is displayed as it is; Otherwise, "..." is displayed to indicate the presence of various values.}}

Once a user clicks/taps on such a property, an editor dialog is shown and the user can enter values just like when editing properties of single objects. However, when the user finishes editing and confirms the dialog, the value is saved to that property of all selected objects immediately.

{{Hint|If the property being edited has various values, a default value (instead of the actual ones) is shown in the editor. E.g. empty for string type, false for boolean type, etc.}}

Further editing of Link properties is currently not supported for multiple objects. Although the related button in the Guid editor dialog is clickable, it is currently inoperable. Also the ''Skipping the dialog'' feature (see [https://wiki.augmensys.com/index.php?title=Editors#Guid_editor| Guid Editor Wiki]) is currently not supported in Multi Select mode.

{{UnderConstructionStart}}
{{Attention|Mass editing is currently not supported for Properties containing [[UBIK_Active_Lists|Active Lists]].}}
{{UnderConstructionEnd}}

[[Category:Client|Multi Select (UBIK Client)]]
[[Category:Mobile|Multi Select (UBIK Client)]]
[[Category:Version 4.3|Multi Select (UBIK Client)]]
[[Category:WinX|Mass Edit (UBIK WinX)]]
[[Category:XAML|Multi Select (UBIK Client)]]

== Multi select for filtered lists ==

In the standard UI, multi selection targets the original unfiltered lists. However, those lists are often presented in several filtered lists in many cases. See content filtering in [[XAML_Changes_in_UBIK_WinX_3.5#Filtering_by_expressions|UWP]] and in [[Xamarin_XAML#Content_filtering|Mobile]].

The multi select related XAML code (essentially <code>ListViewModel.BulkOperation</code>) in the standard UI can not be used directly in such scenarios. Because all filtered lists share the same original source list (<code>ListViewModel</code>). If the multi select feature is turned on from the original source list, all filtered lists will be affected.

For example, a source list can be divided into two filtered lists, one for finished tasks and the other for the unfinished ones. If you use the <code>ListViewModel.BulkOperation.SelectAllCommand</code>, it will select all tasks even though in the UI it will appear as if only those finished/unfinished are selected.

To avoid such a situation, the multi select feature should be turned on from the filtered lists instead. This means the following types:
* UWP: ListCollectionView;
* Mobile: SfDataSourceExt.

Here's also an example of multi select related XAML code adapted for a filtered list.

<tabs>
<tab name="UWP">
<source lang = "xml">
<Grid
xmlns:cv="using:UBIK.WinX.UI.CollectionView"
xmlns:controls="using:UBIK.WinX.Controls"
xmlns:interactivity="using:Microsoft.Xaml.Interactivity"
xmlns:core="using:Microsoft.Xaml.Interactions.Core">
<Grid.Resources>
<x:String x:Key="FilterExpression">Item.Header.ToLower().Contains("1")==true</x:String>
<cv:ListCollectionView x:Key="FilteredList" Expression="{StaticResource FilterExpression}" ItemsSource="{Binding Children.Items}" />
</Grid.Resources>

...

<ContentControl
...
ContentTemplate="{Binding TemplateService[UBIKMultiSelectPanel]}"
DataContext="{StaticResource FilteredList}"
Visibility="{Binding BulkOperation.ItemSelectionMode, Source={StaticResource FilteredList}, Converter={StaticResource EqualToVisConverter}, ConverterParameter=Multiple, FallbackValue=Collapsed, TargetNullValue=Collapsed}">
</ContentControl>

...

<controls:SelectionBoundListView
IsItemClickEnabled="False"
ItemsSource="{StaticResource FilteredList}"
SelectionMode="{Binding BulkOperation.ItemSelectionMode, Source={StaticResource FilteredList}, Converter={StaticResource ChildItemSelectionModeToListViewSelectionModeConverter}}">
<interactivity:Interaction.Behaviors>
<core:EventTriggerBehavior EventName="SelectionChanged">
<core:InvokeCommandAction Command="{Binding BulkOperation.ItemSelectionChangedCommand, Source={StaticResource FilteredList}}" InputConverter="{StaticResource SelectionChangedEventArgsConverter}" />
</core:EventTriggerBehavior>
</interactivity:Interaction.Behaviors>
</controls:SelectionBoundListView>

...

<Button
...
Command="{Binding BulkOperation.ToggleMultiSelectCommand, Source={StaticResource FilteredList}}"
Visibility="{Binding BulkOperation.ItemSelectionMode, Source={StaticResource FilteredList}, Converter={StaticResource EqualToVisConverter}, ConverterParameter=None}" />

</Grid>
</source>
</tab>

<tab name="Mobile(Xamarin)">
<source lang = "xml">
<Grid
xmlns:controls="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL"
xmlns:behaviors="clr-namespace:UBIK.CPL.Behaviors;assembly=UBIK.CPL">
<ContentView.Resources>
<ResourceDictionary>
<x:String x:Key="Expresssion">Item.Header.ToLower().Contains("1")==false</x:String>
<controls:SfDataSourceExt x:Key="FilteredList" Expression="{StaticResource Expresssion}" ItemsSource="{Binding Children.Items}" Unloaded="{Binding SkipFiltering}" />
</ResourceDictionary>
</ContentView.Resources>

...

<controls:SfListViewExt
...
ItemsSource="{Binding DisplayItems, Source={StaticResource FilteredList}}"
SelectionGesture="Tap"
SelectionMode="{Binding BulkOperation.ItemSelectionMode, Source={StaticResource FilteredList}, Converter={StaticResource SelectionModeConverter}}">
<controls:SfListViewExt.Behaviors>
<behaviors:EventHandlerBehavior EventName="SelectionChanged">
<behaviors:InvokeCommandAction Command="{Binding BulkOperation.ItemSelectionChangedCommand, Source={StaticResource FilteredList}}" Converter="{StaticResource SelectionChangedEventArgsConverter}" />
</behaviors:EventHandlerBehavior>
...
<behaviors:EventHandlerBehavior EventName="ItemHolding">
<behaviors:InvokeCommandAction Command="{Binding BulkOperation.ToggleMultiSelectCommand, Source={StaticResource FilteredList}}" />
</behaviors:EventHandlerBehavior>
</controls:SfListViewExt.Behaviors>
</controls:SfListViewExt>

...

<ContentView
...
BindingContext="{StaticResource FilteredList}"
ControlTemplate="{StaticResource UBIKMultiSelectTemplate}"
IsVisible="{Binding BulkOperation.ItemSelectionMode, Converter={StaticResource EqualityToBool}, ConverterParameter=Multiple, FallbackValue=false, TargetNullValue=false}" />

</Grid>
</source>
</tab>
</tabs>

{{Hint|The critical part is that wherever the <code>BulkOperation</code> property is accessed, it must be accessed from the <code>FilteredList</code>, not the original unfiltered <code>Children.Items</code> collection. When all references have been updated, the only remaining reference to 'Children' should be in FilteredList, as the ItemsSource attribute.}}

[[Category:Client|Multi Select (UBIK Client)]]
[[Category:Mobile|Multi Select (UBIK Client)]]
[[Category:Version 4.3|Multi Select (UBIK Client)]]
[[Category:WinX|Mass Edit (UBIK WinX)]]
[[Category:XAML|Multi Select (UBIK Client)]]

Documents (Client)

2026-03-17T12:21:02Z

CWI: /* Image Editor */

[[DOCUMENT|Documents]] are [[:Category:UBIK Object|{{UBIK}} objects]] referencing a file, e.g. a PDF document.
Like other {{UBIK}} objects, they can be synchronized to the {{UBIK}} client.
{{UBIK}} supports and displays document objects and a bunch of actions related to them, including e.g. editing, redlining, creation, and thumbnails.

== Document Types ==

* Managed Document - Documents with a locally managed file.
* Linked Document - Documents with a file linked by an URL, not locally managed by {{UBIK}}.

== Viewing Documents ==

Available Documents can be viewed in the documents tab of the current object, they are displayed with a thumbnail preview. On WinX, the display mode for documents can be configured by selecting the corresponding button; available display modes are: <br>
[[File:DocumentView_DisplayMode.png|thumb|Display mode selection (WinX)]]
* Gallery View (default)
* List View
* Flip View

<gallery widths="400" heights="350">
File:DocumentView_WinX.png|Thumbnail preview on WinX
File:DocumentView_MAUI.jpeg|Thumbnail preview on Mobile (iOS)
</gallery>

<br>Clicking on a document thumbnail navigates to the corresponding object and opens the internal document viewer.
A document can also be viewed by right-clicking on the object's thumbnail (WinX). This will open the document in an external editor provided by the operating system.
To open the document externally on the mobile client, the left-swipe functionality on the document object can be used to reveal the "open external" button.

<gallery widths="400" heights="80">
File:EditingMAUI.jpeg|Open external button in the document item's left-swipe menu (Mobile Client)
</gallery>
<gallery widths="400" heights="350">
File:DocumentViewer_WinX.png|Document Viewer on WinX Client
File:DocumentViewer_MAUI.jpeg|Document Viewer on Mobile Client (iOS)
</gallery>

=== Viewing or Editing the Object Data ===

Not only the file itself can be viewed, but also the {{UBIK}} property values of a document object. The way properties are displayed depends on the client being used. On the '''WinX''' client, the properties are shown directly on the right side of the document viewer. On the '''Mobile''' client, you need to switch to the Properties tab to view them.

<gallery widths="200" heights="350">
File:Properties_WinX.png|Document properties on WinX
File:Properties_MAUI.jpeg|Document properties on Mobile (iOS)
</gallery>

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== Creating Documents ==
Depending on the configuration of the {{UBIK}} data model and the [[ACM]], documents can be created as children for existing objects.
Via the context menu entry you can create such documents. (where it is configured)

{{Attention|File extensions are case-sensitive depending on the OS. On iOS and Android, file systems are case-sensitive, while on Windows, file systems are case-insensitive.}}

=== Taking a Picture ===
In certain cases, the camera can be used to take a picture and create a document for it - in this case, another "Take Picture" context menu entry is available.

=== Editing and Submitting the newly created Document ===
After either a document was chosen or a picture was taken, the newly created object is opened in a property view, allowing the user to abort the creation or to enter specific property values (e.g. for the description of the object) and finally save the object.

{{Version/WinXSince|3.6}} uploaded Document objects can potentially contain [[SYSCLS_FILEDETAILSCLASSIFICATION|detailed Information]] concerning the original file (e.g. file name, path)
{{Clear}}

=== File upload ===
Regarding the file upload, there is a mechanism [[File_Upload_Size_Restriction|FileUploadRestriction]] that ensures files only get uploaded if the file size is below the configured max upload size.

=== Synchronization ===
Depending on the connectivity mode, the next synchronization run will bring the new content and file to the server.

== Modify Documents ==

=== Redlining ===
[[HowTo:Make_a_Document_ready_for_Redlining|Redlining]] is the process of creating a modified or annotated version of an existing document.

To use this feature, click the “Annotation Tools” button in the document viewer toolbar at the top of the document.

After clicking “Annotation Tools”, the toolbar expands and provides several options for annotating the document, such as drawing freeform shapes, adding comments, selecting different colors ...

<gallery widths="400" heights="50">
File:Annotation_WinX.png|Annotation toolbar on WinX
File:Annotation_MAUI.jpeg|Annotation toolbar on Mobile (iOS)
</gallery>

The previous redlining number indicators are replaced by the [[Child_Document_Indicator_(Android)|child document indicators]]. {{Version/AndroidSince|2.4.5}}

=== Editing{{Version/WinXSince|2.5.4}} ===
[[File:Editing_WinX.png|Button to edit a document]]<br>

For [[SYSCLS_EDITABLEDOCUMENT|editable documents]], there is an {{key press|edit}} button in the top 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.}}
An alternative way to start editing is to right click on a document's thumbnail or clicking on the "open external" button inside of the document viewer, which immediately opens the document in an external editor. The difference here is that there is no {{key press|save}} button and any changes are automatically saved (and committed if in online mode).

<gallery widths="350" heights="50">
File:DocumentViewerButton_WinX.png|Open external button on WinX Client
</gallery>

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== Image Editor ==
In {{UBIK}}, images can be edited using the UBIKImageEditor. When navigating to an image object, the image editor opens automatically if configured.

<gallery widths="400" heights="350">
File:ImageEditor_WInX.png|ImageEditor on WinX Client
File:ImageEditor_MAUI.jpeg|ImageEditor on Mobile Client (iOS)
</gallery>

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== PDF Documents ==

=== PDF Renderers {{Version/WinXSince|4.6.0}} ===
The Syncfusion PDF control embedded in the WinX client can use two different renderers to render and display PDF documents.
* The standard Syncfusion renderer which uses [https://learn.microsoft.com/en-us/uwp/api/windows.data.pdf?view=winrt-26100 Windows.Data.PDF]
* [https://pdfium.googlesource.com/pdfium/ PDFium]
There can be issues for each renderer when dealing with certain documents. If that's the case, you can try changing the [[Settings#Content|PdfRenderer setting]] in the WinX client and see if the issue still persists.

{{Hint|Generally speaking, the PDFium renderer seems to be more performant in the majority cases. That's why it is the default option.}}

==== Syncfusion ====
When using this renderer, we have experienced an issue with certain PDF diagrams where certain texts change when you zoom in on the documents. Unfortunately, we are unaware of the reason of this issue and could not find public documentation on similar problems.

==== PDFium ====
* This renderer currently does not support digital signatures (e.g. created by [https://www.docusign.com Docusign]) unless they are flattened into the PDF documents.
* With this renderer selected, some documents in the Flip View might appear blank when zooming.

=== PDF Text Search ===
It is possible to search and highlight arbitrary texts in the {{UBIK}} PDF viewer. By clicking the magnifier button, an input field opens to search for specific text entries in the document. The results will be highlighted in the PDF file. By clicking the arrow buttons, it is possible to switch to the next and previous results. {{Version/XamarinSince|4.3.0}}

==== Automatic Text Search {{Version/XamarinSince|4.4.0}}{{Version/WinXSince|4.4.0}} ====
Using the [[SYSCLS_DOCUMENT_HIGHLIGHTING_CLASSIFICATION|Document Highlighting Classification]] A PDF document can search for a defined search term from its parents properties automatically as soon as it is being navigated to.

=== Remember Document Settings {{Version/WinXSince|4.9}} ===
By default, PDFViewer settings are not saved and always reset when reloading a document. The Remember Document Settings feature enables the automatic saving & preserving of the Zoom level, Annotation color, and Stroke width value within a {{UBIK}} session.
It can be configured in the [[Settings#Content|Settings]].
With this feature enabled, the PDFViewers Annotation color, Zoom level, and Stroke width value set by the user will be saved and preserved until the user changes them again.

If a document is configured with the [[SYSCLS_AUTO_ZOOM_CLASSIFICATION|Auto Zoom classification]], it will be overruled by the user's value as soon as the user sets it.
If an [[XAML#UBIKPdfViewer|AnnotationDefaultStrokeWidth]] value is configured, it will be overridden by the user's value as soon as the user sets it.

{{Attention|Saving the Zoom value with touch gestures is not supported. But the SaveZoomSettingsCommand can be used to save the Zoom value manually.}}

The SaveZoomSettingsCommand can be applied to a button as follows:
<source lang = "xml">
<pdfViewer:SfPdfViewerControl
Name="pdfViewer"
... />
<Button
Content="Save Zoom"
Command="{Binding ElementName=PdfViewer, Path=SaveZoomSettingsCommand}" />
</source>

=== 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 !!
|-
| [[File:UI_UWP_Fit_Mode_Default.png|240x225px]] || [[File:UI_UWP_Fit_Mode_Container.png|240x225px]] || [[File:UI_UWP_Fit_Mode_Width.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). }}

=== Auto zoom {{Version/WinXSince|4.6}}{{Version/XamarinSince|4.6}} ===
When a PDF document is displayed in UBIK, it's possible that [[SYSCLS_AUTO_ZOOM_CLASSIFICATION|an initial zoom level]] is configured and applied to that document.

{{Attention|The configured initial zoom level will be simply ignored if it's beyond the acceptable min/max zoom levels of the PDF viewer.}}

== Offline/Online ==

=== 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 again 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.

== See also ==
* [[HowTo:Create_a_new_Document_(UBIK_Android)]]
* [[HowTo:Make_a_Document_ready_for_Redlining]]
* [[SYSCLS_DOCUMENT]] (Classification)
* [[SYSCLS_FILEDOCUMENT]] (Classification)
* [[SYSCLS_EDITABLEDOCUMENT]] (Classification)
* [[SYSCLS_REDLINEDFILE]] (Classification)
* [[SYSCLS_DOCUMENT_HIGHLIGHTING_CLASSIFICATION]] (Classification)
* [[SYSCLS_URLDOCUMENT]] (Classification)
* [[SYSCLS_THUMBNAILEDDOCUMENT]] (Classification)
* [[SYSCLS_TEXTDOCUMENT]] (Classification)
* [[SYSCLS_OFFLINE_AVAILABLE_DOCUMENT]] (Classification)

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

Documents (Client)

2026-03-17T12:20:08Z

CWI: /* Viewing Documents */

[[DOCUMENT|Documents]] are [[:Category:UBIK Object|{{UBIK}} objects]] referencing a file, e.g. a PDF document.
Like other {{UBIK}} objects, they can be synchronized to the {{UBIK}} client.
{{UBIK}} supports and displays document objects and a bunch of actions related to them, including e.g. editing, redlining, creation, and thumbnails.

== Document Types ==

* Managed Document - Documents with a locally managed file.
* Linked Document - Documents with a file linked by an URL, not locally managed by {{UBIK}}.

== Viewing Documents ==

Available Documents can be viewed in the documents tab of the current object, they are displayed with a thumbnail preview. On WinX, the display mode for documents can be configured by selecting the corresponding button; available display modes are: <br>
[[File:DocumentView_DisplayMode.png|thumb|Display mode selection (WinX)]]
* Gallery View (default)
* List View
* Flip View

<gallery widths="400" heights="350">
File:DocumentView_WinX.png|Thumbnail preview on WinX
File:DocumentView_MAUI.jpeg|Thumbnail preview on Mobile (iOS)
</gallery>

<br>Clicking on a document thumbnail navigates to the corresponding object and opens the internal document viewer.
A document can also be viewed by right-clicking on the object's thumbnail (WinX). This will open the document in an external editor provided by the operating system.
To open the document externally on the mobile client, the left-swipe functionality on the document object can be used to reveal the "open external" button.

<gallery widths="400" heights="80">
File:EditingMAUI.jpeg|Open external button in the document item's left-swipe menu (Mobile Client)
</gallery>
<gallery widths="400" heights="350">
File:DocumentViewer_WinX.png|Document Viewer on WinX Client
File:DocumentViewer_MAUI.jpeg|Document Viewer on Mobile Client (iOS)
</gallery>

=== Viewing or Editing the Object Data ===

Not only the file itself can be viewed, but also the {{UBIK}} property values of a document object. The way properties are displayed depends on the client being used. On the '''WinX''' client, the properties are shown directly on the right side of the document viewer. On the '''Mobile''' client, you need to switch to the Properties tab to view them.

<gallery widths="200" heights="350">
File:Properties_WinX.png|Document properties on WinX
File:Properties_MAUI.jpeg|Document properties on Mobile (iOS)
</gallery>

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== Creating Documents ==
Depending on the configuration of the {{UBIK}} data model and the [[ACM]], documents can be created as children for existing objects.
Via the context menu entry you can create such documents. (where it is configured)

{{Attention|File extensions are case-sensitive depending on the OS. On iOS and Android, file systems are case-sensitive, while on Windows, file systems are case-insensitive.}}

=== Taking a Picture ===
In certain cases, the camera can be used to take a picture and create a document for it - in this case, another "Take Picture" context menu entry is available.

=== Editing and Submitting the newly created Document ===
After either a document was chosen or a picture was taken, the newly created object is opened in a property view, allowing the user to abort the creation or to enter specific property values (e.g. for the description of the object) and finally save the object.

{{Version/WinXSince|3.6}} uploaded Document objects can potentially contain [[SYSCLS_FILEDETAILSCLASSIFICATION|detailed Information]] concerning the original file (e.g. file name, path)
{{Clear}}

=== File upload ===
Regarding the file upload, there is a mechanism [[File_Upload_Size_Restriction|FileUploadRestriction]] that ensures files only get uploaded if the file size is below the configured max upload size.

=== Synchronization ===
Depending on the connectivity mode, the next synchronization run will bring the new content and file to the server.

== Modify Documents ==

=== Redlining ===
[[HowTo:Make_a_Document_ready_for_Redlining|Redlining]] is the process of creating a modified or annotated version of an existing document.

To use this feature, click the “Annotation Tools” button in the document viewer toolbar at the top of the document.

After clicking “Annotation Tools”, the toolbar expands and provides several options for annotating the document, such as drawing freeform shapes, adding comments, selecting different colors ...

<gallery widths="400" heights="50">
File:Annotation_WinX.png|Annotation toolbar on WinX
File:Annotation_MAUI.jpeg|Annotation toolbar on Mobile (iOS)
</gallery>

The previous redlining number indicators are replaced by the [[Child_Document_Indicator_(Android)|child document indicators]]. {{Version/AndroidSince|2.4.5}}

=== Editing{{Version/WinXSince|2.5.4}} ===
[[File:Editing_WinX.png|Button to edit a document]]<br>

For [[SYSCLS_EDITABLEDOCUMENT|editable documents]], there is an {{key press|edit}} button in the top 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.}}
An alternative way to start editing is to right click on a document's thumbnail or clicking on the "open external" button inside of the document viewer, which immediately opens the document in an external editor. The difference here is that there is no {{key press|save}} button and any changes are automatically saved (and committed if in online mode).

<gallery widths="350" heights="50">
File:DocumentViewerButton_WinX.png|Open external button on WinX Client
</gallery>

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== Image Editor ==
In {{UBIK}}, images can be edited using the UBIKImageEditor. When you navigate in a image object, the image editor opens automatically. (if configured)

<gallery widths="400" heights="400">
File:ImageEditor_WInX.png|ImageEditor on WinX Client
File:ImageEditor_MAUI.jpeg|ImageEditor on Mobile Client (iOS)
</gallery>

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== PDF Documents ==

=== PDF Renderers {{Version/WinXSince|4.6.0}} ===
The Syncfusion PDF control embedded in the WinX client can use two different renderers to render and display PDF documents.
* The standard Syncfusion renderer which uses [https://learn.microsoft.com/en-us/uwp/api/windows.data.pdf?view=winrt-26100 Windows.Data.PDF]
* [https://pdfium.googlesource.com/pdfium/ PDFium]
There can be issues for each renderer when dealing with certain documents. If that's the case, you can try changing the [[Settings#Content|PdfRenderer setting]] in the WinX client and see if the issue still persists.

{{Hint|Generally speaking, the PDFium renderer seems to be more performant in the majority cases. That's why it is the default option.}}

==== Syncfusion ====
When using this renderer, we have experienced an issue with certain PDF diagrams where certain texts change when you zoom in on the documents. Unfortunately, we are unaware of the reason of this issue and could not find public documentation on similar problems.

==== PDFium ====
* This renderer currently does not support digital signatures (e.g. created by [https://www.docusign.com Docusign]) unless they are flattened into the PDF documents.
* With this renderer selected, some documents in the Flip View might appear blank when zooming.

=== PDF Text Search ===
It is possible to search and highlight arbitrary texts in the {{UBIK}} PDF viewer. By clicking the magnifier button, an input field opens to search for specific text entries in the document. The results will be highlighted in the PDF file. By clicking the arrow buttons, it is possible to switch to the next and previous results. {{Version/XamarinSince|4.3.0}}

==== Automatic Text Search {{Version/XamarinSince|4.4.0}}{{Version/WinXSince|4.4.0}} ====
Using the [[SYSCLS_DOCUMENT_HIGHLIGHTING_CLASSIFICATION|Document Highlighting Classification]] A PDF document can search for a defined search term from its parents properties automatically as soon as it is being navigated to.

=== Remember Document Settings {{Version/WinXSince|4.9}} ===
By default, PDFViewer settings are not saved and always reset when reloading a document. The Remember Document Settings feature enables the automatic saving & preserving of the Zoom level, Annotation color, and Stroke width value within a {{UBIK}} session.
It can be configured in the [[Settings#Content|Settings]].
With this feature enabled, the PDFViewers Annotation color, Zoom level, and Stroke width value set by the user will be saved and preserved until the user changes them again.

If a document is configured with the [[SYSCLS_AUTO_ZOOM_CLASSIFICATION|Auto Zoom classification]], it will be overruled by the user's value as soon as the user sets it.
If an [[XAML#UBIKPdfViewer|AnnotationDefaultStrokeWidth]] value is configured, it will be overridden by the user's value as soon as the user sets it.

{{Attention|Saving the Zoom value with touch gestures is not supported. But the SaveZoomSettingsCommand can be used to save the Zoom value manually.}}

The SaveZoomSettingsCommand can be applied to a button as follows:
<source lang = "xml">
<pdfViewer:SfPdfViewerControl
Name="pdfViewer"
... />
<Button
Content="Save Zoom"
Command="{Binding ElementName=PdfViewer, Path=SaveZoomSettingsCommand}" />
</source>

=== 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 !!
|-
| [[File:UI_UWP_Fit_Mode_Default.png|240x225px]] || [[File:UI_UWP_Fit_Mode_Container.png|240x225px]] || [[File:UI_UWP_Fit_Mode_Width.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). }}

=== Auto zoom {{Version/WinXSince|4.6}}{{Version/XamarinSince|4.6}} ===
When a PDF document is displayed in UBIK, it's possible that [[SYSCLS_AUTO_ZOOM_CLASSIFICATION|an initial zoom level]] is configured and applied to that document.

{{Attention|The configured initial zoom level will be simply ignored if it's beyond the acceptable min/max zoom levels of the PDF viewer.}}

== Offline/Online ==

=== 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 again 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.

== See also ==
* [[HowTo:Create_a_new_Document_(UBIK_Android)]]
* [[HowTo:Make_a_Document_ready_for_Redlining]]
* [[SYSCLS_DOCUMENT]] (Classification)
* [[SYSCLS_FILEDOCUMENT]] (Classification)
* [[SYSCLS_EDITABLEDOCUMENT]] (Classification)
* [[SYSCLS_REDLINEDFILE]] (Classification)
* [[SYSCLS_DOCUMENT_HIGHLIGHTING_CLASSIFICATION]] (Classification)
* [[SYSCLS_URLDOCUMENT]] (Classification)
* [[SYSCLS_THUMBNAILEDDOCUMENT]] (Classification)
* [[SYSCLS_TEXTDOCUMENT]] (Classification)
* [[SYSCLS_OFFLINE_AVAILABLE_DOCUMENT]] (Classification)

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

Documents (Client)

2026-03-17T12:14:46Z

CWI: /* Editing{{Version/WinXSince|2.5.4}} */

[[DOCUMENT|Documents]] are [[:Category:UBIK Object|{{UBIK}} objects]] referencing a file, e.g. a PDF document.
Like other {{UBIK}} objects, they can be synchronized to the {{UBIK}} client.
{{UBIK}} supports and displays document objects and a bunch of actions related to them, including e.g. editing, redlining, creation, and thumbnails.

== Document Types ==

* Managed Document - Documents with a locally managed file.
* Linked Document - Documents with a file linked by an URL, not locally managed by {{UBIK}}.

== Viewing Documents ==

Available Documents can be viewed in the documents tab of the current object, they are displayed with a thumbnail preview. On WinX, the display mode for documents can be configured by selecting the corresponding button; available display modes are: <br>
[[File:DocumentView_DisplayMode.png|thumb|Display mode selection (WinX)]]
* Gallery View (default)
* List View
* Flip View

<gallery widths="400" heights="350">
File:DocumentView_WinX.png|Thumbnail preview on WinX
File:DocumentView_MAUI.jpeg|Thumbnail preview on Mobile (iOS)
</gallery>

<br>Clicking on a document thumbnail navigates to the corresponding object and opens the internal document viewer.
A document can also be viewed by right-clicking on the object's thumbnail. This will open the document in an external editor provided by the operating system.
In this way, the document can also be edited externally. For more details, see [[Documents_(Client)#Editing|Editing]].
<gallery widths="400" heights="350">
File:DocumentViewer_WinX.png|Document Viewer on WinX Client
File:DocumentViewer_MAUI.jpeg|Document Viewer on Mobile Client (iOS)
</gallery>

=== Viewing or Editing the Object Data ===

Not only the file itself can be viewed, but also the {{UBIK}} property values of a document object. The way properties are displayed depends on the client being used. On the '''WinX''' client, the properties are shown directly on the right side of the document viewer. On the '''Mobile''' client, you need to switch to the Properties tab to view them.

<gallery widths="200" heights="350">
File:Properties_WinX.png|Document properties on WinX
File:Properties_MAUI.jpeg|Document properties on Mobile (iOS)
</gallery>

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== Creating Documents ==
Depending on the configuration of the {{UBIK}} data model and the [[ACM]], documents can be created as children for existing objects.
Via the context menu entry you can create such documents. (where it is configured)

{{Attention|File extensions are case-sensitive depending on the OS. On iOS and Android, file systems are case-sensitive, while on Windows, file systems are case-insensitive.}}

=== Taking a Picture ===
In certain cases, the camera can be used to take a picture and create a document for it - in this case, another "Take Picture" context menu entry is available.

=== Editing and Submitting the newly created Document ===
After either a document was chosen or a picture was taken, the newly created object is opened in a property view, allowing the user to abort the creation or to enter specific property values (e.g. for the description of the object) and finally save the object.

{{Version/WinXSince|3.6}} uploaded Document objects can potentially contain [[SYSCLS_FILEDETAILSCLASSIFICATION|detailed Information]] concerning the original file (e.g. file name, path)
{{Clear}}

=== File upload ===
Regarding the file upload, there is a mechanism [[File_Upload_Size_Restriction|FileUploadRestriction]] that ensures files only get uploaded if the file size is below the configured max upload size.

=== Synchronization ===
Depending on the connectivity mode, the next synchronization run will bring the new content and file to the server.

== Modify Documents ==

=== Redlining ===
[[HowTo:Make_a_Document_ready_for_Redlining|Redlining]] is the process of creating a modified or annotated version of an existing document.

To use this feature, click the “Annotation Tools” button in the document viewer toolbar at the top of the document.

After clicking “Annotation Tools”, the toolbar expands and provides several options for annotating the document, such as drawing freeform shapes, adding comments, selecting different colors ...

<gallery widths="400" heights="50">
File:Annotation_WinX.png|Annotation toolbar on WinX
File:Annotation_MAUI.jpeg|Annotation toolbar on Mobile (iOS)
</gallery>

The previous redlining number indicators are replaced by the [[Child_Document_Indicator_(Android)|child document indicators]]. {{Version/AndroidSince|2.4.5}}

=== Editing{{Version/WinXSince|2.5.4}} ===
[[File:Editing_WinX.png|Button to edit a document]]<br>

For [[SYSCLS_EDITABLEDOCUMENT|editable documents]], there is an {{key press|edit}} button in the top 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.}}
An alternative way to start editing is to right click on a document's thumbnail or clicking on the "open external" button inside of the document viewer, which immediately opens the document in an external editor. The difference here is that there is no {{key press|save}} button and any changes are automatically saved (and committed if in online mode).

<gallery widths="350" heights="50">
File:DocumentViewerButton_WinX.png|Open external button on WinX Client
</gallery>

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== Image Editor ==
In {{UBIK}}, images can be edited using the UBIKImageEditor. When you navigate in a image object, the image editor opens automatically. (if configured)

<gallery widths="400" heights="400">
File:ImageEditor_WInX.png|ImageEditor on WinX Client
File:ImageEditor_MAUI.jpeg|ImageEditor on Mobile Client (iOS)
</gallery>

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== PDF Documents ==

=== PDF Renderers {{Version/WinXSince|4.6.0}} ===
The Syncfusion PDF control embedded in the WinX client can use two different renderers to render and display PDF documents.
* The standard Syncfusion renderer which uses [https://learn.microsoft.com/en-us/uwp/api/windows.data.pdf?view=winrt-26100 Windows.Data.PDF]
* [https://pdfium.googlesource.com/pdfium/ PDFium]
There can be issues for each renderer when dealing with certain documents. If that's the case, you can try changing the [[Settings#Content|PdfRenderer setting]] in the WinX client and see if the issue still persists.

{{Hint|Generally speaking, the PDFium renderer seems to be more performant in the majority cases. That's why it is the default option.}}

==== Syncfusion ====
When using this renderer, we have experienced an issue with certain PDF diagrams where certain texts change when you zoom in on the documents. Unfortunately, we are unaware of the reason of this issue and could not find public documentation on similar problems.

==== PDFium ====
* This renderer currently does not support digital signatures (e.g. created by [https://www.docusign.com Docusign]) unless they are flattened into the PDF documents.
* With this renderer selected, some documents in the Flip View might appear blank when zooming.

=== PDF Text Search ===
It is possible to search and highlight arbitrary texts in the {{UBIK}} PDF viewer. By clicking the magnifier button, an input field opens to search for specific text entries in the document. The results will be highlighted in the PDF file. By clicking the arrow buttons, it is possible to switch to the next and previous results. {{Version/XamarinSince|4.3.0}}

==== Automatic Text Search {{Version/XamarinSince|4.4.0}}{{Version/WinXSince|4.4.0}} ====
Using the [[SYSCLS_DOCUMENT_HIGHLIGHTING_CLASSIFICATION|Document Highlighting Classification]] A PDF document can search for a defined search term from its parents properties automatically as soon as it is being navigated to.

=== Remember Document Settings {{Version/WinXSince|4.9}} ===
By default, PDFViewer settings are not saved and always reset when reloading a document. The Remember Document Settings feature enables the automatic saving & preserving of the Zoom level, Annotation color, and Stroke width value within a {{UBIK}} session.
It can be configured in the [[Settings#Content|Settings]].
With this feature enabled, the PDFViewers Annotation color, Zoom level, and Stroke width value set by the user will be saved and preserved until the user changes them again.

If a document is configured with the [[SYSCLS_AUTO_ZOOM_CLASSIFICATION|Auto Zoom classification]], it will be overruled by the user's value as soon as the user sets it.
If an [[XAML#UBIKPdfViewer|AnnotationDefaultStrokeWidth]] value is configured, it will be overridden by the user's value as soon as the user sets it.

{{Attention|Saving the Zoom value with touch gestures is not supported. But the SaveZoomSettingsCommand can be used to save the Zoom value manually.}}

The SaveZoomSettingsCommand can be applied to a button as follows:
<source lang = "xml">
<pdfViewer:SfPdfViewerControl
Name="pdfViewer"
... />
<Button
Content="Save Zoom"
Command="{Binding ElementName=PdfViewer, Path=SaveZoomSettingsCommand}" />
</source>

=== 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 !!
|-
| [[File:UI_UWP_Fit_Mode_Default.png|240x225px]] || [[File:UI_UWP_Fit_Mode_Container.png|240x225px]] || [[File:UI_UWP_Fit_Mode_Width.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). }}

=== Auto zoom {{Version/WinXSince|4.6}}{{Version/XamarinSince|4.6}} ===
When a PDF document is displayed in UBIK, it's possible that [[SYSCLS_AUTO_ZOOM_CLASSIFICATION|an initial zoom level]] is configured and applied to that document.

{{Attention|The configured initial zoom level will be simply ignored if it's beyond the acceptable min/max zoom levels of the PDF viewer.}}

== Offline/Online ==

=== 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 again 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.

== See also ==
* [[HowTo:Create_a_new_Document_(UBIK_Android)]]
* [[HowTo:Make_a_Document_ready_for_Redlining]]
* [[SYSCLS_DOCUMENT]] (Classification)
* [[SYSCLS_FILEDOCUMENT]] (Classification)
* [[SYSCLS_EDITABLEDOCUMENT]] (Classification)
* [[SYSCLS_REDLINEDFILE]] (Classification)
* [[SYSCLS_DOCUMENT_HIGHLIGHTING_CLASSIFICATION]] (Classification)
* [[SYSCLS_URLDOCUMENT]] (Classification)
* [[SYSCLS_THUMBNAILEDDOCUMENT]] (Classification)
* [[SYSCLS_TEXTDOCUMENT]] (Classification)
* [[SYSCLS_OFFLINE_AVAILABLE_DOCUMENT]] (Classification)

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

Documents (Client)

2026-03-17T11:58:53Z

CWI: /* Modify Documents */

[[DOCUMENT|Documents]] are [[:Category:UBIK Object|{{UBIK}} objects]] referencing a file, e.g. a PDF document.
Like other {{UBIK}} objects, they can be synchronized to the {{UBIK}} client.
{{UBIK}} supports and displays document objects and a bunch of actions related to them, including e.g. editing, redlining, creation, and thumbnails.

== Document Types ==

* Managed Document - Documents with a locally managed file.
* Linked Document - Documents with a file linked by an URL, not locally managed by {{UBIK}}.

== Viewing Documents ==

Available Documents can be viewed in the documents tab of the current object, they are displayed with a thumbnail preview. On WinX, the display mode for documents can be configured by selecting the corresponding button; available display modes are: <br>
[[File:DocumentView_DisplayMode.png|thumb|Display mode selection (WinX)]]
* Gallery View (default)
* List View
* Flip View

<gallery widths="400" heights="350">
File:DocumentView_WinX.png|Thumbnail preview on WinX
File:DocumentView_MAUI.jpeg|Thumbnail preview on Mobile (iOS)
</gallery>

<br>Clicking on a document thumbnail navigates to the corresponding object and opens the internal document viewer.
A document can also be viewed by right-clicking on the object's thumbnail. This will open the document in an external editor provided by the operating system.
In this way, the document can also be edited externally. For more details, see [[Documents_(Client)#Editing|Editing]].
<gallery widths="400" heights="350">
File:DocumentViewer_WinX.png|Document Viewer on WinX Client
File:DocumentViewer_MAUI.jpeg|Document Viewer on Mobile Client (iOS)
</gallery>

=== Viewing or Editing the Object Data ===

Not only the file itself can be viewed, but also the {{UBIK}} property values of a document object. The way properties are displayed depends on the client being used. On the '''WinX''' client, the properties are shown directly on the right side of the document viewer. On the '''Mobile''' client, you need to switch to the Properties tab to view them.

<gallery widths="200" heights="350">
File:Properties_WinX.png|Document properties on WinX
File:Properties_MAUI.jpeg|Document properties on Mobile (iOS)
</gallery>

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== Creating Documents ==
Depending on the configuration of the {{UBIK}} data model and the [[ACM]], documents can be created as children for existing objects.
Via the context menu entry you can create such documents. (where it is configured)

{{Attention|File extensions are case-sensitive depending on the OS. On iOS and Android, file systems are case-sensitive, while on Windows, file systems are case-insensitive.}}

=== Taking a Picture ===
In certain cases, the camera can be used to take a picture and create a document for it - in this case, another "Take Picture" context menu entry is available.

=== Editing and Submitting the newly created Document ===
After either a document was chosen or a picture was taken, the newly created object is opened in a property view, allowing the user to abort the creation or to enter specific property values (e.g. for the description of the object) and finally save the object.

{{Version/WinXSince|3.6}} uploaded Document objects can potentially contain [[SYSCLS_FILEDETAILSCLASSIFICATION|detailed Information]] concerning the original file (e.g. file name, path)
{{Clear}}

=== File upload ===
Regarding the file upload, there is a mechanism [[File_Upload_Size_Restriction|FileUploadRestriction]] that ensures files only get uploaded if the file size is below the configured max upload size.

=== Synchronization ===
Depending on the connectivity mode, the next synchronization run will bring the new content and file to the server.

== Modify Documents ==

=== Redlining ===
[[HowTo:Make_a_Document_ready_for_Redlining|Redlining]] is the process of creating a modified or annotated version of an existing document.

To use this feature, click the “Annotation Tools” button in the document viewer toolbar at the top of the document.

After clicking “Annotation Tools”, the toolbar expands and provides several options for annotating the document, such as drawing freeform shapes, adding comments, selecting different colors ...

<gallery widths="400" heights="50">
File:Annotation_WinX.png|Annotation toolbar on WinX
File:Annotation_MAUI.jpeg|Annotation toolbar on Mobile (iOS)
</gallery>

The previous redlining number indicators are replaced by the [[Child_Document_Indicator_(Android)|child document indicators]]. {{Version/AndroidSince|2.4.5}}

=== Editing{{Version/WinXSince|2.5.4}} ===
[[File:Editing_WinX.png|Button to edit a document]]<br>

For [[SYSCLS_EDITABLEDOCUMENT|editable documents]], there is an {{key press|edit}} button in the top 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.}}
An alternative way to start editing is to right click on a document's thumbnail or clicking on the "open external" button inside of the document viewer, which immediately opens the document in an external editor (WinX). To open the document externally in order to start editing on the mobile client you have to use the left-swipe functionality on the document object. The difference here is that there is no {{key press|save}} button and any changes are automatically saved (and committed if in online mode).

<gallery widths="350" heights="50">
File:EditingMAUI.jpeg|Open external button Mobile Client
File:DocumentViewerButton_WinX.png|Open external button WinX Client
</gallery>

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== Image Editor ==
In {{UBIK}}, images can be edited using the UBIKImageEditor. When you navigate in a image object, the image editor opens automatically. (if configured)

<gallery widths="400" heights="400">
File:ImageEditor_WInX.png|ImageEditor on WinX Client
File:ImageEditor_MAUI.jpeg|ImageEditor on Mobile Client (iOS)
</gallery>

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== PDF Documents ==

=== PDF Renderers {{Version/WinXSince|4.6.0}} ===
The Syncfusion PDF control embedded in the WinX client can use two different renderers to render and display PDF documents.
* The standard Syncfusion renderer which uses [https://learn.microsoft.com/en-us/uwp/api/windows.data.pdf?view=winrt-26100 Windows.Data.PDF]
* [https://pdfium.googlesource.com/pdfium/ PDFium]
There can be issues for each renderer when dealing with certain documents. If that's the case, you can try changing the [[Settings#Content|PdfRenderer setting]] in the WinX client and see if the issue still persists.

{{Hint|Generally speaking, the PDFium renderer seems to be more performant in the majority cases. That's why it is the default option.}}

==== Syncfusion ====
When using this renderer, we have experienced an issue with certain PDF diagrams where certain texts change when you zoom in on the documents. Unfortunately, we are unaware of the reason of this issue and could not find public documentation on similar problems.

==== PDFium ====
* This renderer currently does not support digital signatures (e.g. created by [https://www.docusign.com Docusign]) unless they are flattened into the PDF documents.
* With this renderer selected, some documents in the Flip View might appear blank when zooming.

=== PDF Text Search ===
It is possible to search and highlight arbitrary texts in the {{UBIK}} PDF viewer. By clicking the magnifier button, an input field opens to search for specific text entries in the document. The results will be highlighted in the PDF file. By clicking the arrow buttons, it is possible to switch to the next and previous results. {{Version/XamarinSince|4.3.0}}

==== Automatic Text Search {{Version/XamarinSince|4.4.0}}{{Version/WinXSince|4.4.0}} ====
Using the [[SYSCLS_DOCUMENT_HIGHLIGHTING_CLASSIFICATION|Document Highlighting Classification]] A PDF document can search for a defined search term from its parents properties automatically as soon as it is being navigated to.

=== Remember Document Settings {{Version/WinXSince|4.9}} ===
By default, PDFViewer settings are not saved and always reset when reloading a document. The Remember Document Settings feature enables the automatic saving & preserving of the Zoom level, Annotation color, and Stroke width value within a {{UBIK}} session.
It can be configured in the [[Settings#Content|Settings]].
With this feature enabled, the PDFViewers Annotation color, Zoom level, and Stroke width value set by the user will be saved and preserved until the user changes them again.

If a document is configured with the [[SYSCLS_AUTO_ZOOM_CLASSIFICATION|Auto Zoom classification]], it will be overruled by the user's value as soon as the user sets it.
If an [[XAML#UBIKPdfViewer|AnnotationDefaultStrokeWidth]] value is configured, it will be overridden by the user's value as soon as the user sets it.

{{Attention|Saving the Zoom value with touch gestures is not supported. But the SaveZoomSettingsCommand can be used to save the Zoom value manually.}}

The SaveZoomSettingsCommand can be applied to a button as follows:
<source lang = "xml">
<pdfViewer:SfPdfViewerControl
Name="pdfViewer"
... />
<Button
Content="Save Zoom"
Command="{Binding ElementName=PdfViewer, Path=SaveZoomSettingsCommand}" />
</source>

=== 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 !!
|-
| [[File:UI_UWP_Fit_Mode_Default.png|240x225px]] || [[File:UI_UWP_Fit_Mode_Container.png|240x225px]] || [[File:UI_UWP_Fit_Mode_Width.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). }}

=== Auto zoom {{Version/WinXSince|4.6}}{{Version/XamarinSince|4.6}} ===
When a PDF document is displayed in UBIK, it's possible that [[SYSCLS_AUTO_ZOOM_CLASSIFICATION|an initial zoom level]] is configured and applied to that document.

{{Attention|The configured initial zoom level will be simply ignored if it's beyond the acceptable min/max zoom levels of the PDF viewer.}}

== Offline/Online ==

=== 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 again 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.

== See also ==
* [[HowTo:Create_a_new_Document_(UBIK_Android)]]
* [[HowTo:Make_a_Document_ready_for_Redlining]]
* [[SYSCLS_DOCUMENT]] (Classification)
* [[SYSCLS_FILEDOCUMENT]] (Classification)
* [[SYSCLS_EDITABLEDOCUMENT]] (Classification)
* [[SYSCLS_REDLINEDFILE]] (Classification)
* [[SYSCLS_DOCUMENT_HIGHLIGHTING_CLASSIFICATION]] (Classification)
* [[SYSCLS_URLDOCUMENT]] (Classification)
* [[SYSCLS_THUMBNAILEDDOCUMENT]] (Classification)
* [[SYSCLS_TEXTDOCUMENT]] (Classification)
* [[SYSCLS_OFFLINE_AVAILABLE_DOCUMENT]] (Classification)

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

Documents (Client)

2026-03-17T11:50:05Z

CWI: /* Modify Documents */

[[DOCUMENT|Documents]] are [[:Category:UBIK Object|{{UBIK}} objects]] referencing a file, e.g. a PDF document.
Like other {{UBIK}} objects, they can be synchronized to the {{UBIK}} client.
{{UBIK}} supports and displays document objects and a bunch of actions related to them, including e.g. editing, redlining, creation, and thumbnails.

== Document Types ==

* Managed Document - Documents with a locally managed file.
* Linked Document - Documents with a file linked by an URL, not locally managed by {{UBIK}}.

== Viewing Documents ==

Available Documents can be viewed in the documents tab of the current object, they are displayed with a thumbnail preview. On WinX, the display mode for documents can be configured by selecting the corresponding button; available display modes are: <br>
[[File:DocumentView_DisplayMode.png|thumb|Display mode selection (WinX)]]
* Gallery View (default)
* List View
* Flip View

<gallery widths="400" heights="350">
File:DocumentView_WinX.png|Thumbnail preview on WinX
File:DocumentView_MAUI.jpeg|Thumbnail preview on Mobile (iOS)
</gallery>

<br>Clicking on a document thumbnail navigates to the corresponding object and opens the internal document viewer.
A document can also be viewed by right-clicking on the object's thumbnail. This will open the document in an external editor provided by the operating system.
In this way, the document can also be edited externally. For more details, see [[Documents_(Client)#Editing|Editing]].
<gallery widths="400" heights="350">
File:DocumentViewer_WinX.png|Document Viewer on WinX Client
File:DocumentViewer_MAUI.jpeg|Document Viewer on Mobile Client (iOS)
</gallery>

=== Viewing or Editing the Object Data ===

Not only the file itself can be viewed, but also the {{UBIK}} property values of a document object. The way properties are displayed depends on the client being used. On the '''WinX''' client, the properties are shown directly on the right side of the document viewer. On the '''Mobile''' client, you need to switch to the Properties tab to view them.

<gallery widths="200" heights="350">
File:Properties_WinX.png|Document properties on WinX
File:Properties_MAUI.jpeg|Document properties on Mobile (iOS)
</gallery>

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== Creating Documents ==
Depending on the configuration of the {{UBIK}} data model and the [[ACM]], documents can be created as children for existing objects.
Via the context menu entry you can create such documents. (where it is configured)

{{Attention|File extensions are case-sensitive depending on the OS. On iOS and Android, file systems are case-sensitive, while on Windows, file systems are case-insensitive.}}

=== Taking a Picture ===
In certain cases, the camera can be used to take a picture and create a document for it - in this case, another "Take Picture" context menu entry is available.

=== Editing and Submitting the newly created Document ===
After either a document was chosen or a picture was taken, the newly created object is opened in a property view, allowing the user to abort the creation or to enter specific property values (e.g. for the description of the object) and finally save the object.

{{Version/WinXSince|3.6}} uploaded Document objects can potentially contain [[SYSCLS_FILEDETAILSCLASSIFICATION|detailed Information]] concerning the original file (e.g. file name, path)
{{Clear}}

=== File upload ===
Regarding the file upload, there is a mechanism [[File_Upload_Size_Restriction|FileUploadRestriction]] that ensures files only get uploaded if the file size is below the configured max upload size.

=== Synchronization ===
Depending on the connectivity mode, the next synchronization run will bring the new content and file to the server.

== Modify Documents ==

=== Redlining ===
[[HowTo:Make_a_Document_ready_for_Redlining|Redlining]] is the process of creating a modified or annotated version of an existing document.

To use this feature, click the “Annotation Tools” button in the document viewer toolbar at the top of the document.

After clicking “Annotation Tools”, the toolbar expands and provides several options for annotating the document, such as drawing freeform shapes, adding comments, selecting different colors ...

<gallery widths="400" heights="50">
File:Annotation_WinX.png|Annotation toolbar on WinX
File:Annotation_MAUI.jpeg|Annotation toolbar on Mobile (iOS)
</gallery>

The previous redlining number indicators are replaced by the [[Child_Document_Indicator_(Android)|child document indicators]]. {{Version/AndroidSince|2.4.5}}

=== Editing{{Version/WinXSince|2.5.4}} ===
[[File:Editing_WinX.png|Button to edit a document]]<br>

For [[SYSCLS_EDITABLEDOCUMENT|editable documents]], there is an {{key press|edit}} button in the top 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.}}
An alternative way to start editing is to right click on a document's thumbnail or clicking on the "open external" button inside of the document viewer, which immediately opens the document in an external editor (WinX). To start editing on the mobile client you have to use the left-swipe functionality on the object. The difference here is that there is no {{key press|save}} button and any changes are automatically saved (and committed if in online mode).

[[File:EditingMAUI.jpeg|350px|Left-swipe button Mobile Client]]
[[File:DocumentViewerButton_WinX.png|350px|Left-swipe button WinX Client]]

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== Image Editor ==
In {{UBIK}}, images can be edited using the UBIKImageEditor. When you navigate in a image object, the image editor opens automatically. (if configured)

<gallery widths="400" heights="400">
File:ImageEditor_WInX.png|ImageEditor on WinX Client
File:ImageEditor_MAUI.jpeg|ImageEditor on Mobile Client (iOS)
</gallery>

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== PDF Documents ==

=== PDF Renderers {{Version/WinXSince|4.6.0}} ===
The Syncfusion PDF control embedded in the WinX client can use two different renderers to render and display PDF documents.
* The standard Syncfusion renderer which uses [https://learn.microsoft.com/en-us/uwp/api/windows.data.pdf?view=winrt-26100 Windows.Data.PDF]
* [https://pdfium.googlesource.com/pdfium/ PDFium]
There can be issues for each renderer when dealing with certain documents. If that's the case, you can try changing the [[Settings#Content|PdfRenderer setting]] in the WinX client and see if the issue still persists.

{{Hint|Generally speaking, the PDFium renderer seems to be more performant in the majority cases. That's why it is the default option.}}

==== Syncfusion ====
When using this renderer, we have experienced an issue with certain PDF diagrams where certain texts change when you zoom in on the documents. Unfortunately, we are unaware of the reason of this issue and could not find public documentation on similar problems.

==== PDFium ====
* This renderer currently does not support digital signatures (e.g. created by [https://www.docusign.com Docusign]) unless they are flattened into the PDF documents.
* With this renderer selected, some documents in the Flip View might appear blank when zooming.

=== PDF Text Search ===
It is possible to search and highlight arbitrary texts in the {{UBIK}} PDF viewer. By clicking the magnifier button, an input field opens to search for specific text entries in the document. The results will be highlighted in the PDF file. By clicking the arrow buttons, it is possible to switch to the next and previous results. {{Version/XamarinSince|4.3.0}}

==== Automatic Text Search {{Version/XamarinSince|4.4.0}}{{Version/WinXSince|4.4.0}} ====
Using the [[SYSCLS_DOCUMENT_HIGHLIGHTING_CLASSIFICATION|Document Highlighting Classification]] A PDF document can search for a defined search term from its parents properties automatically as soon as it is being navigated to.

=== Remember Document Settings {{Version/WinXSince|4.9}} ===
By default, PDFViewer settings are not saved and always reset when reloading a document. The Remember Document Settings feature enables the automatic saving & preserving of the Zoom level, Annotation color, and Stroke width value within a {{UBIK}} session.
It can be configured in the [[Settings#Content|Settings]].
With this feature enabled, the PDFViewers Annotation color, Zoom level, and Stroke width value set by the user will be saved and preserved until the user changes them again.

If a document is configured with the [[SYSCLS_AUTO_ZOOM_CLASSIFICATION|Auto Zoom classification]], it will be overruled by the user's value as soon as the user sets it.
If an [[XAML#UBIKPdfViewer|AnnotationDefaultStrokeWidth]] value is configured, it will be overridden by the user's value as soon as the user sets it.

{{Attention|Saving the Zoom value with touch gestures is not supported. But the SaveZoomSettingsCommand can be used to save the Zoom value manually.}}

The SaveZoomSettingsCommand can be applied to a button as follows:
<source lang = "xml">
<pdfViewer:SfPdfViewerControl
Name="pdfViewer"
... />
<Button
Content="Save Zoom"
Command="{Binding ElementName=PdfViewer, Path=SaveZoomSettingsCommand}" />
</source>

=== 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 !!
|-
| [[File:UI_UWP_Fit_Mode_Default.png|240x225px]] || [[File:UI_UWP_Fit_Mode_Container.png|240x225px]] || [[File:UI_UWP_Fit_Mode_Width.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). }}

=== Auto zoom {{Version/WinXSince|4.6}}{{Version/XamarinSince|4.6}} ===
When a PDF document is displayed in UBIK, it's possible that [[SYSCLS_AUTO_ZOOM_CLASSIFICATION|an initial zoom level]] is configured and applied to that document.

{{Attention|The configured initial zoom level will be simply ignored if it's beyond the acceptable min/max zoom levels of the PDF viewer.}}

== Offline/Online ==

=== 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 again 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.

== See also ==
* [[HowTo:Create_a_new_Document_(UBIK_Android)]]
* [[HowTo:Make_a_Document_ready_for_Redlining]]
* [[SYSCLS_DOCUMENT]] (Classification)
* [[SYSCLS_FILEDOCUMENT]] (Classification)
* [[SYSCLS_EDITABLEDOCUMENT]] (Classification)
* [[SYSCLS_REDLINEDFILE]] (Classification)
* [[SYSCLS_DOCUMENT_HIGHLIGHTING_CLASSIFICATION]] (Classification)
* [[SYSCLS_URLDOCUMENT]] (Classification)
* [[SYSCLS_THUMBNAILEDDOCUMENT]] (Classification)
* [[SYSCLS_TEXTDOCUMENT]] (Classification)
* [[SYSCLS_OFFLINE_AVAILABLE_DOCUMENT]] (Classification)

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

Documents (Client)

2026-03-17T11:27:45Z

CWI: /* Viewing Documents */

[[DOCUMENT|Documents]] are [[:Category:UBIK Object|{{UBIK}} objects]] referencing a file, e.g. a PDF document.
Like other {{UBIK}} objects, they can be synchronized to the {{UBIK}} client.
{{UBIK}} supports and displays document objects and a bunch of actions related to them, including e.g. editing, redlining, creation, and thumbnails.

== Document Types ==

* Managed Document - Documents with a locally managed file.
* Linked Document - Documents with a file linked by an URL, not locally managed by {{UBIK}}.

== Viewing Documents ==

Available Documents can be viewed in the documents tab of the current object, they are displayed with a thumbnail preview. On WinX, the display mode for documents can be configured by selecting the corresponding button; available display modes are: <br>
[[File:DocumentView_DisplayMode.png|thumb|Display mode selection (WinX)]]
* Gallery View (default)
* List View
* Flip View

<gallery widths="400" heights="350">
File:DocumentView_WinX.png|Thumbnail preview on WinX
File:DocumentView_MAUI.jpeg|Thumbnail preview on Mobile (iOS)
</gallery>

<br>Clicking on a document thumbnail navigates to the corresponding object and opens the internal document viewer.
A document can also be viewed by right-clicking on the object's thumbnail. This will open the document in an external editor provided by the operating system.
In this way, the document can also be edited externally. For more details, see [[Documents_(Client)#Editing|Editing]].
<gallery widths="400" heights="350">
File:DocumentViewer_WinX.png|Document Viewer on WinX Client
File:DocumentViewer_MAUI.jpeg|Document Viewer on Mobile Client (iOS)
</gallery>

=== Viewing or Editing the Object Data ===

Not only the file itself can be viewed, but also the {{UBIK}} property values of a document object. The way properties are displayed depends on the client being used. On the '''WinX''' client, the properties are shown directly on the right side of the document viewer. On the '''Mobile''' client, you need to switch to the Properties tab to view them.

<gallery widths="200" heights="350">
File:Properties_WinX.png|Document properties on WinX
File:Properties_MAUI.jpeg|Document properties on Mobile (iOS)
</gallery>

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== Creating Documents ==
Depending on the configuration of the {{UBIK}} data model and the [[ACM]], documents can be created as children for existing objects.
Via the context menu entry you can create such documents. (where it is configured)

{{Attention|File extensions are case-sensitive depending on the OS. On iOS and Android, file systems are case-sensitive, while on Windows, file systems are case-insensitive.}}

=== Taking a Picture ===
In certain cases, the camera can be used to take a picture and create a document for it - in this case, another "Take Picture" context menu entry is available.

=== Editing and Submitting the newly created Document ===
After either a document was chosen or a picture was taken, the newly created object is opened in a property view, allowing the user to abort the creation or to enter specific property values (e.g. for the description of the object) and finally save the object.

{{Version/WinXSince|3.6}} uploaded Document objects can potentially contain [[SYSCLS_FILEDETAILSCLASSIFICATION|detailed Information]] concerning the original file (e.g. file name, path)
{{Clear}}

=== File upload ===
Regarding the file upload, there is a mechanism [[File_Upload_Size_Restriction|FileUploadRestriction]] that ensures files only get uploaded if the file size is below the configured max upload size.

=== Synchronization ===
Depending on the connectivity mode, the next synchronization run will bring the new content and file to the server.

== Modify Documents ==

=== Redlining ===
[[HowTo:Make_a_Document_ready_for_Redlining|Redlining]] is the process of creating a modified or annotated version of an existing document.

To use this feature, click the “Annotation Tools” button in the document viewer toolbar at the top of the document.

After clicking “Annotation Tools”, the toolbar expands and provides several options for annotating the document, such as drawing freeform shapes, adding comments, selecting different colors ...

<gallery widths="400" heights="50">
File:Annotation_WinX.png|WinX
File:Annotation_MAUI.jpeg|Mobile (iOS)
</gallery>

The previous redlining number indicators are replaced by the [[Child_Document_Indicator_(Android)|child document indicators]]. {{Version/AndroidSince|2.4.5}}

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

=== Editing{{Version/WinXSince|2.5.4}} ===
[[File:Editing_WinX.png|Button to edit a document]]<br>

For [[SYSCLS_EDITABLEDOCUMENT|editable documents]], there is an {{key press|edit}} button in the top 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.}}
An alternative way to start editing is to right click on a document's thumbnail or clicking on the "open external" button inside of the document viewer, which immediately opens the document in an external editor (WinX). To start editing on the mobile client you have to use the left-swipe functionality on the object. The difference here is that there is no {{key press|save}} button and any changes are automatically saved (and committed if in online mode).

[[File:EditingMAUI.jpeg|350px|Left-swipe button Mobile Client]]
[[File:DocumentViewerButton_WinX.png|350px|Left-swipe button WinX Client]]

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== Image Editor ==
In {{UBIK}}, images can be edited using the UBIKImageEditor. When you navigate in a image object, the image editor opens automatically. (if configured)

<gallery widths="400" heights="400">
File:ImageEditor_WInX.png|ImageEditor on WinX Client
File:ImageEditor_MAUI.jpeg|ImageEditor on Mobile Client (iOS)
</gallery>

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== PDF Documents ==

=== PDF Renderers {{Version/WinXSince|4.6.0}} ===
The Syncfusion PDF control embedded in the WinX client can use two different renderers to render and display PDF documents.
* The standard Syncfusion renderer which uses [https://learn.microsoft.com/en-us/uwp/api/windows.data.pdf?view=winrt-26100 Windows.Data.PDF]
* [https://pdfium.googlesource.com/pdfium/ PDFium]
There can be issues for each renderer when dealing with certain documents. If that's the case, you can try changing the [[Settings#Content|PdfRenderer setting]] in the WinX client and see if the issue still persists.

{{Hint|Generally speaking, the PDFium renderer seems to be more performant in the majority cases. That's why it is the default option.}}

==== Syncfusion ====
When using this renderer, we have experienced an issue with certain PDF diagrams where certain texts change when you zoom in on the documents. Unfortunately, we are unaware of the reason of this issue and could not find public documentation on similar problems.

==== PDFium ====
* This renderer currently does not support digital signatures (e.g. created by [https://www.docusign.com Docusign]) unless they are flattened into the PDF documents.
* With this renderer selected, some documents in the Flip View might appear blank when zooming.

=== PDF Text Search ===
It is possible to search and highlight arbitrary texts in the {{UBIK}} PDF viewer. By clicking the magnifier button, an input field opens to search for specific text entries in the document. The results will be highlighted in the PDF file. By clicking the arrow buttons, it is possible to switch to the next and previous results. {{Version/XamarinSince|4.3.0}}

==== Automatic Text Search {{Version/XamarinSince|4.4.0}}{{Version/WinXSince|4.4.0}} ====
Using the [[SYSCLS_DOCUMENT_HIGHLIGHTING_CLASSIFICATION|Document Highlighting Classification]] A PDF document can search for a defined search term from its parents properties automatically as soon as it is being navigated to.

=== Remember Document Settings {{Version/WinXSince|4.9}} ===
By default, PDFViewer settings are not saved and always reset when reloading a document. The Remember Document Settings feature enables the automatic saving & preserving of the Zoom level, Annotation color, and Stroke width value within a {{UBIK}} session.
It can be configured in the [[Settings#Content|Settings]].
With this feature enabled, the PDFViewers Annotation color, Zoom level, and Stroke width value set by the user will be saved and preserved until the user changes them again.

If a document is configured with the [[SYSCLS_AUTO_ZOOM_CLASSIFICATION|Auto Zoom classification]], it will be overruled by the user's value as soon as the user sets it.
If an [[XAML#UBIKPdfViewer|AnnotationDefaultStrokeWidth]] value is configured, it will be overridden by the user's value as soon as the user sets it.

{{Attention|Saving the Zoom value with touch gestures is not supported. But the SaveZoomSettingsCommand can be used to save the Zoom value manually.}}

The SaveZoomSettingsCommand can be applied to a button as follows:
<source lang = "xml">
<pdfViewer:SfPdfViewerControl
Name="pdfViewer"
... />
<Button
Content="Save Zoom"
Command="{Binding ElementName=PdfViewer, Path=SaveZoomSettingsCommand}" />
</source>

=== 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 !!
|-
| [[File:UI_UWP_Fit_Mode_Default.png|240x225px]] || [[File:UI_UWP_Fit_Mode_Container.png|240x225px]] || [[File:UI_UWP_Fit_Mode_Width.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). }}

=== Auto zoom {{Version/WinXSince|4.6}}{{Version/XamarinSince|4.6}} ===
When a PDF document is displayed in UBIK, it's possible that [[SYSCLS_AUTO_ZOOM_CLASSIFICATION|an initial zoom level]] is configured and applied to that document.

{{Attention|The configured initial zoom level will be simply ignored if it's beyond the acceptable min/max zoom levels of the PDF viewer.}}

== Offline/Online ==

=== 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 again 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.

== See also ==
* [[HowTo:Create_a_new_Document_(UBIK_Android)]]
* [[HowTo:Make_a_Document_ready_for_Redlining]]
* [[SYSCLS_DOCUMENT]] (Classification)
* [[SYSCLS_FILEDOCUMENT]] (Classification)
* [[SYSCLS_EDITABLEDOCUMENT]] (Classification)
* [[SYSCLS_REDLINEDFILE]] (Classification)
* [[SYSCLS_DOCUMENT_HIGHLIGHTING_CLASSIFICATION]] (Classification)
* [[SYSCLS_URLDOCUMENT]] (Classification)
* [[SYSCLS_THUMBNAILEDDOCUMENT]] (Classification)
* [[SYSCLS_TEXTDOCUMENT]] (Classification)
* [[SYSCLS_OFFLINE_AVAILABLE_DOCUMENT]] (Classification)

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

Documents (Client)

2026-03-17T11:13:25Z

CWI: /* Redlining */

[[DOCUMENT|Documents]] are [[:Category:UBIK Object|{{UBIK}} objects]] referencing a file, e.g. a PDF document.
Like other {{UBIK}} objects, they can be synchronized to the {{UBIK}} client.
{{UBIK}} supports and displays document objects and a bunch of actions related to them, including e.g. editing, redlining, creation, and thumbnails.

== Document Types ==

* Managed Document - Documents with a locally managed file.
* Linked Document - Documents with a file linked by an URL, not locally managed by {{UBIK}}.

== Viewing Documents ==

Available Documents can be viewed in the documents tab of the current object, they are displayed with a thumbnail preview. <br>

<gallery widths="400" heights="400">
File:DocumentView_WinX.png|Thumbnail preview on WinX
File:DocumentView_MAUI.jpeg|Thumbnail preview on MAUI (iOS)
</gallery>
<br>
On WinX, the display mode for documents can be configured; available display modes are: <br>
* Gallery View (default)
* List View
* Flip View
<br>
[[File:DocumentView_DisplayMode.png]]

<br>Clicking on a document navigates to the corresponding object and opens the internal document viewer.
<gallery widths="400" heights="400">
File:DocumentViewer_WinX.png|Document Viewer on WinX Client
File:DocumentViewer_MAUI.jpeg|Document Viewer on Mobile Client (iOS)
</gallery>

A document can also be viewed by right-clicking on the object's thumbnail. This will open the document in an external editor provided by the operating system.
In this way, the document can also be edited externally. For more details, see [[Documents_(Client)#Editing|Editing]].

=== Viewing or Editing the Object Data ===

Not only the file itself can be viewed, but also the {{UBIK}} property values of a document object. The way properties are displayed depends on the client being used. On the '''WinX''' client, the properties are shown directly on the right side of the document viewer. On the '''Mobile''' client, you need to switch to the Properties tab to view them.

<gallery widths="250" heights="400">
File:Properties_WinX.png|Document properties on WinX
File:Properties_MAUI.jpeg|Document properties on Mobile (iOS)
</gallery>

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== Creating Documents ==
Depending on the configuration of the {{UBIK}} data model and the [[ACM]], documents can be created as children for existing objects.
Via the context menu entry you can create such documents. (where it is configured)

{{Attention|File extensions are case-sensitive depending on the OS. On iOS and Android, file systems are case-sensitive, while on Windows, file systems are case-insensitive.}}

=== Taking a Picture ===
In certain cases, the camera can be used to take a picture and create a document for it - in this case, another "Take Picture" context menu entry is available.

=== Editing and Submitting the newly created Document ===
After either a document was chosen or a picture was taken, the newly created object is opened in a property view, allowing the user to abort the creation or to enter specific property values (e.g. for the description of the object) and finally save the object.

{{Version/WinXSince|3.6}} uploaded Document objects can potentially contain [[SYSCLS_FILEDETAILSCLASSIFICATION|detailed Information]] concerning the original file (e.g. file name, path)
{{Clear}}

=== File upload ===
Regarding the file upload, there is a mechanism [[File_Upload_Size_Restriction|FileUploadRestriction]] that ensures files only get uploaded if the file size is below the configured max upload size.

=== Synchronization ===
Depending on the connectivity mode, the next synchronization run will bring the new content and file to the server.

== Modify Documents ==

=== Redlining ===
[[HowTo:Make_a_Document_ready_for_Redlining|Redlining]] is the process of creating a modified or annotated version of an existing document.

To use this feature, click the “Annotation Tools” button in the document viewer toolbar at the top of the document.

After clicking “Annotation Tools”, the toolbar expands and provides several options for annotating the document, such as drawing freeform shapes, adding comments, selecting different colors ...

<gallery widths="400" heights="50">
File:Annotation_WinX.png|WinX
File:Annotation_MAUI.jpeg|Mobile (iOS)
</gallery>

The previous redlining number indicators are replaced by the [[Child_Document_Indicator_(Android)|child document indicators]]. {{Version/AndroidSince|2.4.5}}

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

=== Editing{{Version/WinXSince|2.5.4}} ===
[[File:Editing_WinX.png|Button to edit a document]]<br>

For [[SYSCLS_EDITABLEDOCUMENT|editable documents]], there is an {{key press|edit}} button in the top 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.}}
An alternative way to start editing is to right click on a document's thumbnail or clicking on the "open external" button inside of the document viewer, which immediately opens the document in an external editor (WinX). To start editing on the mobile client you have to use the left-swipe functionality on the object. The difference here is that there is no {{key press|save}} button and any changes are automatically saved (and committed if in online mode).

[[File:EditingMAUI.jpeg|350px|Left-swipe button Mobile Client]]
[[File:DocumentViewerButton_WinX.png|350px|Left-swipe button WinX Client]]

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== Image Editor ==
In {{UBIK}}, images can be edited using the UBIKImageEditor. When you navigate in a image object, the image editor opens automatically. (if configured)

<gallery widths="400" heights="400">
File:ImageEditor_WInX.png|ImageEditor on WinX Client
File:ImageEditor_MAUI.jpeg|ImageEditor on Mobile Client (iOS)
</gallery>

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== PDF Documents ==

=== PDF Renderers {{Version/WinXSince|4.6.0}} ===
The Syncfusion PDF control embedded in the WinX client can use two different renderers to render and display PDF documents.
* The standard Syncfusion renderer which uses [https://learn.microsoft.com/en-us/uwp/api/windows.data.pdf?view=winrt-26100 Windows.Data.PDF]
* [https://pdfium.googlesource.com/pdfium/ PDFium]
There can be issues for each renderer when dealing with certain documents. If that's the case, you can try changing the [[Settings#Content|PdfRenderer setting]] in the WinX client and see if the issue still persists.

{{Hint|Generally speaking, the PDFium renderer seems to be more performant in the majority cases. That's why it is the default option.}}

==== Syncfusion ====
When using this renderer, we have experienced an issue with certain PDF diagrams where certain texts change when you zoom in on the documents. Unfortunately, we are unaware of the reason of this issue and could not find public documentation on similar problems.

==== PDFium ====
* This renderer currently does not support digital signatures (e.g. created by [https://www.docusign.com Docusign]) unless they are flattened into the PDF documents.
* With this renderer selected, some documents in the Flip View might appear blank when zooming.

=== PDF Text Search ===
It is possible to search and highlight arbitrary texts in the {{UBIK}} PDF viewer. By clicking the magnifier button, an input field opens to search for specific text entries in the document. The results will be highlighted in the PDF file. By clicking the arrow buttons, it is possible to switch to the next and previous results. {{Version/XamarinSince|4.3.0}}

==== Automatic Text Search {{Version/XamarinSince|4.4.0}}{{Version/WinXSince|4.4.0}} ====
Using the [[SYSCLS_DOCUMENT_HIGHLIGHTING_CLASSIFICATION|Document Highlighting Classification]] A PDF document can search for a defined search term from its parents properties automatically as soon as it is being navigated to.

=== Remember Document Settings {{Version/WinXSince|4.9}} ===
By default, PDFViewer settings are not saved and always reset when reloading a document. The Remember Document Settings feature enables the automatic saving & preserving of the Zoom level, Annotation color, and Stroke width value within a {{UBIK}} session.
It can be configured in the [[Settings#Content|Settings]].
With this feature enabled, the PDFViewers Annotation color, Zoom level, and Stroke width value set by the user will be saved and preserved until the user changes them again.

If a document is configured with the [[SYSCLS_AUTO_ZOOM_CLASSIFICATION|Auto Zoom classification]], it will be overruled by the user's value as soon as the user sets it.
If an [[XAML#UBIKPdfViewer|AnnotationDefaultStrokeWidth]] value is configured, it will be overridden by the user's value as soon as the user sets it.

{{Attention|Saving the Zoom value with touch gestures is not supported. But the SaveZoomSettingsCommand can be used to save the Zoom value manually.}}

The SaveZoomSettingsCommand can be applied to a button as follows:
<source lang = "xml">
<pdfViewer:SfPdfViewerControl
Name="pdfViewer"
... />
<Button
Content="Save Zoom"
Command="{Binding ElementName=PdfViewer, Path=SaveZoomSettingsCommand}" />
</source>

=== 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 !!
|-
| [[File:UI_UWP_Fit_Mode_Default.png|240x225px]] || [[File:UI_UWP_Fit_Mode_Container.png|240x225px]] || [[File:UI_UWP_Fit_Mode_Width.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). }}

=== Auto zoom {{Version/WinXSince|4.6}}{{Version/XamarinSince|4.6}} ===
When a PDF document is displayed in UBIK, it's possible that [[SYSCLS_AUTO_ZOOM_CLASSIFICATION|an initial zoom level]] is configured and applied to that document.

{{Attention|The configured initial zoom level will be simply ignored if it's beyond the acceptable min/max zoom levels of the PDF viewer.}}

== Offline/Online ==

=== 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 again 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.

== See also ==
* [[HowTo:Create_a_new_Document_(UBIK_Android)]]
* [[HowTo:Make_a_Document_ready_for_Redlining]]
* [[SYSCLS_DOCUMENT]] (Classification)
* [[SYSCLS_FILEDOCUMENT]] (Classification)
* [[SYSCLS_EDITABLEDOCUMENT]] (Classification)
* [[SYSCLS_REDLINEDFILE]] (Classification)
* [[SYSCLS_DOCUMENT_HIGHLIGHTING_CLASSIFICATION]] (Classification)
* [[SYSCLS_URLDOCUMENT]] (Classification)
* [[SYSCLS_THUMBNAILEDDOCUMENT]] (Classification)
* [[SYSCLS_TEXTDOCUMENT]] (Classification)
* [[SYSCLS_OFFLINE_AVAILABLE_DOCUMENT]] (Classification)

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

Documents (Client)

2026-03-17T11:11:55Z

CWI: /* Viewing or Editing the Object Data */

[[DOCUMENT|Documents]] are [[:Category:UBIK Object|{{UBIK}} objects]] referencing a file, e.g. a PDF document.
Like other {{UBIK}} objects, they can be synchronized to the {{UBIK}} client.
{{UBIK}} supports and displays document objects and a bunch of actions related to them, including e.g. editing, redlining, creation, and thumbnails.

== Document Types ==

* Managed Document - Documents with a locally managed file.
* Linked Document - Documents with a file linked by an URL, not locally managed by {{UBIK}}.

== Viewing Documents ==

Available Documents can be viewed in the documents tab of the current object, they are displayed with a thumbnail preview. <br>

<gallery widths="400" heights="400">
File:DocumentView_WinX.png|Thumbnail preview on WinX
File:DocumentView_MAUI.jpeg|Thumbnail preview on MAUI (iOS)
</gallery>
<br>
On WinX, the display mode for documents can be configured; available display modes are: <br>
* Gallery View (default)
* List View
* Flip View
<br>
[[File:DocumentView_DisplayMode.png]]

<br>Clicking on a document navigates to the corresponding object and opens the internal document viewer.
<gallery widths="400" heights="400">
File:DocumentViewer_WinX.png|Document Viewer on WinX Client
File:DocumentViewer_MAUI.jpeg|Document Viewer on Mobile Client (iOS)
</gallery>

A document can also be viewed by right-clicking on the object's thumbnail. This will open the document in an external editor provided by the operating system.
In this way, the document can also be edited externally. For more details, see [[Documents_(Client)#Editing|Editing]].

=== Viewing or Editing the Object Data ===

Not only the file itself can be viewed, but also the {{UBIK}} property values of a document object. The way properties are displayed depends on the client being used. On the '''WinX''' client, the properties are shown directly on the right side of the document viewer. On the '''Mobile''' client, you need to switch to the Properties tab to view them.

<gallery widths="250" heights="400">
File:Properties_WinX.png|Document properties on WinX
File:Properties_MAUI.jpeg|Document properties on Mobile (iOS)
</gallery>

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== Creating Documents ==
Depending on the configuration of the {{UBIK}} data model and the [[ACM]], documents can be created as children for existing objects.
Via the context menu entry you can create such documents. (where it is configured)

{{Attention|File extensions are case-sensitive depending on the OS. On iOS and Android, file systems are case-sensitive, while on Windows, file systems are case-insensitive.}}

=== Taking a Picture ===
In certain cases, the camera can be used to take a picture and create a document for it - in this case, another "Take Picture" context menu entry is available.

=== Editing and Submitting the newly created Document ===
After either a document was chosen or a picture was taken, the newly created object is opened in a property view, allowing the user to abort the creation or to enter specific property values (e.g. for the description of the object) and finally save the object.

{{Version/WinXSince|3.6}} uploaded Document objects can potentially contain [[SYSCLS_FILEDETAILSCLASSIFICATION|detailed Information]] concerning the original file (e.g. file name, path)
{{Clear}}

=== File upload ===
Regarding the file upload, there is a mechanism [[File_Upload_Size_Restriction|FileUploadRestriction]] that ensures files only get uploaded if the file size is below the configured max upload size.

=== Synchronization ===
Depending on the connectivity mode, the next synchronization run will bring the new content and file to the server.

== Modify Documents ==

=== Redlining ===
[[HowTo:Make_a_Document_ready_for_Redlining|Redlining]] is the process of creating a modified or annotated version of an existing document.

To use this feature, click the “Annotation Tools” button in the document viewer toolbar at the top of the document.

After clicking “Annotation Tools”, the toolbar expands and provides several options for annotating the document, such as drawing freeform shapes, adding comments, selecting different colors ...

<gallery widths="400" heights="400">
File:Annotation_WinX.png|WinX
File:Annotation_MAUI.jpeg|Mobile (iOS)
</gallery>

The previous redlining number indicators are replaced by the [[Child_Document_Indicator_(Android)|child document indicators]]. {{Version/AndroidSince|2.4.5}}

=== Editing{{Version/WinXSince|2.5.4}} ===
[[File:Editing_WinX.png|Button to edit a document]]<br>

For [[SYSCLS_EDITABLEDOCUMENT|editable documents]], there is an {{key press|edit}} button in the top 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.}}
An alternative way to start editing is to right click on a document's thumbnail or clicking on the "open external" button inside of the document viewer, which immediately opens the document in an external editor (WinX). To start editing on the mobile client you have to use the left-swipe functionality on the object. The difference here is that there is no {{key press|save}} button and any changes are automatically saved (and committed if in online mode).

[[File:EditingMAUI.jpeg|350px|Left-swipe button Mobile Client]]
[[File:DocumentViewerButton_WinX.png|350px|Left-swipe button WinX Client]]

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== Image Editor ==
In {{UBIK}}, images can be edited using the UBIKImageEditor. When you navigate in a image object, the image editor opens automatically. (if configured)

<gallery widths="400" heights="400">
File:ImageEditor_WInX.png|ImageEditor on WinX Client
File:ImageEditor_MAUI.jpeg|ImageEditor on Mobile Client (iOS)
</gallery>

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== PDF Documents ==

=== PDF Renderers {{Version/WinXSince|4.6.0}} ===
The Syncfusion PDF control embedded in the WinX client can use two different renderers to render and display PDF documents.
* The standard Syncfusion renderer which uses [https://learn.microsoft.com/en-us/uwp/api/windows.data.pdf?view=winrt-26100 Windows.Data.PDF]
* [https://pdfium.googlesource.com/pdfium/ PDFium]
There can be issues for each renderer when dealing with certain documents. If that's the case, you can try changing the [[Settings#Content|PdfRenderer setting]] in the WinX client and see if the issue still persists.

{{Hint|Generally speaking, the PDFium renderer seems to be more performant in the majority cases. That's why it is the default option.}}

==== Syncfusion ====
When using this renderer, we have experienced an issue with certain PDF diagrams where certain texts change when you zoom in on the documents. Unfortunately, we are unaware of the reason of this issue and could not find public documentation on similar problems.

==== PDFium ====
* This renderer currently does not support digital signatures (e.g. created by [https://www.docusign.com Docusign]) unless they are flattened into the PDF documents.
* With this renderer selected, some documents in the Flip View might appear blank when zooming.

=== PDF Text Search ===
It is possible to search and highlight arbitrary texts in the {{UBIK}} PDF viewer. By clicking the magnifier button, an input field opens to search for specific text entries in the document. The results will be highlighted in the PDF file. By clicking the arrow buttons, it is possible to switch to the next and previous results. {{Version/XamarinSince|4.3.0}}

==== Automatic Text Search {{Version/XamarinSince|4.4.0}}{{Version/WinXSince|4.4.0}} ====
Using the [[SYSCLS_DOCUMENT_HIGHLIGHTING_CLASSIFICATION|Document Highlighting Classification]] A PDF document can search for a defined search term from its parents properties automatically as soon as it is being navigated to.

=== Remember Document Settings {{Version/WinXSince|4.9}} ===
By default, PDFViewer settings are not saved and always reset when reloading a document. The Remember Document Settings feature enables the automatic saving & preserving of the Zoom level, Annotation color, and Stroke width value within a {{UBIK}} session.
It can be configured in the [[Settings#Content|Settings]].
With this feature enabled, the PDFViewers Annotation color, Zoom level, and Stroke width value set by the user will be saved and preserved until the user changes them again.

If a document is configured with the [[SYSCLS_AUTO_ZOOM_CLASSIFICATION|Auto Zoom classification]], it will be overruled by the user's value as soon as the user sets it.
If an [[XAML#UBIKPdfViewer|AnnotationDefaultStrokeWidth]] value is configured, it will be overridden by the user's value as soon as the user sets it.

{{Attention|Saving the Zoom value with touch gestures is not supported. But the SaveZoomSettingsCommand can be used to save the Zoom value manually.}}

The SaveZoomSettingsCommand can be applied to a button as follows:
<source lang = "xml">
<pdfViewer:SfPdfViewerControl
Name="pdfViewer"
... />
<Button
Content="Save Zoom"
Command="{Binding ElementName=PdfViewer, Path=SaveZoomSettingsCommand}" />
</source>

=== 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 !!
|-
| [[File:UI_UWP_Fit_Mode_Default.png|240x225px]] || [[File:UI_UWP_Fit_Mode_Container.png|240x225px]] || [[File:UI_UWP_Fit_Mode_Width.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). }}

=== Auto zoom {{Version/WinXSince|4.6}}{{Version/XamarinSince|4.6}} ===
When a PDF document is displayed in UBIK, it's possible that [[SYSCLS_AUTO_ZOOM_CLASSIFICATION|an initial zoom level]] is configured and applied to that document.

{{Attention|The configured initial zoom level will be simply ignored if it's beyond the acceptable min/max zoom levels of the PDF viewer.}}

== Offline/Online ==

=== 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 again 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.

== See also ==
* [[HowTo:Create_a_new_Document_(UBIK_Android)]]
* [[HowTo:Make_a_Document_ready_for_Redlining]]
* [[SYSCLS_DOCUMENT]] (Classification)
* [[SYSCLS_FILEDOCUMENT]] (Classification)
* [[SYSCLS_EDITABLEDOCUMENT]] (Classification)
* [[SYSCLS_REDLINEDFILE]] (Classification)
* [[SYSCLS_DOCUMENT_HIGHLIGHTING_CLASSIFICATION]] (Classification)
* [[SYSCLS_URLDOCUMENT]] (Classification)
* [[SYSCLS_THUMBNAILEDDOCUMENT]] (Classification)
* [[SYSCLS_TEXTDOCUMENT]] (Classification)
* [[SYSCLS_OFFLINE_AVAILABLE_DOCUMENT]] (Classification)

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

Documents (Client)

2026-03-12T08:40:50Z

CWI: /* Viewing Documents */

[[DOCUMENT|Documents]] are [[:Category:UBIK Object|{{UBIK}} objects]] referencing a file, e.g. a PDF document.
Like other {{UBIK}} objects, they can be synchronized to the {{UBIK}} client.
{{UBIK}} supports and displays document objects and a bunch of actions related to them, including e.g. editing, redlining, creation, and thumbnails.

== Document Types ==

* Managed Document - Documents with a locally managed file.
* Linked Document - Documents with a file linked by an URL, not locally managed by {{UBIK}}.

== Viewing Documents ==

Available Documents can be viewed in the documents tab of the current object, they are displayed with a thumbnail preview. <br>

<gallery widths="400" heights="400">
File:DocumentView_WinX.png|WinX
File:DocumentView_MAUI.jpeg|MAUI (iOS)
</gallery>
<br>
On WinX, the display mode for documents can be configured; available display modes are: <br>
* Gallery View (default)
* List View
* Flip View
<br>
[[File:DocumentView_DisplayMode.png]]

<br>Clicking on a document navigates to the corresponding object and opens the internal document viewer.
<gallery widths="400" heights="400">
File:DocumentViewer_WinX.png|WinX
File:DocumentViewer_MAUI.jpeg|Mobile (iOS)
</gallery>

A document can also be viewed by right-clicking on the object's thumbnail. This will open the document in an external editor provided by the operating system.
In this way, the document can also be edited externally. For more details, see [[Documents_(Client)#Editing|Editing]].

=== Viewing/Editing the Object Data ===

Not only the file itself can be viewed, but also the {{UBIK}} property values of a document object. To access them, click on the document object.

The way properties are displayed depends on the client being used.

On the '''WinX''' client, the properties are shown directly on the right side of the screen.

On the '''Mobile''' client, you need to switch to the Properties tab to view them.

<gallery widths="400" heights="400">
File:Properties_WinX.png|WinX
File:Properties_MAUI.jpeg|Mobile (iOS)
</gallery>

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

== Creating Documents ==
Depending on the configuration of the {{UBIK}} data model and the [[ACM]], documents can be created as children for existing objects.
Via the context menu entry you can create such documents. (where it is configured)

{{Attention|File extensions are case-sensitive depending on the OS. On iOS and Android, file systems are case-sensitive, while on Windows, file systems are case-insensitive.}}

=== Taking a Picture ===
In certain cases, the camera can be used to take a picture and create a document for it - in this case, another "Take Picture" context menu entry is available.

=== Editing and Submitting the newly created Document ===
After either a document was chosen or a picture was taken, the newly created object is opened in a property view, allowing the user to abort the creation or to enter specific property values (e.g. for the description of the object) and finally save the object.

{{Version/WinXSince|3.6}} uploaded Document objects can potentially contain [[SYSCLS_FILEDETAILSCLASSIFICATION|detailed Information]] concerning the original file (e.g. file name, path)
{{Clear}}

=== File upload ===
Regarding the file upload, there is a mechanism [[File_Upload_Size_Restriction|FileUploadRestriction]] that ensures files only get uploaded if the file size is below the configured max upload size.

=== Synchronization ===
Depending on the connectivity mode, the next synchronization run will bring the new content and file to the server.

== Modify Documents ==

=== Redlining ===
[[HowTo:Make_a_Document_ready_for_Redlining|Redlining]] is the process of creating a modified or annotated version of an existing document.

To use this feature, click the “Annotation Tools” button in the document viewer toolbar at the top of the document.

After clicking “Annotation Tools”, the toolbar expands and provides several options for annotating the document, such as drawing freeform shapes, adding comments, selecting different colors ...

<gallery widths="400" heights="400">
File:Annotation_WinX.png|WinX
File:Annotation_MAUI.jpeg|Mobile (iOS)
</gallery>

The previous redlining number indicators are replaced by the [[Child_Document_Indicator_(Android)|child document indicators]]. {{Version/AndroidSince|2.4.5}}

=== Editing{{Version/WinXSince|2.5.4}} ===
[[File:Editing_WinX.png|Button to edit a document]]<br>

For [[SYSCLS_EDITABLEDOCUMENT|editable documents]], there is an {{key press|edit}} button in the top 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.}}
An alternative way to start editing is to right click on a document's thumbnail, which immediately opens the document in an external editor. The difference here is that there is no {{key press|save}} button and any changes are automatically saved (and committed if in online mode).

== Image Editor ==
In {{UBIK}}, images can be edited using the UBIKImageEditor. When you navigate in a image object, the image editor opens automatically. (if configured)

The editor provides several options for modifying the image.

<gallery widths="400" heights="400">
File:ImageEditor_WInX.png|WinX
File:ImageEditor_MAUI.jpeg|Mobile (iOS)
</gallery>

== PDF Documents ==

=== PDF Renderers {{Version/WinXSince|4.6.0}} ===
The Syncfusion PDF control embedded in the WinX client can use two different renderers to render and display PDF documents.
* The standard Syncfusion renderer which uses [https://learn.microsoft.com/en-us/uwp/api/windows.data.pdf?view=winrt-26100 Windows.Data.PDF]
* [https://pdfium.googlesource.com/pdfium/ PDFium]
There can be issues for each renderer when dealing with certain documents. If that's the case, you can try changing the [[Settings#Content|PdfRenderer setting]] in the WinX client and see if the issue still persists.

{{Hint|Generally speaking, the PDFium renderer seems to be more performant in the majority cases. That's why it is the default option.}}

==== Syncfusion ====
When using this renderer, we have experienced an issue with certain PDF diagrams where certain texts change when you zoom in on the documents. Unfortunately, we are unaware of the reason of this issue and could not find public documentation on similar problems.

==== PDFium ====
* This renderer currently does not support digital signatures (e.g. created by [https://www.docusign.com Docusign]) unless they are flattened into the PDF documents.
* With this renderer selected, some documents in the Flip View might appear blank when zooming.

=== PDF Text Search ===
It is possible to search and highlight arbitrary texts in the {{UBIK}} PDF viewer. By clicking the magnifier button, an input field opens to search for specific text entries in the document. The results will be highlighted in the PDF file. By clicking the arrow buttons, it is possible to switch to the next and previous results. {{Version/XamarinSince|4.3.0}}

==== Automatic Text Search {{Version/XamarinSince|4.4.0}}{{Version/WinXSince|4.4.0}} ====
Using the [[SYSCLS_DOCUMENT_HIGHLIGHTING_CLASSIFICATION|Document Highlighting Classification]] A PDF document can search for a defined search term from its parents properties automatically as soon as it is being navigated to.

=== Remember Document Settings {{Version/WinXSince|4.9}} ===
By default, PDFViewer settings are not saved and always reset when reloading a document. The Remember Document Settings feature enables the automatic saving & preserving of the Zoom level, Annotation color, and Stroke width value within a {{UBIK}} session.
It can be configured in the [[Settings#Content|Settings]].
With this feature enabled, the PDFViewers Annotation color, Zoom level, and Stroke width value set by the user will be saved and preserved until the user changes them again.

If a document is configured with the [[SYSCLS_AUTO_ZOOM_CLASSIFICATION|Auto Zoom classification]], it will be overruled by the user's value as soon as the user sets it.
If an [[XAML#UBIKPdfViewer|AnnotationDefaultStrokeWidth]] value is configured, it will be overridden by the user's value as soon as the user sets it.

{{Attention|Saving the Zoom value with touch gestures is not supported. But the SaveZoomSettingsCommand can be used to save the Zoom value manually.}}

The SaveZoomSettingsCommand can be applied to a button as follows:
<source lang = "xml">
<pdfViewer:SfPdfViewerControl
Name="pdfViewer"
... />
<Button
Content="Save Zoom"
Command="{Binding ElementName=PdfViewer, Path=SaveZoomSettingsCommand}" />
</source>

=== 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 !!
|-
| [[File:UI_UWP_Fit_Mode_Default.png|240x225px]] || [[File:UI_UWP_Fit_Mode_Container.png|240x225px]] || [[File:UI_UWP_Fit_Mode_Width.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). }}

=== Auto zoom {{Version/WinXSince|4.6}}{{Version/XamarinSince|4.6}} ===
When a PDF document is displayed in UBIK, it's possible that [[SYSCLS_AUTO_ZOOM_CLASSIFICATION|an initial zoom level]] is configured and applied to that document.

{{Attention|The configured initial zoom level will be simply ignored if it's beyond the acceptable min/max zoom levels of the PDF viewer.}}

== Offline/Online ==

=== 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 again 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.

== See also ==
* [[HowTo:Create_a_new_Document_(UBIK_Android)]]
* [[HowTo:Make_a_Document_ready_for_Redlining]]
* [[SYSCLS_DOCUMENT]] (Classification)
* [[SYSCLS_FILEDOCUMENT]] (Classification)
* [[SYSCLS_EDITABLEDOCUMENT]] (Classification)
* [[SYSCLS_REDLINEDFILE]] (Classification)
* [[SYSCLS_DOCUMENT_HIGHLIGHTING_CLASSIFICATION]] (Classification)
* [[SYSCLS_URLDOCUMENT]] (Classification)
* [[SYSCLS_THUMBNAILEDDOCUMENT]] (Classification)
* [[SYSCLS_TEXTDOCUMENT]] (Classification)
* [[SYSCLS_OFFLINE_AVAILABLE_DOCUMENT]] (Classification)

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

Documents (Client)

2026-03-12T08:39:10Z

CWI:

[[DOCUMENT|Documents]] are [[:Category:UBIK Object|{{UBIK}} objects]] referencing a file, e.g. a PDF document.
Like other {{UBIK}} objects, they can be synchronized to the {{UBIK}} client.
{{UBIK}} supports and displays document objects and a bunch of actions related to them, including e.g. editing, redlining, creation, and thumbnails.

== Document Types ==

* Managed Document - Documents with a locally managed file.
* Linked Document - Documents with a file linked by an URL, not locally managed by {{UBIK}}.

== Viewing Documents ==

Available Documents can be viewed in the documents tab of the current object, they are displayed with a thumbnail preview. <br>

<gallery widths="400" heights="400">
File:DocumentView_WinX.png|WinX
File:DocumentView_MAUI.jpeg|MAUI (iOS)
</gallery>
<br>
On WinX, the display mode for documents can be configured, available display modes (WinX only): <br>
* Gallery View (default)
* List View
* Flip View
<br>
[[File:DocumentView_DisplayMode.png]]

<br>Clicking on a document navigates to the corresponding object and opens the internal document viewer.
<gallery widths="400" heights="400">
File:DocumentViewer_WinX.png|WinX
File:DocumentViewer_MAUI.jpeg|Mobile (iOS)
</gallery>

A document can also be viewed by right-clicking on the object's thumbnail. This will open the document in an external editor provided by the operating system.
In this way, the document can also be edited externally. For more details, see [[Documents_(Client)#Editing|Editing]].

=== Viewing/Editing the Object Data ===

Not only the file itself can be viewed, but also the {{UBIK}} property values of a document object. To access them, click on the document object.

The way properties are displayed depends on the client being used.

On the '''WinX''' client, the properties are shown directly on the right side of the screen.

On the '''Mobile''' client, you need to switch to the Properties tab to view them.

<gallery widths="400" heights="400">
File:Properties_WinX.png|WinX
File:Properties_MAUI.jpeg|Mobile (iOS)
</gallery>

== Creating Documents ==
Depending on the configuration of the {{UBIK}} data model and the [[ACM]], documents can be created as children for existing objects.
Via the context menu entry you can create such documents. (where it is configured)

{{Attention|File extensions are case-sensitive depending on the OS. On iOS and Android, file systems are case-sensitive, while on Windows, file systems are case-insensitive.}}

=== Taking a Picture ===
In certain cases, the camera can be used to take a picture and create a document for it - in this case, another "Take Picture" context menu entry is available.

=== Editing and Submitting the newly created Document ===
After either a document was chosen or a picture was taken, the newly created object is opened in a property view, allowing the user to abort the creation or to enter specific property values (e.g. for the description of the object) and finally save the object.

{{Version/WinXSince|3.6}} uploaded Document objects can potentially contain [[SYSCLS_FILEDETAILSCLASSIFICATION|detailed Information]] concerning the original file (e.g. file name, path)
{{Clear}}

=== File upload ===
Regarding the file upload, there is a mechanism [[File_Upload_Size_Restriction|FileUploadRestriction]] that ensures files only get uploaded if the file size is below the configured max upload size.

=== Synchronization ===
Depending on the connectivity mode, the next synchronization run will bring the new content and file to the server.

== Modify Documents ==

=== Redlining ===
[[HowTo:Make_a_Document_ready_for_Redlining|Redlining]] is the process of creating a modified or annotated version of an existing document.

To use this feature, click the “Annotation Tools” button in the document viewer toolbar at the top of the document.

After clicking “Annotation Tools”, the toolbar expands and provides several options for annotating the document, such as drawing freeform shapes, adding comments, selecting different colors ...

<gallery widths="400" heights="400">
File:Annotation_WinX.png|WinX
File:Annotation_MAUI.jpeg|Mobile (iOS)
</gallery>

The previous redlining number indicators are replaced by the [[Child_Document_Indicator_(Android)|child document indicators]]. {{Version/AndroidSince|2.4.5}}

=== Editing{{Version/WinXSince|2.5.4}} ===
[[File:Editing_WinX.png|Button to edit a document]]<br>

For [[SYSCLS_EDITABLEDOCUMENT|editable documents]], there is an {{key press|edit}} button in the top 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.}}
An alternative way to start editing is to right click on a document's thumbnail, which immediately opens the document in an external editor. The difference here is that there is no {{key press|save}} button and any changes are automatically saved (and committed if in online mode).

== Image Editor ==
In {{UBIK}}, images can be edited using the UBIKImageEditor. When you navigate in a image object, the image editor opens automatically. (if configured)

The editor provides several options for modifying the image.

<gallery widths="400" heights="400">
File:ImageEditor_WInX.png|WinX
File:ImageEditor_MAUI.jpeg|Mobile (iOS)
</gallery>

== PDF Documents ==

=== PDF Renderers {{Version/WinXSince|4.6.0}} ===
The Syncfusion PDF control embedded in the WinX client can use two different renderers to render and display PDF documents.
* The standard Syncfusion renderer which uses [https://learn.microsoft.com/en-us/uwp/api/windows.data.pdf?view=winrt-26100 Windows.Data.PDF]
* [https://pdfium.googlesource.com/pdfium/ PDFium]
There can be issues for each renderer when dealing with certain documents. If that's the case, you can try changing the [[Settings#Content|PdfRenderer setting]] in the WinX client and see if the issue still persists.

{{Hint|Generally speaking, the PDFium renderer seems to be more performant in the majority cases. That's why it is the default option.}}

==== Syncfusion ====
When using this renderer, we have experienced an issue with certain PDF diagrams where certain texts change when you zoom in on the documents. Unfortunately, we are unaware of the reason of this issue and could not find public documentation on similar problems.

==== PDFium ====
* This renderer currently does not support digital signatures (e.g. created by [https://www.docusign.com Docusign]) unless they are flattened into the PDF documents.
* With this renderer selected, some documents in the Flip View might appear blank when zooming.

=== PDF Text Search ===
It is possible to search and highlight arbitrary texts in the {{UBIK}} PDF viewer. By clicking the magnifier button, an input field opens to search for specific text entries in the document. The results will be highlighted in the PDF file. By clicking the arrow buttons, it is possible to switch to the next and previous results. {{Version/XamarinSince|4.3.0}}

==== Automatic Text Search {{Version/XamarinSince|4.4.0}}{{Version/WinXSince|4.4.0}} ====
Using the [[SYSCLS_DOCUMENT_HIGHLIGHTING_CLASSIFICATION|Document Highlighting Classification]] A PDF document can search for a defined search term from its parents properties automatically as soon as it is being navigated to.

=== Remember Document Settings {{Version/WinXSince|4.9}} ===
By default, PDFViewer settings are not saved and always reset when reloading a document. The Remember Document Settings feature enables the automatic saving & preserving of the Zoom level, Annotation color, and Stroke width value within a {{UBIK}} session.
It can be configured in the [[Settings#Content|Settings]].
With this feature enabled, the PDFViewers Annotation color, Zoom level, and Stroke width value set by the user will be saved and preserved until the user changes them again.

If a document is configured with the [[SYSCLS_AUTO_ZOOM_CLASSIFICATION|Auto Zoom classification]], it will be overruled by the user's value as soon as the user sets it.
If an [[XAML#UBIKPdfViewer|AnnotationDefaultStrokeWidth]] value is configured, it will be overridden by the user's value as soon as the user sets it.

{{Attention|Saving the Zoom value with touch gestures is not supported. But the SaveZoomSettingsCommand can be used to save the Zoom value manually.}}

The SaveZoomSettingsCommand can be applied to a button as follows:
<source lang = "xml">
<pdfViewer:SfPdfViewerControl
Name="pdfViewer"
... />
<Button
Content="Save Zoom"
Command="{Binding ElementName=PdfViewer, Path=SaveZoomSettingsCommand}" />
</source>

=== 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 !!
|-
| [[File:UI_UWP_Fit_Mode_Default.png|240x225px]] || [[File:UI_UWP_Fit_Mode_Container.png|240x225px]] || [[File:UI_UWP_Fit_Mode_Width.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). }}

=== Auto zoom {{Version/WinXSince|4.6}}{{Version/XamarinSince|4.6}} ===
When a PDF document is displayed in UBIK, it's possible that [[SYSCLS_AUTO_ZOOM_CLASSIFICATION|an initial zoom level]] is configured and applied to that document.

{{Attention|The configured initial zoom level will be simply ignored if it's beyond the acceptable min/max zoom levels of the PDF viewer.}}

== Offline/Online ==

=== 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 again 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.

== See also ==
* [[HowTo:Create_a_new_Document_(UBIK_Android)]]
* [[HowTo:Make_a_Document_ready_for_Redlining]]
* [[SYSCLS_DOCUMENT]] (Classification)
* [[SYSCLS_FILEDOCUMENT]] (Classification)
* [[SYSCLS_EDITABLEDOCUMENT]] (Classification)
* [[SYSCLS_REDLINEDFILE]] (Classification)
* [[SYSCLS_DOCUMENT_HIGHLIGHTING_CLASSIFICATION]] (Classification)
* [[SYSCLS_URLDOCUMENT]] (Classification)
* [[SYSCLS_THUMBNAILEDDOCUMENT]] (Classification)
* [[SYSCLS_TEXTDOCUMENT]] (Classification)
* [[SYSCLS_OFFLINE_AVAILABLE_DOCUMENT]] (Classification)

[[Category:Android|Documents (UBIK Android)]]
[[Category:Client|Documents (Client)]]
[[Category:Document|Documents (UBIK Android)]]
[[Category:Mobile|Documents (Client)]]
[[Category:Pages with broken file links|Documents (Client)]]
[[Category:WinX|Documents (Client)]]

Version 5.1 (WinX)

2026-03-02T10:29:54Z

CWI: /* Release */

{{Attention|This version requires [https://en.wikipedia.org/wiki/Windows_10_version_history#Version_1809_(October_2018_Update) Windows 10 build 17763] or higher}}

== Availability ==
{{key press|Store}}: Publicly available in Microsoft Store.

{{key press|Store Beta}} / {{key press|Store Preview}}: Publicly available in Microsoft Store as beta or preview versions to those whose account email is participating in our beta or preview test. To join, please send an email to testing@augmensys.com and provide an email address to add to the list as well as the information which test you want to join. Alternatively you can contact the Augmensys staff and submit your chosen email address.

Example: Please add my email account example@example.com to the '''Beta''' test group for the '''WinX''' client.

<br/>
{{Attention|Some customized XAMLs might need an update to work properly. These changes are marked with ⚠️}}

= Release Notes =

== Release ==
=== 5.1.?? on 2026-??-?? ===
* Replaced app closing after repeated failed login attempts with a client-side temporary login block, including user feedback that indicates when login becomes available again.
* Added French localization to the app.
* Provided a visual difference between suggested and actual values in DateTime and Geo property direct edit fields via a [[XAML#Custom_VisualState_Trigger|Custom VisualState Trigger]].

=== 5.1.6 on 2026-02-10 ===
* UBIK now uses industry-standard JSON Web Token (JWT) technology for authorization, enhancing security and reliability. Session tokens are transmitted via HTTP headers instead of URLs for improved protection.
* Added support for conditionally showing the ImageEditor Save button only when edits have been made, enabled when MergeAnnotationsOnSave is set to true.
* Added support for [[File_Upload_Size_Restriction|configurable file-upload size restrictions]], preventing oversized files from being uploaded and providing users with feedback when limits are exceeded.
* Fixed an issue where certain documents couldn't be loaded anymore.
* Fixed an issue where annotated image documents do not appear as changed until the UI refreshes.
* Fixed an issue where displayed file content does not update after you revert its changes.
* The UI now updates correctly after mass deletion in multi-selection mode.
* Fixed an issue where the UI did not update properly when committing a direct edit input task.
* Fixed an issue where toggling NA in the String Editor did not behave correctly.
* Fixed an issue where the Chart Thresholds didn't update.
* Added a [[XAML#UBIKWebView|UBIKWebView]] control that includes a fix in the WebView2 where some links could not be opened.
* Fixed issue that caused input fields to be focused but not editable.
* Fixed an issue where document creation might not be properly enabled in certain customizing scenarios. For example, a media creation button might be disabled until a page refresh.
* Fixed an issue where batch creating documents (by multi selecting files to attach) can be interrupted if you leave the page.

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

== Known issues ==
* Due to third-party limitations, the feature that shows the ImageEditor Save button only when edits have been made is only active when MergeAnnotationsOnSave is set to true.
* When editing Guid Link properties, you can no longer further edit the filtering if there are predefined filter parameters (such as the [[Dynamic_Selective_List_(Client)#Dependency_property_values|dependency property values in dynamic selective lists]]). This is because those parameters are to be enforced by design and should not be changed by users. In the future, we might consider a finer level of control over which parameters can be edited in such cases.
* Free Text Annotations that where created in former sessions cannot be selected and therefore cannot be edited any more.
* There are still some [[Annotation_and_HotSpot#Known_issues|known issues with free text and text markup annotations]].
* Known issues regarding the [[Documents_(Client)#Remember_Document_Settings|Remember Document Settings]] feature:
** Saving the Zoom value via touch gestures is not supported.
** Due to a third-party framework issue it can't be guaranteed that saving the Zoom level is always working properly. We reported this issue and will update our solution as soon as it is resolved on their side.
<br/>

= ⚠️ XAML Notes =

<headertabs />

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

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

XAML

2026-03-02T10:24:50Z

CWI: /* Custom VisualState Trigger {{Version/WinXSince|5.1.1}} */

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="Mobile(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''), or if they should be merged directly into the original file (''true'', this is the default option): {{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 button can be hidden with SaveButtonVisibility="Collapsed"
* The Annotation button can be hidden with AnnotationButtonVisibility="Collapsed"
* The HS button can be hidden with HotspotButtonVisibility="Collapsed"
* The undo and redo operations can be turned on/off with IsUndoEnabled="true/false". The default value is false. When turned off, the two relevant buttons will be hidden in the toolbar. {{Version/WinXSince|4.4}}

{{Attention|Please be careful when you enable undo and redo. Because {{key press|Ctrl}} + {{key press|Z}} (or whichever other combination in your keyboard layout) is the shortcut to trigger an undo. Therefore, it's possible that you accidentally undo/revert your changes in the PDF viewer when you are typing.}}

* The default stroke width for Annotations can be defined with the AnnotationDefaultStrokeWidth property in the UBIKThemes.xaml:
<source lang = "xml">
<x:Double x:Key="AnnotationDefaultStrokeWidth">1</x:Double>
</source>
</tab>

<tab name="Mobile(Xamarin)">
On a Xamarin UBIKPdfViewer instance (e.g. in the UBIKDocumentContentArea template), you can configure its EnableSeparateInkStrokes value.
* True (default): Every ink stroke has its own session. You can select it and change its color/thickness/transparency/etc. separately from others.
* False: If you do not end the session explicitly by exiting the ink mode, all strokes belong in the same session. And they can only be interacted with as a whole.
<source lang = "xml">
xmlns:ctrls="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL"
<ctrls:UBIKPdfViewer
...
EnableSeparateInkStrokes="True" />
</source>
</tab>

</tabs>

==== UBIKWebView {{Version/WinXSince|5.1}} ====
As there is a bug in the WebView2 (only in WinX/UWP) where specific links cannot be opened, we introduced the UBIKWebView, which contains a workaround for this issue.
<br>
Example:
<source lang = "xml">
xmlns:ctrls="using:UBIK.WinX.UI.Controls"
<ctrls:UBIKWebView x:Name="WebContent" Source="{Binding DocumentViewModel.OnlineURI}" />
</source>

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

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

== 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 ==
Working with Properties is a foundational role of the UI customizer. Be aware that the term can refer to various elements of a content object's datamodel, including details like its Title, SubTitle, UID, classification info, etc. However, this article deals specifically with '''content properties'''; those which are displayed under the Property tab in the UBIK client.

=== Displaying Properties ===
Displaying with properties is an extremely common requirement in custom UIs. UBIK offers several different bindings, each with specific benefits. It may be enough to simply display the value of a simple string or numeric property somewhere in your UI, or else you might need to display complex properties or execute a certain property-based command.

The table below clarifies the various functionalities and how they can best be used in different scenarios.

It is important to note that for these bindings we are assuming a content viewmodel (ie. an object observed in the client, either after navigating to it, or else when viewing it as an item in the child list of another content object).

{| class="wikitable"
! Collection !! {{Tooltip|Performance|Could rendering be slowed down by using this binding, especially on ItemTemplates used in a list of many items.}} !! {{Tooltip|Capability|Extent of the viewmodel accessed}} !! {{Tooltip|Lazy-Loaded|Loaded on-demand (vs. always present)}}
|-
| Values || Great || Very limited - Read only, Property value only || No
|-
| PropertyItems || Good || Limited - Read only || No
|-
| PropertyByName || Ok up to 5 uses || Unlimited - Full PropertyViewModel || Yes
|-
| Properties.XItems || Impacted || Unlimited - Full PropertyViewModel || Yes
|-
|}

==== Values[MP_PROPERTY] ====
* This is the most basic and performant way to bind to a property value.
* This collection simply displays the 'true' value of a property, meaning that it is only useful displaying for simple properties, such as String, Int, Dbl, unformatted DateTime, etc. Properties that have a DisplayValue that is different from their true value, such as GUIDs or selective list items with labels, are not best displayed using this binding.
* For complex iproperties, it can be still be used in the xaml for non-display purposes, such as in combination with converters or commands. It is immediately present on the most basic content viewmodel (the ContentListItemViewModels used by child lists) without having to be loaded, and remains the best choice in most cases.

<tabs>
<tab name="Don't Do">
<source lang = "XML">
Command="{Binding NavigateToGuidCommand}" Command Parameter="{Binding Properties.AllItems[MP_GUID].Value}"
</source>
</tab>
<tab name="Instead do">
<source lang = "XML">
Command="{Binding NavigateToGuidCommand}" Command Parameter="{Binding Values[MP_GUID]}"
</source>
</tab>
</tabs>

==== PropertyItems[MP_PROPERTY]... ====
This collection can be used when the Value collection does not suffice for displaying appropriate values. This PropertyViewModel presents more options than the simple Values collection, however, <u>it should still only be used for displaying text in the UI</u> as it bypasses the modern functionality offered by UBIK, such as user rights, locked states, etc.

==== Properties.XItems[MP_PROPERTY]... ====
These collections were created as a response to the criticism that earlier collections like Values and PropertyItems did not expose enough of a content object's viewmodel to be useful to our ever more sophisticated custom UIs. These collections now provide the full PropertyViewModel, where all aspects of a property (including ''it's'' properties, such as Unit attached to Double, the seperate Min/Value/Max valueitems, Date and Time extracted from the DateTime property, Lon/Lat or Alt extracted from the Geo property, and many more) can be accessed in Bindings.
* However, the downside of accessing this huge viewmodel is the noticeable performance impact, as it loads all instances of properties for the context object, even though only one (MP_PROPERTY) is requested. This impact is felt especially when such as binding is used on an item template in a list with many content objects, of which each has many properties.
* These collections are [[Fast_Startup_(Client)|Lazy Loaded]]*, which means that they are not loaded by default, however, a single binding to that collection will load it. When used on an item template in a list, all viewmodels for all properties for all child items will simultaneously be loaded, leading to the performance impact described in this article.
* "Properties.XItems" is not a real collection. The most frequently used collections are Properties.AllItems, Properties.VisibleItems, Properties.EditableItems, and Properties.ImportantItems (properties which fall into the [[UBIK_WinX_Client_Basics#High_priority_properties|Priority threshold]]). The number of properties delivered to a content object in each collection (for example; all, 80%, 40% and 10%, respectively) is also a consideration when estimating the performance impact of binding to these collections; simply put, use the smallest collection possible where the desired property is consistently located.

==== PropertyByName[MP_PROPERTY]... ====
This collection was created to overcome the performance impact arising from using Properties.XItems, by individually loading the PropertyViewModel for the named property. However, note that the benefit only lasts while the binding is used sparingly; rendering performance will be roughly the same as loading the Properties collection after 3-5 uses on a single item template.

{{Hint|The Values[ ] collection delivers the property's value as a string. The equivalent for the other bindings (above shown as '...') is <code>{Binding Collection[PROPERTY_NAME].'''DisplayValue'''}</code>, however, the capability of these viewmodels goes far beyond the DisplayValue. Use [[Developer_Mode]] to learn more.}}

==== * Troubleshooting null property values ====
Because certain property collections are Lazy-loaded as described above, it may be the case that bindings to these properties appear null in certain circumstances, especially if the collection is loaded after the page is rendered, such as through a command or behavior. To troubleshoot this issue, you can ensure that the property collection is accessed during rendertime rather than runtime (simply put, while the page is being constructed rather than during normal use) by applying the same binding to, for example, a Label. This measure should still work if the Label is hidden from view using a visibility binding.

=== Editing Properties ===
There are currently 3 main ways to trigger property editing (aside from direct editing) in XAML:
* [[EditPropertyValueCommand]] uses a MetaProperty name as a parameter, to trigger the editing dialogue for that metaproperty.
** It is located on the ContentViewModel, and automatically triggers a Save and Commit once the edit is confirmed.
* Similarly, the (PropertyViewModel).ShowEditorCommand/.PropertyClickedCommand triggers the editing dialogue, however, being located on the PropertyViewModel, it is necessary to first access a single property, such as by triggering the command on a list item template, or by directly binding to a specific one using a metaproperty indexer.
** These two commands are equivalent, the ShowEditorCommand being more general and redirecting for Live Values or properties with Value Records, or else triggering the PropertyClickedCommand.
** These commands can be seen in action as the standard UI for properties when clicking on the icon to trigger "indirect" editing for any individual metaproperty.
** Property changes are not saved automatically, but set the ToSave flag on the ContentViewModel, meaning that a SaveAndCommit command is required to commit the changes.
* The [[XAML_Tips#SetPropertyValueCommand|Set Property Value Command]] sets a named property to a specific or calculated (such as through an [[EvalExpression]]) value.

== 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="Mobile(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. Similarly, audio document creation requires a file type "*.wav" to be included in the selective list.}}

* 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.

== Object Filtering ==
Filtering of objects is a common requirement in UBIK projects. The table below shows the three main approaches, with the functionality each offers.

{| class="wikitable"
! Type !! Configuration/Requirements !! {{Tooltip|Persisted|Filter criteria are retained when navigating, or even closing the client.}} !! {{Tooltip|Multiple/Complex Values|Multiple user inputs supported for a single filter property.}} !! {{Tooltip|Property type|Data elements supported as filter properties.}} !! {{Tooltip|Possible Item Source|Collections supported as item sources.}}
|-
| Query || Fully defined on the server || Yes || Limited (DateTime, Dbl, Int) where a range is possible. || {{Tooltip|Content properties|The kind displayed in the Property tab of the UBIK client}} only || {{Tooltip|Content objects|The kind displayed in the Children tab of the UBIK client}}, Documents
|-
| Property-Based Content Filters || Defined in XAML, requires custom [[SYSCLS_CHILDAREATEMPLATE|Child Area template name]] || Yes || No || {{Tooltip|Content properties|The kind displayed in the Property tab of the UBIK client}} only || {{Tooltip|Content objects|The kind displayed in the Children tab of the UBIK client}} only
|-
| Dynamic Filters || Fully defined in XAML || No || Yes || Any bindable data (eg. Content properties, metadefinitions, etc). || Content objects, Properties, Documents, etc
|-
|}

A [[Query]] is a container that delivers a defined collection of content objects. Properties can be added to the query to serve as filter criteria, where a user can perform their search by editing these properties.

[[Property_Based_Content_Filters]] are a xaml-based customization that connects a user input control (usually a textbox) with a specific content property on the content object. This user input is converted into filter criteria and applied directly to the child list, where only matched objects are retained.

[[HowTo:Implement_Custom_Filtering|Dynamic Filtering]] is the most flexible, but also the most complex, method of XAML-based filtering. A set of [[EvalExpression|EvalExpressions]] converts user inputs into a complex filter string, which is then applied immediately to whichever ItemsSource is defined in the [[XAML_Changes_in_UBIK_WinX_3.5#Filtering_by_expressions|ListCollectionView]]/[[Xamarin_XAML#FeatureRelated|SfDataSourceExt]]. Note that in this approach, user inputs are not directly connected to any data, which means that reloading the page in any way (eg. by navigation) causes the input controls to return to their xaml-defined state.

{{Attention|While any of the above approaches can be used, it is never recommended to mix approaches, as this causes multiple rounds of filtering per keystroke that will noticeably impact performance, especially when many objects and filters are involved!}}

== Miscellaneous ==
<br>

=== Behaviors in style definitions ===
It's very common and easy to attach behaviors to different UI controls to extend their functionalities. For example, see [[#Advanced_2|StringFormatConverter]].

For better code reusability, it's sometimes necessary to implement the functionality of a control in a style so that it can be applied to the same control used in various occasions. In this case, the regular behaviors won't work and you have to use a special type AttachBehavior with some limitations. Below is such an example.

<tabs>
<tab name="UWP">
In this example, a style for the Grid control is defined with a behavior which executes the EditPropertyValueCommand upon tapped. There are two things to note here:
* When attaching multiple behaviors to controls, you have to explicitly declare a BehaviorCollection and place all behaviors underneath. Unlike outside of style definitions, this is mandatory. Without it, only the last behavior will be effective.
* Bindings work the same way in general. However, it's not possible to bind to named elements through the <code>"{Binding ElementName=someName, Path=..."</code> syntax and there doesn't seem to be a way to achieve similar goals.
<source lang = "xml">
xmlns:behaviors="using:UBIK.WinX.Behaviors"
xmlns:core="using:Microsoft.Xaml.Interactions.Core"
<Style x:Key="UBIKNamePropertyGrid" TargetType="Grid">
<Setter Property="behaviors:AttachBehavior.Behaviors">
<Setter.Value>
<behaviors:BehaviorCollection>
<core:EventTriggerBehavior EventName="Tapped">
<core:InvokeCommandAction Command="{Binding EditPropertyValueCommand}" CommandParameter="MP_NAME" />
</core:EventTriggerBehavior>
</behaviors:BehaviorCollection>
</Setter.Value>
</Setter>
</Style>
</source>
</tab>
</tabs>
<br>

=== Custom VisualState Trigger {{Version/WinXSince|5.1}} ===
The '''UBIKStateObserverTrigger''' (UWP only) is a custom State trigger that allows activating a Visual State based on a value. The trigger compares the '''StateObserver''' value with the specified '''ExpectedValue'''. If both values are equal, the corresponding VisualState becomes active. This enables clean, template-based UI state changes without attaching behaviors directly to controls. It is especially useful in scenarios where behaviors cannot be reused in styles due to framework limitations.

Custom states should be placed in a separate VisualStateGroup. States within the same group are mutually exclusive. If combined with standard groups such as CommonStates (Normal, Focused, PointerOver, etc.), the custom state may be overridden.

<source lang = "xml">
xmlns:trigger="using:UBIK.WinX.Trigger"

<Style ...>
<Setter Property="Template">
<Setter.Value>
<ControlTemplate>
<Grid x:Name="ExampleGrid" />
<VisualStateManager.VisualStateGroups>
<VisualStateGroup x:Name="CustomStates">
<VisualState x:Name="CustomState">
<VisualState.StateTriggers>
<trigger:UBIKStateObserverTrigger StateObserver="{Binding ValueItem.PropertyValue.IsSuggestedValue}" ExpectedValue="True" />
</VisualState.StateTriggers>
<VisualState.Setters>
<Setter Target="ExampleGrid.Background" Value="Red" />
</VisualState.Setters>
</VisualState>
</VisualStateGroup>
</VisualStateManager.VisualStateGroups>
</ControlTemplate>
</Setter.Value>
</Setter>
</Style>
</source>

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

=== UBIKContentControl ===
In UWP XAML, one often uses a <code><ContentControl ... ContentTemplateSelector="{StaticResource TaskPropertyTemplateSelector}" /></code> to choose different templates depending on the binding context.
However, it seems to have its limit, namely the template selection happens only once at the beginning. In other words, the template will not change even when the binding context later changes and another template would be the choice.
For such scenarios, we have created a UBIKContentControl. See the example below.
<tabs>
<tab name="UWP">
When the IsLocked status changes on the ContentViewModel, the task direct edit template will be reselected.
<source lang = "xml">
xmlns:controls="using:UBIK.WinX.Controls"
<controls:UBIKContentControl
Content="{Binding MROViewModel}"
ContentTemplateSelector="{StaticResource TaskPropertyTemplateSelector}"
TemplateReselectTrigger="{Binding IsLocked}" />
</source>
</tab>
</tabs>
<br>

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

== Custom Icons ==
Moved to article [[XAML_Tips#Custom_Icons]].
<br>
<br>

== Differences between Mobile and UWP ==
As you maybe already noticed we have two different clients, one is WinX UWP and the other one Mobile, which is used to develop clients for three different platforms namely iOS, Android and Windows (-> it doesn’t really differentiate from the previously mentioned UWP except it’s developed in a different framework which is Maui 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 Mobile that you used in UWP.
More specific documentations about Mobile Customizing can be found under [[Mobile XAML]].

{{Attention|Please consider that Mobile Windows is not an official product and therefore it can't be guaranteed that all our features work without issues.}}

[[Category:Mobile|XAML]]
[[Category:WinX|XAML]]
[[Category:XAML|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:Mobile|XAML]]
[[Category:WinX|XAML]]
[[Category:XAML|XAML]]

XAML

2026-03-02T08:58:11Z

CWI: /* Custom VisualState Trigger {{Version/WinXSince|5.1.1}} */

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="Mobile(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''), or if they should be merged directly into the original file (''true'', this is the default option): {{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 button can be hidden with SaveButtonVisibility="Collapsed"
* The Annotation button can be hidden with AnnotationButtonVisibility="Collapsed"
* The HS button can be hidden with HotspotButtonVisibility="Collapsed"
* The undo and redo operations can be turned on/off with IsUndoEnabled="true/false". The default value is false. When turned off, the two relevant buttons will be hidden in the toolbar. {{Version/WinXSince|4.4}}

{{Attention|Please be careful when you enable undo and redo. Because {{key press|Ctrl}} + {{key press|Z}} (or whichever other combination in your keyboard layout) is the shortcut to trigger an undo. Therefore, it's possible that you accidentally undo/revert your changes in the PDF viewer when you are typing.}}

* The default stroke width for Annotations can be defined with the AnnotationDefaultStrokeWidth property in the UBIKThemes.xaml:
<source lang = "xml">
<x:Double x:Key="AnnotationDefaultStrokeWidth">1</x:Double>
</source>
</tab>

<tab name="Mobile(Xamarin)">
On a Xamarin UBIKPdfViewer instance (e.g. in the UBIKDocumentContentArea template), you can configure its EnableSeparateInkStrokes value.
* True (default): Every ink stroke has its own session. You can select it and change its color/thickness/transparency/etc. separately from others.
* False: If you do not end the session explicitly by exiting the ink mode, all strokes belong in the same session. And they can only be interacted with as a whole.
<source lang = "xml">
xmlns:ctrls="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL"
<ctrls:UBIKPdfViewer
...
EnableSeparateInkStrokes="True" />
</source>
</tab>

</tabs>

==== UBIKWebView {{Version/WinXSince|5.1}} ====
As there is a bug in the WebView2 (only in WinX/UWP) where specific links cannot be opened, we introduced the UBIKWebView, which contains a workaround for this issue.
<br>
Example:
<source lang = "xml">
xmlns:ctrls="using:UBIK.WinX.UI.Controls"
<ctrls:UBIKWebView x:Name="WebContent" Source="{Binding DocumentViewModel.OnlineURI}" />
</source>

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

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

== 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 ==
Working with Properties is a foundational role of the UI customizer. Be aware that the term can refer to various elements of a content object's datamodel, including details like its Title, SubTitle, UID, classification info, etc. However, this article deals specifically with '''content properties'''; those which are displayed under the Property tab in the UBIK client.

=== Displaying Properties ===
Displaying with properties is an extremely common requirement in custom UIs. UBIK offers several different bindings, each with specific benefits. It may be enough to simply display the value of a simple string or numeric property somewhere in your UI, or else you might need to display complex properties or execute a certain property-based command.

The table below clarifies the various functionalities and how they can best be used in different scenarios.

It is important to note that for these bindings we are assuming a content viewmodel (ie. an object observed in the client, either after navigating to it, or else when viewing it as an item in the child list of another content object).

{| class="wikitable"
! Collection !! {{Tooltip|Performance|Could rendering be slowed down by using this binding, especially on ItemTemplates used in a list of many items.}} !! {{Tooltip|Capability|Extent of the viewmodel accessed}} !! {{Tooltip|Lazy-Loaded|Loaded on-demand (vs. always present)}}
|-
| Values || Great || Very limited - Read only, Property value only || No
|-
| PropertyItems || Good || Limited - Read only || No
|-
| PropertyByName || Ok up to 5 uses || Unlimited - Full PropertyViewModel || Yes
|-
| Properties.XItems || Impacted || Unlimited - Full PropertyViewModel || Yes
|-
|}

==== Values[MP_PROPERTY] ====
* This is the most basic and performant way to bind to a property value.
* This collection simply displays the 'true' value of a property, meaning that it is only useful displaying for simple properties, such as String, Int, Dbl, unformatted DateTime, etc. Properties that have a DisplayValue that is different from their true value, such as GUIDs or selective list items with labels, are not best displayed using this binding.
* For complex iproperties, it can be still be used in the xaml for non-display purposes, such as in combination with converters or commands. It is immediately present on the most basic content viewmodel (the ContentListItemViewModels used by child lists) without having to be loaded, and remains the best choice in most cases.

<tabs>
<tab name="Don't Do">
<source lang = "XML">
Command="{Binding NavigateToGuidCommand}" Command Parameter="{Binding Properties.AllItems[MP_GUID].Value}"
</source>
</tab>
<tab name="Instead do">
<source lang = "XML">
Command="{Binding NavigateToGuidCommand}" Command Parameter="{Binding Values[MP_GUID]}"
</source>
</tab>
</tabs>

==== PropertyItems[MP_PROPERTY]... ====
This collection can be used when the Value collection does not suffice for displaying appropriate values. This PropertyViewModel presents more options than the simple Values collection, however, <u>it should still only be used for displaying text in the UI</u> as it bypasses the modern functionality offered by UBIK, such as user rights, locked states, etc.

==== Properties.XItems[MP_PROPERTY]... ====
These collections were created as a response to the criticism that earlier collections like Values and PropertyItems did not expose enough of a content object's viewmodel to be useful to our ever more sophisticated custom UIs. These collections now provide the full PropertyViewModel, where all aspects of a property (including ''it's'' properties, such as Unit attached to Double, the seperate Min/Value/Max valueitems, Date and Time extracted from the DateTime property, Lon/Lat or Alt extracted from the Geo property, and many more) can be accessed in Bindings.
* However, the downside of accessing this huge viewmodel is the noticeable performance impact, as it loads all instances of properties for the context object, even though only one (MP_PROPERTY) is requested. This impact is felt especially when such as binding is used on an item template in a list with many content objects, of which each has many properties.
* These collections are [[Fast_Startup_(Client)|Lazy Loaded]]*, which means that they are not loaded by default, however, a single binding to that collection will load it. When used on an item template in a list, all viewmodels for all properties for all child items will simultaneously be loaded, leading to the performance impact described in this article.
* "Properties.XItems" is not a real collection. The most frequently used collections are Properties.AllItems, Properties.VisibleItems, Properties.EditableItems, and Properties.ImportantItems (properties which fall into the [[UBIK_WinX_Client_Basics#High_priority_properties|Priority threshold]]). The number of properties delivered to a content object in each collection (for example; all, 80%, 40% and 10%, respectively) is also a consideration when estimating the performance impact of binding to these collections; simply put, use the smallest collection possible where the desired property is consistently located.

==== PropertyByName[MP_PROPERTY]... ====
This collection was created to overcome the performance impact arising from using Properties.XItems, by individually loading the PropertyViewModel for the named property. However, note that the benefit only lasts while the binding is used sparingly; rendering performance will be roughly the same as loading the Properties collection after 3-5 uses on a single item template.

{{Hint|The Values[ ] collection delivers the property's value as a string. The equivalent for the other bindings (above shown as '...') is <code>{Binding Collection[PROPERTY_NAME].'''DisplayValue'''}</code>, however, the capability of these viewmodels goes far beyond the DisplayValue. Use [[Developer_Mode]] to learn more.}}

==== * Troubleshooting null property values ====
Because certain property collections are Lazy-loaded as described above, it may be the case that bindings to these properties appear null in certain circumstances, especially if the collection is loaded after the page is rendered, such as through a command or behavior. To troubleshoot this issue, you can ensure that the property collection is accessed during rendertime rather than runtime (simply put, while the page is being constructed rather than during normal use) by applying the same binding to, for example, a Label. This measure should still work if the Label is hidden from view using a visibility binding.

=== Editing Properties ===
There are currently 3 main ways to trigger property editing (aside from direct editing) in XAML:
* [[EditPropertyValueCommand]] uses a MetaProperty name as a parameter, to trigger the editing dialogue for that metaproperty.
** It is located on the ContentViewModel, and automatically triggers a Save and Commit once the edit is confirmed.
* Similarly, the (PropertyViewModel).ShowEditorCommand/.PropertyClickedCommand triggers the editing dialogue, however, being located on the PropertyViewModel, it is necessary to first access a single property, such as by triggering the command on a list item template, or by directly binding to a specific one using a metaproperty indexer.
** These two commands are equivalent, the ShowEditorCommand being more general and redirecting for Live Values or properties with Value Records, or else triggering the PropertyClickedCommand.
** These commands can be seen in action as the standard UI for properties when clicking on the icon to trigger "indirect" editing for any individual metaproperty.
** Property changes are not saved automatically, but set the ToSave flag on the ContentViewModel, meaning that a SaveAndCommit command is required to commit the changes.
* The [[XAML_Tips#SetPropertyValueCommand|Set Property Value Command]] sets a named property to a specific or calculated (such as through an [[EvalExpression]]) value.

== 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="Mobile(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. Similarly, audio document creation requires a file type "*.wav" to be included in the selective list.}}

* 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.

== Object Filtering ==
Filtering of objects is a common requirement in UBIK projects. The table below shows the three main approaches, with the functionality each offers.

{| class="wikitable"
! Type !! Configuration/Requirements !! {{Tooltip|Persisted|Filter criteria are retained when navigating, or even closing the client.}} !! {{Tooltip|Multiple/Complex Values|Multiple user inputs supported for a single filter property.}} !! {{Tooltip|Property type|Data elements supported as filter properties.}} !! {{Tooltip|Possible Item Source|Collections supported as item sources.}}
|-
| Query || Fully defined on the server || Yes || Limited (DateTime, Dbl, Int) where a range is possible. || {{Tooltip|Content properties|The kind displayed in the Property tab of the UBIK client}} only || {{Tooltip|Content objects|The kind displayed in the Children tab of the UBIK client}}, Documents
|-
| Property-Based Content Filters || Defined in XAML, requires custom [[SYSCLS_CHILDAREATEMPLATE|Child Area template name]] || Yes || No || {{Tooltip|Content properties|The kind displayed in the Property tab of the UBIK client}} only || {{Tooltip|Content objects|The kind displayed in the Children tab of the UBIK client}} only
|-
| Dynamic Filters || Fully defined in XAML || No || Yes || Any bindable data (eg. Content properties, metadefinitions, etc). || Content objects, Properties, Documents, etc
|-
|}

A [[Query]] is a container that delivers a defined collection of content objects. Properties can be added to the query to serve as filter criteria, where a user can perform their search by editing these properties.

[[Property_Based_Content_Filters]] are a xaml-based customization that connects a user input control (usually a textbox) with a specific content property on the content object. This user input is converted into filter criteria and applied directly to the child list, where only matched objects are retained.

[[HowTo:Implement_Custom_Filtering|Dynamic Filtering]] is the most flexible, but also the most complex, method of XAML-based filtering. A set of [[EvalExpression|EvalExpressions]] converts user inputs into a complex filter string, which is then applied immediately to whichever ItemsSource is defined in the [[XAML_Changes_in_UBIK_WinX_3.5#Filtering_by_expressions|ListCollectionView]]/[[Xamarin_XAML#FeatureRelated|SfDataSourceExt]]. Note that in this approach, user inputs are not directly connected to any data, which means that reloading the page in any way (eg. by navigation) causes the input controls to return to their xaml-defined state.

{{Attention|While any of the above approaches can be used, it is never recommended to mix approaches, as this causes multiple rounds of filtering per keystroke that will noticeably impact performance, especially when many objects and filters are involved!}}

== Miscellaneous ==
<br>

=== Behaviors in style definitions ===
It's very common and easy to attach behaviors to different UI controls to extend their functionalities. For example, see [[#Advanced_2|StringFormatConverter]].

For better code reusability, it's sometimes necessary to implement the functionality of a control in a style so that it can be applied to the same control used in various occasions. In this case, the regular behaviors won't work and you have to use a special type AttachBehavior with some limitations. Below is such an example.

<tabs>
<tab name="UWP">
In this example, a style for the Grid control is defined with a behavior which executes the EditPropertyValueCommand upon tapped. There are two things to note here:
* When attaching multiple behaviors to controls, you have to explicitly declare a BehaviorCollection and place all behaviors underneath. Unlike outside of style definitions, this is mandatory. Without it, only the last behavior will be effective.
* Bindings work the same way in general. However, it's not possible to bind to named elements through the <code>"{Binding ElementName=someName, Path=..."</code> syntax and there doesn't seem to be a way to achieve similar goals.
<source lang = "xml">
xmlns:behaviors="using:UBIK.WinX.Behaviors"
xmlns:core="using:Microsoft.Xaml.Interactions.Core"
<Style x:Key="UBIKNamePropertyGrid" TargetType="Grid">
<Setter Property="behaviors:AttachBehavior.Behaviors">
<Setter.Value>
<behaviors:BehaviorCollection>
<core:EventTriggerBehavior EventName="Tapped">
<core:InvokeCommandAction Command="{Binding EditPropertyValueCommand}" CommandParameter="MP_NAME" />
</core:EventTriggerBehavior>
</behaviors:BehaviorCollection>
</Setter.Value>
</Setter>
</Style>
</source>
</tab>
</tabs>
<br>

=== Custom VisualState Trigger {{Version/WinXSince|5.1.1}} ===
{{UnderConstructionStart}}

The '''UBIKStateObserverTrigger''' (UWP only) is a custom State trigger that allows activating a Visual State based on a value. The trigger compares the '''StateObserver''' value with the specified '''ExpectedValue'''. If both values are equal, the corresponding VisualState becomes active. This enables clean, template-based UI state changes without attaching behaviors directly to controls. It is especially useful in scenarios where behaviors cannot be reused in styles due to framework limitations.

Custom states should be placed in a separate VisualStateGroup. States within the same group are mutually exclusive. If combined with standard groups such as CommonStates (Normal, Focused, PointerOver, etc.), the custom state may be overridden.

<source lang = "xml">
xmlns:trigger="using:UBIK.WinX.Trigger"

<Style ...>
<Setter Property="Template">
<Setter.Value>
<ControlTemplate>
<Grid x:Name="ExampleGrid" />
<VisualStateManager.VisualStateGroups>
<VisualStateGroup x:Name="CustomStates">
<VisualState x:Name="CustomState">
<VisualState.StateTriggers>
<trigger:UBIKStateObserverTrigger StateObserver="{Binding ValueItem.PropertyValue.IsSuggestedValue}" ExpectedValue="True" />
</VisualState.StateTriggers>
<VisualState.Setters>
<Setter Target="ExampleGrid.Background" Value="Red" />
</VisualState.Setters>
</VisualState>
</VisualStateGroup>
</VisualStateManager.VisualStateGroups>
</ControlTemplate>
</Setter.Value>
</Setter>
</Style>
</source>

{{UnderConstructionEnd}}

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

=== UBIKContentControl ===
In UWP XAML, one often uses a <code><ContentControl ... ContentTemplateSelector="{StaticResource TaskPropertyTemplateSelector}" /></code> to choose different templates depending on the binding context.
However, it seems to have its limit, namely the template selection happens only once at the beginning. In other words, the template will not change even when the binding context later changes and another template would be the choice.
For such scenarios, we have created a UBIKContentControl. See the example below.
<tabs>
<tab name="UWP">
When the IsLocked status changes on the ContentViewModel, the task direct edit template will be reselected.
<source lang = "xml">
xmlns:controls="using:UBIK.WinX.Controls"
<controls:UBIKContentControl
Content="{Binding MROViewModel}"
ContentTemplateSelector="{StaticResource TaskPropertyTemplateSelector}"
TemplateReselectTrigger="{Binding IsLocked}" />
</source>
</tab>
</tabs>
<br>

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

== Custom Icons ==
Moved to article [[XAML_Tips#Custom_Icons]].
<br>
<br>

== Differences between Mobile and UWP ==
As you maybe already noticed we have two different clients, one is WinX UWP and the other one Mobile, which is used to develop clients for three different platforms namely iOS, Android and Windows (-> it doesn’t really differentiate from the previously mentioned UWP except it’s developed in a different framework which is Maui 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 Mobile that you used in UWP.
More specific documentations about Mobile Customizing can be found under [[Mobile XAML]].

{{Attention|Please consider that Mobile Windows is not an official product and therefore it can't be guaranteed that all our features work without issues.}}

[[Category:Mobile|XAML]]
[[Category:WinX|XAML]]
[[Category:XAML|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:Mobile|XAML]]
[[Category:WinX|XAML]]
[[Category:XAML|XAML]]

XAML

2026-02-26T14:18:04Z

CWI: /* Custom VisualState Trigger {{Version/WinXSince|5.1.1}} */

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="Mobile(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''), or if they should be merged directly into the original file (''true'', this is the default option): {{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 button can be hidden with SaveButtonVisibility="Collapsed"
* The Annotation button can be hidden with AnnotationButtonVisibility="Collapsed"
* The HS button can be hidden with HotspotButtonVisibility="Collapsed"
* The undo and redo operations can be turned on/off with IsUndoEnabled="true/false". The default value is false. When turned off, the two relevant buttons will be hidden in the toolbar. {{Version/WinXSince|4.4}}

{{Attention|Please be careful when you enable undo and redo. Because {{key press|Ctrl}} + {{key press|Z}} (or whichever other combination in your keyboard layout) is the shortcut to trigger an undo. Therefore, it's possible that you accidentally undo/revert your changes in the PDF viewer when you are typing.}}

* The default stroke width for Annotations can be defined with the AnnotationDefaultStrokeWidth property in the UBIKThemes.xaml:
<source lang = "xml">
<x:Double x:Key="AnnotationDefaultStrokeWidth">1</x:Double>
</source>
</tab>

<tab name="Mobile(Xamarin)">
On a Xamarin UBIKPdfViewer instance (e.g. in the UBIKDocumentContentArea template), you can configure its EnableSeparateInkStrokes value.
* True (default): Every ink stroke has its own session. You can select it and change its color/thickness/transparency/etc. separately from others.
* False: If you do not end the session explicitly by exiting the ink mode, all strokes belong in the same session. And they can only be interacted with as a whole.
<source lang = "xml">
xmlns:ctrls="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL"
<ctrls:UBIKPdfViewer
...
EnableSeparateInkStrokes="True" />
</source>
</tab>

</tabs>

==== UBIKWebView {{Version/WinXSince|5.1}} ====
As there is a bug in the WebView2 (only in WinX/UWP) where specific links cannot be opened, we introduced the UBIKWebView, which contains a workaround for this issue.
<br>
Example:
<source lang = "xml">
xmlns:ctrls="using:UBIK.WinX.UI.Controls"
<ctrls:UBIKWebView x:Name="WebContent" Source="{Binding DocumentViewModel.OnlineURI}" />
</source>

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

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

== 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 ==
Working with Properties is a foundational role of the UI customizer. Be aware that the term can refer to various elements of a content object's datamodel, including details like its Title, SubTitle, UID, classification info, etc. However, this article deals specifically with '''content properties'''; those which are displayed under the Property tab in the UBIK client.

=== Displaying Properties ===
Displaying with properties is an extremely common requirement in custom UIs. UBIK offers several different bindings, each with specific benefits. It may be enough to simply display the value of a simple string or numeric property somewhere in your UI, or else you might need to display complex properties or execute a certain property-based command.

The table below clarifies the various functionalities and how they can best be used in different scenarios.

It is important to note that for these bindings we are assuming a content viewmodel (ie. an object observed in the client, either after navigating to it, or else when viewing it as an item in the child list of another content object).

{| class="wikitable"
! Collection !! {{Tooltip|Performance|Could rendering be slowed down by using this binding, especially on ItemTemplates used in a list of many items.}} !! {{Tooltip|Capability|Extent of the viewmodel accessed}} !! {{Tooltip|Lazy-Loaded|Loaded on-demand (vs. always present)}}
|-
| Values || Great || Very limited - Read only, Property value only || No
|-
| PropertyItems || Good || Limited - Read only || No
|-
| PropertyByName || Ok up to 5 uses || Unlimited - Full PropertyViewModel || Yes
|-
| Properties.XItems || Impacted || Unlimited - Full PropertyViewModel || Yes
|-
|}

==== Values[MP_PROPERTY] ====
* This is the most basic and performant way to bind to a property value.
* This collection simply displays the 'true' value of a property, meaning that it is only useful displaying for simple properties, such as String, Int, Dbl, unformatted DateTime, etc. Properties that have a DisplayValue that is different from their true value, such as GUIDs or selective list items with labels, are not best displayed using this binding.
* For complex iproperties, it can be still be used in the xaml for non-display purposes, such as in combination with converters or commands. It is immediately present on the most basic content viewmodel (the ContentListItemViewModels used by child lists) without having to be loaded, and remains the best choice in most cases.

<tabs>
<tab name="Don't Do">
<source lang = "XML">
Command="{Binding NavigateToGuidCommand}" Command Parameter="{Binding Properties.AllItems[MP_GUID].Value}"
</source>
</tab>
<tab name="Instead do">
<source lang = "XML">
Command="{Binding NavigateToGuidCommand}" Command Parameter="{Binding Values[MP_GUID]}"
</source>
</tab>
</tabs>

==== PropertyItems[MP_PROPERTY]... ====
This collection can be used when the Value collection does not suffice for displaying appropriate values. This PropertyViewModel presents more options than the simple Values collection, however, <u>it should still only be used for displaying text in the UI</u> as it bypasses the modern functionality offered by UBIK, such as user rights, locked states, etc.

==== Properties.XItems[MP_PROPERTY]... ====
These collections were created as a response to the criticism that earlier collections like Values and PropertyItems did not expose enough of a content object's viewmodel to be useful to our ever more sophisticated custom UIs. These collections now provide the full PropertyViewModel, where all aspects of a property (including ''it's'' properties, such as Unit attached to Double, the seperate Min/Value/Max valueitems, Date and Time extracted from the DateTime property, Lon/Lat or Alt extracted from the Geo property, and many more) can be accessed in Bindings.
* However, the downside of accessing this huge viewmodel is the noticeable performance impact, as it loads all instances of properties for the context object, even though only one (MP_PROPERTY) is requested. This impact is felt especially when such as binding is used on an item template in a list with many content objects, of which each has many properties.
* These collections are [[Fast_Startup_(Client)|Lazy Loaded]]*, which means that they are not loaded by default, however, a single binding to that collection will load it. When used on an item template in a list, all viewmodels for all properties for all child items will simultaneously be loaded, leading to the performance impact described in this article.
* "Properties.XItems" is not a real collection. The most frequently used collections are Properties.AllItems, Properties.VisibleItems, Properties.EditableItems, and Properties.ImportantItems (properties which fall into the [[UBIK_WinX_Client_Basics#High_priority_properties|Priority threshold]]). The number of properties delivered to a content object in each collection (for example; all, 80%, 40% and 10%, respectively) is also a consideration when estimating the performance impact of binding to these collections; simply put, use the smallest collection possible where the desired property is consistently located.

==== PropertyByName[MP_PROPERTY]... ====
This collection was created to overcome the performance impact arising from using Properties.XItems, by individually loading the PropertyViewModel for the named property. However, note that the benefit only lasts while the binding is used sparingly; rendering performance will be roughly the same as loading the Properties collection after 3-5 uses on a single item template.

{{Hint|The Values[ ] collection delivers the property's value as a string. The equivalent for the other bindings (above shown as '...') is <code>{Binding Collection[PROPERTY_NAME].'''DisplayValue'''}</code>, however, the capability of these viewmodels goes far beyond the DisplayValue. Use [[Developer_Mode]] to learn more.}}

==== * Troubleshooting null property values ====
Because certain property collections are Lazy-loaded as described above, it may be the case that bindings to these properties appear null in certain circumstances, especially if the collection is loaded after the page is rendered, such as through a command or behavior. To troubleshoot this issue, you can ensure that the property collection is accessed during rendertime rather than runtime (simply put, while the page is being constructed rather than during normal use) by applying the same binding to, for example, a Label. This measure should still work if the Label is hidden from view using a visibility binding.

=== Editing Properties ===
There are currently 3 main ways to trigger property editing (aside from direct editing) in XAML:
* [[EditPropertyValueCommand]] uses a MetaProperty name as a parameter, to trigger the editing dialogue for that metaproperty.
** It is located on the ContentViewModel, and automatically triggers a Save and Commit once the edit is confirmed.
* Similarly, the (PropertyViewModel).ShowEditorCommand/.PropertyClickedCommand triggers the editing dialogue, however, being located on the PropertyViewModel, it is necessary to first access a single property, such as by triggering the command on a list item template, or by directly binding to a specific one using a metaproperty indexer.
** These two commands are equivalent, the ShowEditorCommand being more general and redirecting for Live Values or properties with Value Records, or else triggering the PropertyClickedCommand.
** These commands can be seen in action as the standard UI for properties when clicking on the icon to trigger "indirect" editing for any individual metaproperty.
** Property changes are not saved automatically, but set the ToSave flag on the ContentViewModel, meaning that a SaveAndCommit command is required to commit the changes.
* The [[XAML_Tips#SetPropertyValueCommand|Set Property Value Command]] sets a named property to a specific or calculated (such as through an [[EvalExpression]]) value.

== 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="Mobile(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. Similarly, audio document creation requires a file type "*.wav" to be included in the selective list.}}

* 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.

== Object Filtering ==
Filtering of objects is a common requirement in UBIK projects. The table below shows the three main approaches, with the functionality each offers.

{| class="wikitable"
! Type !! Configuration/Requirements !! {{Tooltip|Persisted|Filter criteria are retained when navigating, or even closing the client.}} !! {{Tooltip|Multiple/Complex Values|Multiple user inputs supported for a single filter property.}} !! {{Tooltip|Property type|Data elements supported as filter properties.}} !! {{Tooltip|Possible Item Source|Collections supported as item sources.}}
|-
| Query || Fully defined on the server || Yes || Limited (DateTime, Dbl, Int) where a range is possible. || {{Tooltip|Content properties|The kind displayed in the Property tab of the UBIK client}} only || {{Tooltip|Content objects|The kind displayed in the Children tab of the UBIK client}}, Documents
|-
| Property-Based Content Filters || Defined in XAML, requires custom [[SYSCLS_CHILDAREATEMPLATE|Child Area template name]] || Yes || No || {{Tooltip|Content properties|The kind displayed in the Property tab of the UBIK client}} only || {{Tooltip|Content objects|The kind displayed in the Children tab of the UBIK client}} only
|-
| Dynamic Filters || Fully defined in XAML || No || Yes || Any bindable data (eg. Content properties, metadefinitions, etc). || Content objects, Properties, Documents, etc
|-
|}

A [[Query]] is a container that delivers a defined collection of content objects. Properties can be added to the query to serve as filter criteria, where a user can perform their search by editing these properties.

[[Property_Based_Content_Filters]] are a xaml-based customization that connects a user input control (usually a textbox) with a specific content property on the content object. This user input is converted into filter criteria and applied directly to the child list, where only matched objects are retained.

[[HowTo:Implement_Custom_Filtering|Dynamic Filtering]] is the most flexible, but also the most complex, method of XAML-based filtering. A set of [[EvalExpression|EvalExpressions]] converts user inputs into a complex filter string, which is then applied immediately to whichever ItemsSource is defined in the [[XAML_Changes_in_UBIK_WinX_3.5#Filtering_by_expressions|ListCollectionView]]/[[Xamarin_XAML#FeatureRelated|SfDataSourceExt]]. Note that in this approach, user inputs are not directly connected to any data, which means that reloading the page in any way (eg. by navigation) causes the input controls to return to their xaml-defined state.

{{Attention|While any of the above approaches can be used, it is never recommended to mix approaches, as this causes multiple rounds of filtering per keystroke that will noticeably impact performance, especially when many objects and filters are involved!}}

== Miscellaneous ==
<br>

=== Behaviors in style definitions ===
It's very common and easy to attach behaviors to different UI controls to extend their functionalities. For example, see [[#Advanced_2|StringFormatConverter]].

For better code reusability, it's sometimes necessary to implement the functionality of a control in a style so that it can be applied to the same control used in various occasions. In this case, the regular behaviors won't work and you have to use a special type AttachBehavior with some limitations. Below is such an example.

<tabs>
<tab name="UWP">
In this example, a style for the Grid control is defined with a behavior which executes the EditPropertyValueCommand upon tapped. There are two things to note here:
* When attaching multiple behaviors to controls, you have to explicitly declare a BehaviorCollection and place all behaviors underneath. Unlike outside of style definitions, this is mandatory. Without it, only the last behavior will be effective.
* Bindings work the same way in general. However, it's not possible to bind to named elements through the <code>"{Binding ElementName=someName, Path=..."</code> syntax and there doesn't seem to be a way to achieve similar goals.
<source lang = "xml">
xmlns:behaviors="using:UBIK.WinX.Behaviors"
xmlns:core="using:Microsoft.Xaml.Interactions.Core"
<Style x:Key="UBIKNamePropertyGrid" TargetType="Grid">
<Setter Property="behaviors:AttachBehavior.Behaviors">
<Setter.Value>
<behaviors:BehaviorCollection>
<core:EventTriggerBehavior EventName="Tapped">
<core:InvokeCommandAction Command="{Binding EditPropertyValueCommand}" CommandParameter="MP_NAME" />
</core:EventTriggerBehavior>
</behaviors:BehaviorCollection>
</Setter.Value>
</Setter>
</Style>
</source>
</tab>
</tabs>
<br>

=== Custom VisualState Trigger {{Version/WinXSince|5.1.1}} ===
{{UnderConstructionStart}}

The '''UBIKStateObserver''' (UWP only) is a custom State trigger that allows activating a Visual State based on a value. The trigger compares the '''StateObserver''' value with the specified '''ExpectedValue'''. If both values are equal, the corresponding VisualState becomes active. This enables clean, template-based UI state changes without attaching behaviors directly to controls. It is especially useful in scenarios where behaviors cannot be reused in styles due to framework limitations.

Custom states should be placed in a separate VisualStateGroup. States within the same group are mutually exclusive. If combined with standard groups such as CommonStates (Normal, Focused, PointerOver, etc.), the custom state may be overridden.

<source lang = "xml">
xmlns:trigger="using:UBIK.WinX.Trigger"

<Style ...>
<Setter Property="Template">
<Setter.Value>
<ControlTemplate>
<Grid x:Name="ExampleGrid" />
<VisualStateManager.VisualStateGroups>
<VisualStateGroup x:Name="CustomStates">
<VisualState x:Name="CustomState">
<VisualState.StateTriggers>
<trigger:UBIKStateObserver StateObserver="{Binding ValueItem.PropertyValue.IsSuggestedValue}" ExpectedValue="True" />
</VisualState.StateTriggers>
<VisualState.Setters>
<Setter Target="ExampleGrid.Background" Value="Red" />
</VisualState.Setters>
</VisualState>
</VisualStateGroup>
</VisualStateManager.VisualStateGroups>
</ControlTemplate>
</Setter.Value>
</Setter>
</Style>
</source>

{{UnderConstructionEnd}}

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

=== UBIKContentControl ===
In UWP XAML, one often uses a <code><ContentControl ... ContentTemplateSelector="{StaticResource TaskPropertyTemplateSelector}" /></code> to choose different templates depending on the binding context.
However, it seems to have its limit, namely the template selection happens only once at the beginning. In other words, the template will not change even when the binding context later changes and another template would be the choice.
For such scenarios, we have created a UBIKContentControl. See the example below.
<tabs>
<tab name="UWP">
When the IsLocked status changes on the ContentViewModel, the task direct edit template will be reselected.
<source lang = "xml">
xmlns:controls="using:UBIK.WinX.Controls"
<controls:UBIKContentControl
Content="{Binding MROViewModel}"
ContentTemplateSelector="{StaticResource TaskPropertyTemplateSelector}"
TemplateReselectTrigger="{Binding IsLocked}" />
</source>
</tab>
</tabs>
<br>

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

== Custom Icons ==
Moved to article [[XAML_Tips#Custom_Icons]].
<br>
<br>

== Differences between Mobile and UWP ==
As you maybe already noticed we have two different clients, one is WinX UWP and the other one Mobile, which is used to develop clients for three different platforms namely iOS, Android and Windows (-> it doesn’t really differentiate from the previously mentioned UWP except it’s developed in a different framework which is Maui 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 Mobile that you used in UWP.
More specific documentations about Mobile Customizing can be found under [[Mobile XAML]].

{{Attention|Please consider that Mobile Windows is not an official product and therefore it can't be guaranteed that all our features work without issues.}}

[[Category:Mobile|XAML]]
[[Category:WinX|XAML]]
[[Category:XAML|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:Mobile|XAML]]
[[Category:WinX|XAML]]
[[Category:XAML|XAML]]

XAML

2026-02-26T14:05:35Z

CWI: /* Custom VisualState Trigger {{Version/WinXSince|5.1.1}} */

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="Mobile(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''), or if they should be merged directly into the original file (''true'', this is the default option): {{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 button can be hidden with SaveButtonVisibility="Collapsed"
* The Annotation button can be hidden with AnnotationButtonVisibility="Collapsed"
* The HS button can be hidden with HotspotButtonVisibility="Collapsed"
* The undo and redo operations can be turned on/off with IsUndoEnabled="true/false". The default value is false. When turned off, the two relevant buttons will be hidden in the toolbar. {{Version/WinXSince|4.4}}

{{Attention|Please be careful when you enable undo and redo. Because {{key press|Ctrl}} + {{key press|Z}} (or whichever other combination in your keyboard layout) is the shortcut to trigger an undo. Therefore, it's possible that you accidentally undo/revert your changes in the PDF viewer when you are typing.}}

* The default stroke width for Annotations can be defined with the AnnotationDefaultStrokeWidth property in the UBIKThemes.xaml:
<source lang = "xml">
<x:Double x:Key="AnnotationDefaultStrokeWidth">1</x:Double>
</source>
</tab>

<tab name="Mobile(Xamarin)">
On a Xamarin UBIKPdfViewer instance (e.g. in the UBIKDocumentContentArea template), you can configure its EnableSeparateInkStrokes value.
* True (default): Every ink stroke has its own session. You can select it and change its color/thickness/transparency/etc. separately from others.
* False: If you do not end the session explicitly by exiting the ink mode, all strokes belong in the same session. And they can only be interacted with as a whole.
<source lang = "xml">
xmlns:ctrls="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL"
<ctrls:UBIKPdfViewer
...
EnableSeparateInkStrokes="True" />
</source>
</tab>

</tabs>

==== UBIKWebView {{Version/WinXSince|5.1}} ====
As there is a bug in the WebView2 (only in WinX/UWP) where specific links cannot be opened, we introduced the UBIKWebView, which contains a workaround for this issue.
<br>
Example:
<source lang = "xml">
xmlns:ctrls="using:UBIK.WinX.UI.Controls"
<ctrls:UBIKWebView x:Name="WebContent" Source="{Binding DocumentViewModel.OnlineURI}" />
</source>

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

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

== 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 ==
Working with Properties is a foundational role of the UI customizer. Be aware that the term can refer to various elements of a content object's datamodel, including details like its Title, SubTitle, UID, classification info, etc. However, this article deals specifically with '''content properties'''; those which are displayed under the Property tab in the UBIK client.

=== Displaying Properties ===
Displaying with properties is an extremely common requirement in custom UIs. UBIK offers several different bindings, each with specific benefits. It may be enough to simply display the value of a simple string or numeric property somewhere in your UI, or else you might need to display complex properties or execute a certain property-based command.

The table below clarifies the various functionalities and how they can best be used in different scenarios.

It is important to note that for these bindings we are assuming a content viewmodel (ie. an object observed in the client, either after navigating to it, or else when viewing it as an item in the child list of another content object).

{| class="wikitable"
! Collection !! {{Tooltip|Performance|Could rendering be slowed down by using this binding, especially on ItemTemplates used in a list of many items.}} !! {{Tooltip|Capability|Extent of the viewmodel accessed}} !! {{Tooltip|Lazy-Loaded|Loaded on-demand (vs. always present)}}
|-
| Values || Great || Very limited - Read only, Property value only || No
|-
| PropertyItems || Good || Limited - Read only || No
|-
| PropertyByName || Ok up to 5 uses || Unlimited - Full PropertyViewModel || Yes
|-
| Properties.XItems || Impacted || Unlimited - Full PropertyViewModel || Yes
|-
|}

==== Values[MP_PROPERTY] ====
* This is the most basic and performant way to bind to a property value.
* This collection simply displays the 'true' value of a property, meaning that it is only useful displaying for simple properties, such as String, Int, Dbl, unformatted DateTime, etc. Properties that have a DisplayValue that is different from their true value, such as GUIDs or selective list items with labels, are not best displayed using this binding.
* For complex iproperties, it can be still be used in the xaml for non-display purposes, such as in combination with converters or commands. It is immediately present on the most basic content viewmodel (the ContentListItemViewModels used by child lists) without having to be loaded, and remains the best choice in most cases.

<tabs>
<tab name="Don't Do">
<source lang = "XML">
Command="{Binding NavigateToGuidCommand}" Command Parameter="{Binding Properties.AllItems[MP_GUID].Value}"
</source>
</tab>
<tab name="Instead do">
<source lang = "XML">
Command="{Binding NavigateToGuidCommand}" Command Parameter="{Binding Values[MP_GUID]}"
</source>
</tab>
</tabs>

==== PropertyItems[MP_PROPERTY]... ====
This collection can be used when the Value collection does not suffice for displaying appropriate values. This PropertyViewModel presents more options than the simple Values collection, however, <u>it should still only be used for displaying text in the UI</u> as it bypasses the modern functionality offered by UBIK, such as user rights, locked states, etc.

==== Properties.XItems[MP_PROPERTY]... ====
These collections were created as a response to the criticism that earlier collections like Values and PropertyItems did not expose enough of a content object's viewmodel to be useful to our ever more sophisticated custom UIs. These collections now provide the full PropertyViewModel, where all aspects of a property (including ''it's'' properties, such as Unit attached to Double, the seperate Min/Value/Max valueitems, Date and Time extracted from the DateTime property, Lon/Lat or Alt extracted from the Geo property, and many more) can be accessed in Bindings.
* However, the downside of accessing this huge viewmodel is the noticeable performance impact, as it loads all instances of properties for the context object, even though only one (MP_PROPERTY) is requested. This impact is felt especially when such as binding is used on an item template in a list with many content objects, of which each has many properties.
* These collections are [[Fast_Startup_(Client)|Lazy Loaded]]*, which means that they are not loaded by default, however, a single binding to that collection will load it. When used on an item template in a list, all viewmodels for all properties for all child items will simultaneously be loaded, leading to the performance impact described in this article.
* "Properties.XItems" is not a real collection. The most frequently used collections are Properties.AllItems, Properties.VisibleItems, Properties.EditableItems, and Properties.ImportantItems (properties which fall into the [[UBIK_WinX_Client_Basics#High_priority_properties|Priority threshold]]). The number of properties delivered to a content object in each collection (for example; all, 80%, 40% and 10%, respectively) is also a consideration when estimating the performance impact of binding to these collections; simply put, use the smallest collection possible where the desired property is consistently located.

==== PropertyByName[MP_PROPERTY]... ====
This collection was created to overcome the performance impact arising from using Properties.XItems, by individually loading the PropertyViewModel for the named property. However, note that the benefit only lasts while the binding is used sparingly; rendering performance will be roughly the same as loading the Properties collection after 3-5 uses on a single item template.

{{Hint|The Values[ ] collection delivers the property's value as a string. The equivalent for the other bindings (above shown as '...') is <code>{Binding Collection[PROPERTY_NAME].'''DisplayValue'''}</code>, however, the capability of these viewmodels goes far beyond the DisplayValue. Use [[Developer_Mode]] to learn more.}}

==== * Troubleshooting null property values ====
Because certain property collections are Lazy-loaded as described above, it may be the case that bindings to these properties appear null in certain circumstances, especially if the collection is loaded after the page is rendered, such as through a command or behavior. To troubleshoot this issue, you can ensure that the property collection is accessed during rendertime rather than runtime (simply put, while the page is being constructed rather than during normal use) by applying the same binding to, for example, a Label. This measure should still work if the Label is hidden from view using a visibility binding.

=== Editing Properties ===
There are currently 3 main ways to trigger property editing (aside from direct editing) in XAML:
* [[EditPropertyValueCommand]] uses a MetaProperty name as a parameter, to trigger the editing dialogue for that metaproperty.
** It is located on the ContentViewModel, and automatically triggers a Save and Commit once the edit is confirmed.
* Similarly, the (PropertyViewModel).ShowEditorCommand/.PropertyClickedCommand triggers the editing dialogue, however, being located on the PropertyViewModel, it is necessary to first access a single property, such as by triggering the command on a list item template, or by directly binding to a specific one using a metaproperty indexer.
** These two commands are equivalent, the ShowEditorCommand being more general and redirecting for Live Values or properties with Value Records, or else triggering the PropertyClickedCommand.
** These commands can be seen in action as the standard UI for properties when clicking on the icon to trigger "indirect" editing for any individual metaproperty.
** Property changes are not saved automatically, but set the ToSave flag on the ContentViewModel, meaning that a SaveAndCommit command is required to commit the changes.
* The [[XAML_Tips#SetPropertyValueCommand|Set Property Value Command]] sets a named property to a specific or calculated (such as through an [[EvalExpression]]) value.

== 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="Mobile(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. Similarly, audio document creation requires a file type "*.wav" to be included in the selective list.}}

* 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.

== Object Filtering ==
Filtering of objects is a common requirement in UBIK projects. The table below shows the three main approaches, with the functionality each offers.

{| class="wikitable"
! Type !! Configuration/Requirements !! {{Tooltip|Persisted|Filter criteria are retained when navigating, or even closing the client.}} !! {{Tooltip|Multiple/Complex Values|Multiple user inputs supported for a single filter property.}} !! {{Tooltip|Property type|Data elements supported as filter properties.}} !! {{Tooltip|Possible Item Source|Collections supported as item sources.}}
|-
| Query || Fully defined on the server || Yes || Limited (DateTime, Dbl, Int) where a range is possible. || {{Tooltip|Content properties|The kind displayed in the Property tab of the UBIK client}} only || {{Tooltip|Content objects|The kind displayed in the Children tab of the UBIK client}}, Documents
|-
| Property-Based Content Filters || Defined in XAML, requires custom [[SYSCLS_CHILDAREATEMPLATE|Child Area template name]] || Yes || No || {{Tooltip|Content properties|The kind displayed in the Property tab of the UBIK client}} only || {{Tooltip|Content objects|The kind displayed in the Children tab of the UBIK client}} only
|-
| Dynamic Filters || Fully defined in XAML || No || Yes || Any bindable data (eg. Content properties, metadefinitions, etc). || Content objects, Properties, Documents, etc
|-
|}

A [[Query]] is a container that delivers a defined collection of content objects. Properties can be added to the query to serve as filter criteria, where a user can perform their search by editing these properties.

[[Property_Based_Content_Filters]] are a xaml-based customization that connects a user input control (usually a textbox) with a specific content property on the content object. This user input is converted into filter criteria and applied directly to the child list, where only matched objects are retained.

[[HowTo:Implement_Custom_Filtering|Dynamic Filtering]] is the most flexible, but also the most complex, method of XAML-based filtering. A set of [[EvalExpression|EvalExpressions]] converts user inputs into a complex filter string, which is then applied immediately to whichever ItemsSource is defined in the [[XAML_Changes_in_UBIK_WinX_3.5#Filtering_by_expressions|ListCollectionView]]/[[Xamarin_XAML#FeatureRelated|SfDataSourceExt]]. Note that in this approach, user inputs are not directly connected to any data, which means that reloading the page in any way (eg. by navigation) causes the input controls to return to their xaml-defined state.

{{Attention|While any of the above approaches can be used, it is never recommended to mix approaches, as this causes multiple rounds of filtering per keystroke that will noticeably impact performance, especially when many objects and filters are involved!}}

== Miscellaneous ==
<br>

=== Behaviors in style definitions ===
It's very common and easy to attach behaviors to different UI controls to extend their functionalities. For example, see [[#Advanced_2|StringFormatConverter]].

For better code reusability, it's sometimes necessary to implement the functionality of a control in a style so that it can be applied to the same control used in various occasions. In this case, the regular behaviors won't work and you have to use a special type AttachBehavior with some limitations. Below is such an example.

<tabs>
<tab name="UWP">
In this example, a style for the Grid control is defined with a behavior which executes the EditPropertyValueCommand upon tapped. There are two things to note here:
* When attaching multiple behaviors to controls, you have to explicitly declare a BehaviorCollection and place all behaviors underneath. Unlike outside of style definitions, this is mandatory. Without it, only the last behavior will be effective.
* Bindings work the same way in general. However, it's not possible to bind to named elements through the <code>"{Binding ElementName=someName, Path=..."</code> syntax and there doesn't seem to be a way to achieve similar goals.
<source lang = "xml">
xmlns:behaviors="using:UBIK.WinX.Behaviors"
xmlns:core="using:Microsoft.Xaml.Interactions.Core"
<Style x:Key="UBIKNamePropertyGrid" TargetType="Grid">
<Setter Property="behaviors:AttachBehavior.Behaviors">
<Setter.Value>
<behaviors:BehaviorCollection>
<core:EventTriggerBehavior EventName="Tapped">
<core:InvokeCommandAction Command="{Binding EditPropertyValueCommand}" CommandParameter="MP_NAME" />
</core:EventTriggerBehavior>
</behaviors:BehaviorCollection>
</Setter.Value>
</Setter>
</Style>
</source>
</tab>
</tabs>
<br>

=== Custom VisualState Trigger {{Version/WinXSince|5.1.1}} ===
{{UnderConstructionStart}}

The '''UBIKStateObserver''' (UWP only) is a custom State trigger that allows activating a Visual State based on a value. The trigger compares the '''StateObserver''' value with the specified '''ExpectedValue'''. If both values are equal, the corresponding VisualState becomes active. This enables clean, template-based UI state changes without attaching behaviors directly to controls. It is especially useful in scenarios where behaviors cannot be reused in styles due to framework limitations.

Custom states should be placed in a separate VisualStateGroup. States within the same group are mutually exclusive. If combined with standard groups such as CommonStates (Normal, Focused, PointerOver, etc.), the custom state may be overridden.

<source lang = "xml">
xmlns:trigger="using:UBIK.WinX.Trigger"

<Style ...>
<Setter Property="Template">
<Setter.Value>
<ControlTemplate>
<Grid x:Name="ExampleGrid" />
<VisualStateManager.VisualStateGroups>
<VisualStateGroup x:Name="CustomStates">
<VisualState x:Name="CustomState">
<VisualState.StateTriggers>
<trigger:UBIKStateObserver StateObserver="{Binding ValueItem.PropertyValue.IsSuggestedValue}" ExpectedValue="True" />
</VisualState.StateTriggers>
<VisualState.Setters>
<Setter Target="ExampleGrid.Foreground" Value="Red" />
</VisualState.Setters>
</VisualState>
</VisualStateGroup>
</VisualStateManager.VisualStateGroups>
</ControlTemplate>
</Setter.Value>
</Setter>
</Style>
</source>

{{UnderConstructionEnd}}

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

=== UBIKContentControl ===
In UWP XAML, one often uses a <code><ContentControl ... ContentTemplateSelector="{StaticResource TaskPropertyTemplateSelector}" /></code> to choose different templates depending on the binding context.
However, it seems to have its limit, namely the template selection happens only once at the beginning. In other words, the template will not change even when the binding context later changes and another template would be the choice.
For such scenarios, we have created a UBIKContentControl. See the example below.
<tabs>
<tab name="UWP">
When the IsLocked status changes on the ContentViewModel, the task direct edit template will be reselected.
<source lang = "xml">
xmlns:controls="using:UBIK.WinX.Controls"
<controls:UBIKContentControl
Content="{Binding MROViewModel}"
ContentTemplateSelector="{StaticResource TaskPropertyTemplateSelector}"
TemplateReselectTrigger="{Binding IsLocked}" />
</source>
</tab>
</tabs>
<br>

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

== Custom Icons ==
Moved to article [[XAML_Tips#Custom_Icons]].
<br>
<br>

== Differences between Mobile and UWP ==
As you maybe already noticed we have two different clients, one is WinX UWP and the other one Mobile, which is used to develop clients for three different platforms namely iOS, Android and Windows (-> it doesn’t really differentiate from the previously mentioned UWP except it’s developed in a different framework which is Maui 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 Mobile that you used in UWP.
More specific documentations about Mobile Customizing can be found under [[Mobile XAML]].

{{Attention|Please consider that Mobile Windows is not an official product and therefore it can't be guaranteed that all our features work without issues.}}

[[Category:Mobile|XAML]]
[[Category:WinX|XAML]]
[[Category:XAML|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:Mobile|XAML]]
[[Category:WinX|XAML]]
[[Category:XAML|XAML]]

XAML

2026-02-26T14:04:32Z

CWI: /* Miscellaneous */

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="Mobile(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''), or if they should be merged directly into the original file (''true'', this is the default option): {{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 button can be hidden with SaveButtonVisibility="Collapsed"
* The Annotation button can be hidden with AnnotationButtonVisibility="Collapsed"
* The HS button can be hidden with HotspotButtonVisibility="Collapsed"
* The undo and redo operations can be turned on/off with IsUndoEnabled="true/false". The default value is false. When turned off, the two relevant buttons will be hidden in the toolbar. {{Version/WinXSince|4.4}}

{{Attention|Please be careful when you enable undo and redo. Because {{key press|Ctrl}} + {{key press|Z}} (or whichever other combination in your keyboard layout) is the shortcut to trigger an undo. Therefore, it's possible that you accidentally undo/revert your changes in the PDF viewer when you are typing.}}

* The default stroke width for Annotations can be defined with the AnnotationDefaultStrokeWidth property in the UBIKThemes.xaml:
<source lang = "xml">
<x:Double x:Key="AnnotationDefaultStrokeWidth">1</x:Double>
</source>
</tab>

<tab name="Mobile(Xamarin)">
On a Xamarin UBIKPdfViewer instance (e.g. in the UBIKDocumentContentArea template), you can configure its EnableSeparateInkStrokes value.
* True (default): Every ink stroke has its own session. You can select it and change its color/thickness/transparency/etc. separately from others.
* False: If you do not end the session explicitly by exiting the ink mode, all strokes belong in the same session. And they can only be interacted with as a whole.
<source lang = "xml">
xmlns:ctrls="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL"
<ctrls:UBIKPdfViewer
...
EnableSeparateInkStrokes="True" />
</source>
</tab>

</tabs>

==== UBIKWebView {{Version/WinXSince|5.1}} ====
As there is a bug in the WebView2 (only in WinX/UWP) where specific links cannot be opened, we introduced the UBIKWebView, which contains a workaround for this issue.
<br>
Example:
<source lang = "xml">
xmlns:ctrls="using:UBIK.WinX.UI.Controls"
<ctrls:UBIKWebView x:Name="WebContent" Source="{Binding DocumentViewModel.OnlineURI}" />
</source>

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

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

== 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 ==
Working with Properties is a foundational role of the UI customizer. Be aware that the term can refer to various elements of a content object's datamodel, including details like its Title, SubTitle, UID, classification info, etc. However, this article deals specifically with '''content properties'''; those which are displayed under the Property tab in the UBIK client.

=== Displaying Properties ===
Displaying with properties is an extremely common requirement in custom UIs. UBIK offers several different bindings, each with specific benefits. It may be enough to simply display the value of a simple string or numeric property somewhere in your UI, or else you might need to display complex properties or execute a certain property-based command.

The table below clarifies the various functionalities and how they can best be used in different scenarios.

It is important to note that for these bindings we are assuming a content viewmodel (ie. an object observed in the client, either after navigating to it, or else when viewing it as an item in the child list of another content object).

{| class="wikitable"
! Collection !! {{Tooltip|Performance|Could rendering be slowed down by using this binding, especially on ItemTemplates used in a list of many items.}} !! {{Tooltip|Capability|Extent of the viewmodel accessed}} !! {{Tooltip|Lazy-Loaded|Loaded on-demand (vs. always present)}}
|-
| Values || Great || Very limited - Read only, Property value only || No
|-
| PropertyItems || Good || Limited - Read only || No
|-
| PropertyByName || Ok up to 5 uses || Unlimited - Full PropertyViewModel || Yes
|-
| Properties.XItems || Impacted || Unlimited - Full PropertyViewModel || Yes
|-
|}

==== Values[MP_PROPERTY] ====
* This is the most basic and performant way to bind to a property value.
* This collection simply displays the 'true' value of a property, meaning that it is only useful displaying for simple properties, such as String, Int, Dbl, unformatted DateTime, etc. Properties that have a DisplayValue that is different from their true value, such as GUIDs or selective list items with labels, are not best displayed using this binding.
* For complex iproperties, it can be still be used in the xaml for non-display purposes, such as in combination with converters or commands. It is immediately present on the most basic content viewmodel (the ContentListItemViewModels used by child lists) without having to be loaded, and remains the best choice in most cases.

<tabs>
<tab name="Don't Do">
<source lang = "XML">
Command="{Binding NavigateToGuidCommand}" Command Parameter="{Binding Properties.AllItems[MP_GUID].Value}"
</source>
</tab>
<tab name="Instead do">
<source lang = "XML">
Command="{Binding NavigateToGuidCommand}" Command Parameter="{Binding Values[MP_GUID]}"
</source>
</tab>
</tabs>

==== PropertyItems[MP_PROPERTY]... ====
This collection can be used when the Value collection does not suffice for displaying appropriate values. This PropertyViewModel presents more options than the simple Values collection, however, <u>it should still only be used for displaying text in the UI</u> as it bypasses the modern functionality offered by UBIK, such as user rights, locked states, etc.

==== Properties.XItems[MP_PROPERTY]... ====
These collections were created as a response to the criticism that earlier collections like Values and PropertyItems did not expose enough of a content object's viewmodel to be useful to our ever more sophisticated custom UIs. These collections now provide the full PropertyViewModel, where all aspects of a property (including ''it's'' properties, such as Unit attached to Double, the seperate Min/Value/Max valueitems, Date and Time extracted from the DateTime property, Lon/Lat or Alt extracted from the Geo property, and many more) can be accessed in Bindings.
* However, the downside of accessing this huge viewmodel is the noticeable performance impact, as it loads all instances of properties for the context object, even though only one (MP_PROPERTY) is requested. This impact is felt especially when such as binding is used on an item template in a list with many content objects, of which each has many properties.
* These collections are [[Fast_Startup_(Client)|Lazy Loaded]]*, which means that they are not loaded by default, however, a single binding to that collection will load it. When used on an item template in a list, all viewmodels for all properties for all child items will simultaneously be loaded, leading to the performance impact described in this article.
* "Properties.XItems" is not a real collection. The most frequently used collections are Properties.AllItems, Properties.VisibleItems, Properties.EditableItems, and Properties.ImportantItems (properties which fall into the [[UBIK_WinX_Client_Basics#High_priority_properties|Priority threshold]]). The number of properties delivered to a content object in each collection (for example; all, 80%, 40% and 10%, respectively) is also a consideration when estimating the performance impact of binding to these collections; simply put, use the smallest collection possible where the desired property is consistently located.

==== PropertyByName[MP_PROPERTY]... ====
This collection was created to overcome the performance impact arising from using Properties.XItems, by individually loading the PropertyViewModel for the named property. However, note that the benefit only lasts while the binding is used sparingly; rendering performance will be roughly the same as loading the Properties collection after 3-5 uses on a single item template.

{{Hint|The Values[ ] collection delivers the property's value as a string. The equivalent for the other bindings (above shown as '...') is <code>{Binding Collection[PROPERTY_NAME].'''DisplayValue'''}</code>, however, the capability of these viewmodels goes far beyond the DisplayValue. Use [[Developer_Mode]] to learn more.}}

==== * Troubleshooting null property values ====
Because certain property collections are Lazy-loaded as described above, it may be the case that bindings to these properties appear null in certain circumstances, especially if the collection is loaded after the page is rendered, such as through a command or behavior. To troubleshoot this issue, you can ensure that the property collection is accessed during rendertime rather than runtime (simply put, while the page is being constructed rather than during normal use) by applying the same binding to, for example, a Label. This measure should still work if the Label is hidden from view using a visibility binding.

=== Editing Properties ===
There are currently 3 main ways to trigger property editing (aside from direct editing) in XAML:
* [[EditPropertyValueCommand]] uses a MetaProperty name as a parameter, to trigger the editing dialogue for that metaproperty.
** It is located on the ContentViewModel, and automatically triggers a Save and Commit once the edit is confirmed.
* Similarly, the (PropertyViewModel).ShowEditorCommand/.PropertyClickedCommand triggers the editing dialogue, however, being located on the PropertyViewModel, it is necessary to first access a single property, such as by triggering the command on a list item template, or by directly binding to a specific one using a metaproperty indexer.
** These two commands are equivalent, the ShowEditorCommand being more general and redirecting for Live Values or properties with Value Records, or else triggering the PropertyClickedCommand.
** These commands can be seen in action as the standard UI for properties when clicking on the icon to trigger "indirect" editing for any individual metaproperty.
** Property changes are not saved automatically, but set the ToSave flag on the ContentViewModel, meaning that a SaveAndCommit command is required to commit the changes.
* The [[XAML_Tips#SetPropertyValueCommand|Set Property Value Command]] sets a named property to a specific or calculated (such as through an [[EvalExpression]]) value.

== 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="Mobile(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. Similarly, audio document creation requires a file type "*.wav" to be included in the selective list.}}

* 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.

== Object Filtering ==
Filtering of objects is a common requirement in UBIK projects. The table below shows the three main approaches, with the functionality each offers.

{| class="wikitable"
! Type !! Configuration/Requirements !! {{Tooltip|Persisted|Filter criteria are retained when navigating, or even closing the client.}} !! {{Tooltip|Multiple/Complex Values|Multiple user inputs supported for a single filter property.}} !! {{Tooltip|Property type|Data elements supported as filter properties.}} !! {{Tooltip|Possible Item Source|Collections supported as item sources.}}
|-
| Query || Fully defined on the server || Yes || Limited (DateTime, Dbl, Int) where a range is possible. || {{Tooltip|Content properties|The kind displayed in the Property tab of the UBIK client}} only || {{Tooltip|Content objects|The kind displayed in the Children tab of the UBIK client}}, Documents
|-
| Property-Based Content Filters || Defined in XAML, requires custom [[SYSCLS_CHILDAREATEMPLATE|Child Area template name]] || Yes || No || {{Tooltip|Content properties|The kind displayed in the Property tab of the UBIK client}} only || {{Tooltip|Content objects|The kind displayed in the Children tab of the UBIK client}} only
|-
| Dynamic Filters || Fully defined in XAML || No || Yes || Any bindable data (eg. Content properties, metadefinitions, etc). || Content objects, Properties, Documents, etc
|-
|}

A [[Query]] is a container that delivers a defined collection of content objects. Properties can be added to the query to serve as filter criteria, where a user can perform their search by editing these properties.

[[Property_Based_Content_Filters]] are a xaml-based customization that connects a user input control (usually a textbox) with a specific content property on the content object. This user input is converted into filter criteria and applied directly to the child list, where only matched objects are retained.

[[HowTo:Implement_Custom_Filtering|Dynamic Filtering]] is the most flexible, but also the most complex, method of XAML-based filtering. A set of [[EvalExpression|EvalExpressions]] converts user inputs into a complex filter string, which is then applied immediately to whichever ItemsSource is defined in the [[XAML_Changes_in_UBIK_WinX_3.5#Filtering_by_expressions|ListCollectionView]]/[[Xamarin_XAML#FeatureRelated|SfDataSourceExt]]. Note that in this approach, user inputs are not directly connected to any data, which means that reloading the page in any way (eg. by navigation) causes the input controls to return to their xaml-defined state.

{{Attention|While any of the above approaches can be used, it is never recommended to mix approaches, as this causes multiple rounds of filtering per keystroke that will noticeably impact performance, especially when many objects and filters are involved!}}

== Miscellaneous ==
<br>

=== Behaviors in style definitions ===
It's very common and easy to attach behaviors to different UI controls to extend their functionalities. For example, see [[#Advanced_2|StringFormatConverter]].

For better code reusability, it's sometimes necessary to implement the functionality of a control in a style so that it can be applied to the same control used in various occasions. In this case, the regular behaviors won't work and you have to use a special type AttachBehavior with some limitations. Below is such an example.

<tabs>
<tab name="UWP">
In this example, a style for the Grid control is defined with a behavior which executes the EditPropertyValueCommand upon tapped. There are two things to note here:
* When attaching multiple behaviors to controls, you have to explicitly declare a BehaviorCollection and place all behaviors underneath. Unlike outside of style definitions, this is mandatory. Without it, only the last behavior will be effective.
* Bindings work the same way in general. However, it's not possible to bind to named elements through the <code>"{Binding ElementName=someName, Path=..."</code> syntax and there doesn't seem to be a way to achieve similar goals.
<source lang = "xml">
xmlns:behaviors="using:UBIK.WinX.Behaviors"
xmlns:core="using:Microsoft.Xaml.Interactions.Core"
<Style x:Key="UBIKNamePropertyGrid" TargetType="Grid">
<Setter Property="behaviors:AttachBehavior.Behaviors">
<Setter.Value>
<behaviors:BehaviorCollection>
<core:EventTriggerBehavior EventName="Tapped">
<core:InvokeCommandAction Command="{Binding EditPropertyValueCommand}" CommandParameter="MP_NAME" />
</core:EventTriggerBehavior>
</behaviors:BehaviorCollection>
</Setter.Value>
</Setter>
</Style>
</source>
</tab>
</tabs>
<br>

=== Custom VisualState Trigger {{Version/WinXSince|5.1.1}} ===
{{UnderConstructionStart}}
The UBIKStateObserver (UWP only) is a custom State trigger that allows activating a Visual State based on a value. The trigger compares the '''StateObserver''' value with the specified '''ExpectedValue'''. If both values are equal, the corresponding VisualState becomes active. This enables clean, template-based UI state changes without attaching behaviors directly to controls. It is especially useful in scenarios where behaviors cannot be reused in styles due to framework limitations.

Custom states should be placed in a separate VisualStateGroup. States within the same group are mutually exclusive. If combined with standard groups such as CommonStates (Normal, Focused, PointerOver, etc.), the custom state may be overridden.

<source lang = "xml">
xmlns:trigger="using:UBIK.WinX.Trigger"

<Style ...>
<Setter Property="Template">
<Setter.Value>
<ControlTemplate>
<Grid x:Name="ExampleGrid" />
<VisualStateManager.VisualStateGroups>
<VisualStateGroup x:Name="CustomStates">
<VisualState x:Name="CustomState">
<VisualState.StateTriggers>
<trigger:UBIKStateObserver StateObserver="{Binding ValueItem.PropertyValue.IsSuggestedValue}" ExpectedValue="True" />
</VisualState.StateTriggers>
<VisualState.Setters>
<Setter Target="ExampleGrid.Foreground" Value="Red" />
</VisualState.Setters>
</VisualState>
</VisualStateGroup>
</VisualStateManager.VisualStateGroups>
</ControlTemplate>
</Setter.Value>
</Setter>
</Style>
</source>

{{UnderConstructionEnd}}

=== UBIKContentControl ===
In UWP XAML, one often uses a <code><ContentControl ... ContentTemplateSelector="{StaticResource TaskPropertyTemplateSelector}" /></code> to choose different templates depending on the binding context.
However, it seems to have its limit, namely the template selection happens only once at the beginning. In other words, the template will not change even when the binding context later changes and another template would be the choice.
For such scenarios, we have created a UBIKContentControl. See the example below.
<tabs>
<tab name="UWP">
When the IsLocked status changes on the ContentViewModel, the task direct edit template will be reselected.
<source lang = "xml">
xmlns:controls="using:UBIK.WinX.Controls"
<controls:UBIKContentControl
Content="{Binding MROViewModel}"
ContentTemplateSelector="{StaticResource TaskPropertyTemplateSelector}"
TemplateReselectTrigger="{Binding IsLocked}" />
</source>
</tab>
</tabs>
<br>

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

== Custom Icons ==
Moved to article [[XAML_Tips#Custom_Icons]].
<br>
<br>

== Differences between Mobile and UWP ==
As you maybe already noticed we have two different clients, one is WinX UWP and the other one Mobile, which is used to develop clients for three different platforms namely iOS, Android and Windows (-> it doesn’t really differentiate from the previously mentioned UWP except it’s developed in a different framework which is Maui 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 Mobile that you used in UWP.
More specific documentations about Mobile Customizing can be found under [[Mobile XAML]].

{{Attention|Please consider that Mobile Windows is not an official product and therefore it can't be guaranteed that all our features work without issues.}}

[[Category:Mobile|XAML]]
[[Category:WinX|XAML]]
[[Category:XAML|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:Mobile|XAML]]
[[Category:WinX|XAML]]
[[Category:XAML|XAML]]

Version 5.1 (WinX)

2026-02-04T07:56:39Z

CWI: /* 5.1.?? on 202?-??-?? */

Branch Download

2025-12-18T11:19:04Z

CWI: /* BranchDownloadCommand */

To support offline use cases, {{UBIK}} clients provide the possibility to bring data offline. It's achieved by downloading specified data branches in advance.

{{Hint|When a branch download is in progress, you can work with the offline data which is already available at the time of the download, but any communication with the content server will be scheduled after the branch download is finished.}}

== Manual Download ==
When using the clients in non-offline sync modes, you can trigger a branch download from any content object. Depending on the clients and the XAML customizings, the UI for starting branch downloads might differ. Here's the default UI on different clients.<gallery widths="300" heights="200">
File:UI_WinX_Branch_Download_Button.png|button in content area top bar (UWP)
File:UI_Xamarin_Branch_Download_Page_Menu.png|button in page menu (Mobile)
File:UI_Xamarin_Branch_Download_Item_Swipe.png|button in item swipe menu (Mobile)
</gallery>
{{Hint|Manual downloads always have higher priorities than automatic downloads. In other words, a manual download will "cut in line" in front of all automatic downloads (except if one is already in the middle of executing).}}

=== BranchDownloadCommand ===

With the ''BranchDownloadCommand'' it is possible to download a branch manually.

* {{Version/WinXSince|4.1}} {{Version/XamarinSince|4.1}} CheckOut CommandParameter (optional, defaults to false): Setting CheckOut to true provides the possibility to check out all downloaded content afterwards. Further information see in [[Exclusive_Access_Content_(Client)]].
* {{Version/WinXSince|4.8}} {{Version/XamarinSince|4.8}} SkipDialog CommandParameter (optional, defaults to false): Usually before downloading a branch a dialog is raised for the user to confirm or cancel the action. Setting SkipDialog to true provides the possibility to skip this dialog.

<br/>
<tabs>
<tab name="UWP">
<source lang = "xml">
<Button
xmlns:example="using:UBIK.WinX.Controls"
Command="{Binding BranchDownloadCommand}">
<Button.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="CheckOut" Value="False" />
</example:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>
<tab name="Mobile(Maui)">
<source lang = "xml">
<Button
xmlns:example="clr-namespace:UBIK.MAUI.Classes;assembly=UBIK.MAUI"
Command="{Binding BranchDownloadCommand}">
<Button.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="CheckOut" Value="False" />
</example:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>
<tab name="Mobile(Xamarin)">
<source lang = "xml">
<Button
xmlns:example="using:clr-namespace:UBIK.CPL.Classes;assembly=UBIK.CPL"
Command="{Binding BranchDownloadCommand}">
<Button.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="CheckOut" Value="False" />
</example:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>
</tabs>

[[Category:Client|Branch Download]]
[[Category:Mobile|Branch Download]]
[[Category:Version 3.8|Branch Download]]
[[Category:WinX|Branch Download]]

== Automatic Download {{Version/WinXSince|3.8}} ==
Content objects can be classified in a way that their branches are automatically downloaded to the clients.
[[SYSCLS_OFFLINE_SYNC_CONFIGURATION|Different configurations]] are supported so that the download can happen at different timing.

== Configurable Offline Sync Levels {{Version/WinXSince|4.7}}==
Content objects can be classified with the [https://wiki.augmensys.com/index.php?title=OFFLINE_SYNC_LEVEL_CLASSIFICATION OFFLINE_SYNC_LEVEL_CLASSIFICATION] to download a certain amount of children levels instead of infinite levels.
{{hint|'''Sublevels to analyze'''<br>
If there are sublevels to analyze all the information on the children will be ignored. Here just the SyncLevel (in this case the ChildDepth) of the root object will be respected.}}
== Download States {{Version/WinXSince|3.8}} ==
To help users better understand what is going on during a branch download, the clients display different icons. The following examples are from the Mobile clients.
<gallery widths="400" heights="120">
File:UI_Xamarin_Branch_Pending.png|pending (to run at least once)
File:UI_Xamarin_Branch_Syncing.png|syncing
File:UI_Xamarin_Branch_Synced.png|synced
File:UI_Xamarin_Branch_Failed.png|failed
</gallery>
{{Hint|All states are displayed for an entire branch. If the parent (direct or indirect) of a child object is syncing, that child object will display the same syncing state.}}
{{Hint|States are displayed in different priorities (syncing > pending > synced/failed). For example, if a child object is syncing and its parent is pending, the child object will "retain" its syncing state. But if their states are switched, the child object's pending state will be "overwritten" by the parent's syncing state. As for the synced/failed states, the more recent one is displayed.}}

== Failed Document Download Dialog {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ==
If the branch download succeeds, but not all documents were downloaded successfully, there's the option to enable a dialog displaying the count of total and actually downloaded documents. The "Open Logs" button provides the possibility to open the related log file in an external text editor to inspect details about the failed document downloads.

[[File:FailedDocumentDownloadDialog.PNG]]

By default, the dialog is deactivated. It can be activated by setting (or adding) the following boolean property in UBIKThemes:
<source lang = "xml">
<x:Boolean x:Key="EnableBranchDownloadDocumentWarning">true</x:Boolean>
</source>

== Background Download ==
{{Version/XamarinSince|4.2}} On Android, {{UBIK}} makes sure branch download tasks are not interrupted/suspended even when the device is locked or in sleep mode. However, this is only possible when {{UBIK}} is excluded from the list of battery usage optimized apps.

To help you check and change this setting, {{UBIK}} will try to lead you to the relevant settings page upon its first launch. But it's also a good idea to check the settings according to the specifications of your specific device models.

[[Category:Client|Branch Download]]
[[Category:Mobile|Branch Download]]
[[Category:Version 3.8|Branch Download]]
[[Category:WinX|Branch Download]]

Version 5.1 (Mobile)

2025-12-18T10:08:53Z

CWI:

{{Attention|Existing pre 5.0 XAMLs are not compatible with UBIK Mobile client 5.1. Please refer to [[HowTo:Convert_Xamarin_XAMLs_to_Maui]] for migrating them to the new client.}}

{{Attention|UBIK 5 clients can only connect to {{UBIK}} Servers of [[Version 3.6(Server)|version 3.6]] and higher!}}

{{Attention|The minimum supported OS versions are:
* Android 9;
* iOS 12.}}

== Availability ==
{{key press|Android: Store}}{{key press|iOS: Store}}: Publicly available in Google Play Store / Apple App Store.

{{key press|Android: Store Beta}}: Publicly available in Google Play Store as beta versions. You can opt in or out of the beta at any time in the store.

{{key press|Android: Store Preview}}: Available through Google Play Store's [https://play.google.com/store/apps/details?id=com.augmensys.ubik.go invitation link].

{{key press|iOS: Store Beta}}: Available through Apple App Store's [https://testflight.apple.com/join/Kmb1HG9E invitation link].

{{key press|iOS: Store Preview}}: Available through Apple App Store's [https://testflight.apple.com/join/yHRnbYbt invitation link].

{{key press|Windows: Store Preview}}: The mobile Windows client is not an official product and is only distributed as test versions upon request and/or in our [https://release.augmensys.com/download/modules/client/mobile/ release portal].
<br/>

{{Attention|Some customized XAMLs might need an update to work properly. These changes are marked with a ⚠️}}

= Release Notes =

== Preview ==

=== 5.1.??? on 202?-??-?? ===
* Fixed an issue where the Chart Thresholds didn't update.
* Added support for configurable file-upload size restrictions, preventing oversized files from being uploaded and providing users with feedback when limits are exceeded.
* (Android) Fixed an issue in the WebView where some links could not be opened.
* Added support for conditionally showing the ImageEditor Save button only when edits have been made, enabled when MergeAnnotationsOnSave is set to true.
* Fixed an issue where the deletion of some objects was not reflected in the UI until refresh.

== Known issues ==
* Due to third-party limitations, the feature that shows the ImageEditor Save button only when edits have been made is only active when MergeAnnotationsOnSave is set to true. In Mobile, deleting the last annotation does not correctly update the editor's internal edit state. As a result, the Save button may remain visible even though no edits exist.
<br/>

= ⚠️ XAML Notes =
Due to the change of the underlying XAML technology, the existing XAMLs for the old mobile clients (pre 5.0) are no longer compatible. Please refer to [[HowTo:Convert_Xamarin_XAMLs_to_Maui]] for migrating them to the new client.

<headertabs />

[[Category:Client|Version 5.1 (Mobile)]]
[[Category:Mobile|Version 5.1 (Mobile)]]
[[Category:Version 5.1|Version 5.1 (Mobile)]]

Version 5.1 (WinX)

2025-12-18T10:08:31Z

CWI: /* Preview */

Version 5.0 (WinX)

2025-12-18T10:07:56Z

CWI:

{{Attention|This version requires [https://en.wikipedia.org/wiki/Windows_10_version_history#Version_1809_(October_2018_Update) Windows 10 build 17763] or higher}}

== Availability ==
{{key press|Store}}: Publicly available in Microsoft Store.

{{key press|Store Beta}} / {{key press|Store Preview}}: Publicly available in Microsoft Store as beta or preview versions to those whose account email is participating in our beta or preview test. To join, please send an email to testing@augmensys.com and provide an email address to add to the list as well as the information which test you want to join. Alternatively you can contact the Augmensys staff and submit your chosen email address.

Example: Please add my email account example@example.com to the '''Beta''' test group for the '''WinX''' client.

<br/>
{{Attention|Some customized XAMLs might need an update to work properly. These changes are marked with ⚠️}}

= Release Notes =

== Release ==

=== 5.0.40 on 2025-12-?? {{key press|Store}} ===
* Fixed an issue where the deletion of some objects was not reflected in the UI until refresh.

=== 5.0.36 on 2025-10-02 {{key press|Store}} ===
* Fixed an issue where task direct editing doesn't work the first time.

=== 5.0.35 on 2025-09-29 {{key press|Store}} ===
* Updated some translations.
* Updated the default Demo profile.
* Updated the notification message about branch download to avoid misunderstanding. When a branch download is in progress, you can work with the offline data which is already available at the time of the download, but any communication with the content server will be scheduled after the branch download is finished.
* Fixed issue that rendered authentication when editing a geo property impossible.
* Fixed an issue that triggered a license warning even on a failed login.
* Fixed an issue where the wizard is shown again when you navigate to a new but saved object offline.
* Fixed an issue where duplicate notifications are shown when you scan an NFC tag for a supervisor task and no fitting supervisor is found.

== Known issues ==
* When editing Guid Link properties, you can no longer further edit the filtering if there are predefined filter parameters (such as the [[Dynamic_Selective_List_(Client)#Dependency_property_values|dependency property values in dynamic selective lists]]). This is because those parameters are to be enforced by design and should not be changed by users. In the future, we might consider a finer level of control over which parameters can be edited in such cases.
* Free Text Annotations that where created in former sessions cannot be selected and therefore cannot be edited any more.
* There are still some [[Annotation_and_HotSpot#Known_issues|known issues with free text and text markup annotations]].
* Known issues regarding the [[Documents_(Client)#Remember_Document_Settings|Remember Document Settings]] feature:
** Saving the Zoom value via touch gestures is not supported.
** Due to a third-party framework issue it can't be guaranteed that saving the Zoom level is always working properly. We reported this issue and will update our solution as soon as it is resolved on their side.

<br/>

= ⚠️ XAML Notes =

<headertabs />

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

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

Version 5.1 (WinX)

2025-12-03T14:10:35Z

CWI:

Version 5.1 (Mobile)

2025-12-03T14:10:26Z

CWI:

{{Attention|Existing pre 5.0 XAMLs are not compatible with UBIK Mobile client 5.1. Please refer to [[HowTo:Convert_Xamarin_XAMLs_to_Maui]] for migrating them to the new client.}}

{{Attention|UBIK 5 clients can only connect to {{UBIK}} Servers of [[Version 3.6(Server)|version 3.6]] and higher!}}

{{Attention|The minimum supported OS versions are:
* Android 9;
* iOS 12.}}

== Availability ==
{{key press|Android: Store}}{{key press|iOS: Store}}: Publicly available in Google Play Store / Apple App Store.

{{key press|Android: Store Beta}}: Publicly available in Google Play Store as beta versions. You can opt in or out of the beta at any time in the store.

{{key press|Android: Store Preview}}: Available through Google Play Store's [https://play.google.com/store/apps/details?id=com.augmensys.ubik.go invitation link].

{{key press|iOS: Store Beta}}: Available through Apple App Store's [https://testflight.apple.com/join/Kmb1HG9E invitation link].

{{key press|iOS: Store Preview}}: Available through Apple App Store's [https://testflight.apple.com/join/yHRnbYbt invitation link].

{{key press|Windows: Store Preview}}: The mobile Windows client is not an official product and is only distributed as test versions upon request and/or in our [https://release.augmensys.com/download/modules/client/mobile/ release portal].
<br/>

{{Attention|Some customized XAMLs might need an update to work properly. These changes are marked with a ⚠️}}

= Release Notes =

== Preview ==

=== 5.1.??? on 202?-??-?? ===
* Fixed an issue where the Chart Thresholds didn't update.
* Added support for configurable file-upload size restrictions, preventing oversized files from being uploaded and providing users with feedback when limits are exceeded.
* (Android) Fixed an issue in the WebView where some links could not be opened.
* Added support for conditionally showing the ImageEditor Save button only when edits have been made, enabled when MergeAnnotationsOnSave is set to true.

== Known issues ==
* Due to third-party limitations, the feature that shows the ImageEditor Save button only when edits have been made is only active when MergeAnnotationsOnSave is set to true. In Mobile, deleting the last annotation does not correctly update the editor's internal edit state. As a result, the Save button may remain visible even though no edits exist.
<br/>

= ⚠️ XAML Notes =
Due to the change of the underlying XAML technology, the existing XAMLs for the old mobile clients (pre 5.0) are no longer compatible. Please refer to [[HowTo:Convert_Xamarin_XAMLs_to_Maui]] for migrating them to the new client.

<headertabs />

[[Category:Client|Version 5.1 (Mobile)]]
[[Category:Mobile|Version 5.1 (Mobile)]]
[[Category:Version 5.1|Version 5.1 (Mobile)]]

Version 5.1 (WinX)

2025-11-27T10:37:08Z

CWI: /* Preview */

XAML

2025-11-27T10:35:34Z

CWI: /* Specific {{UBIK}} Controls */

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="Mobile(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''), or if they should be merged directly into the original file (''true'', this is the default option): {{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 button can be hidden with SaveButtonVisibility="Collapsed"
* The Annotation button can be hidden with AnnotationButtonVisibility="Collapsed"
* The HS button can be hidden with HotspotButtonVisibility="Collapsed"
* The undo and redo operations can be turned on/off with IsUndoEnabled="true/false". The default value is false. When turned off, the two relevant buttons will be hidden in the toolbar. {{Version/WinXSince|4.4}}

{{Attention|Please be careful when you enable undo and redo. Because {{key press|Ctrl}} + {{key press|Z}} (or whichever other combination in your keyboard layout) is the shortcut to trigger an undo. Therefore, it's possible that you accidentally undo/revert your changes in the PDF viewer when you are typing.}}

* The default stroke width for Annotations can be defined with the AnnotationDefaultStrokeWidth property in the UBIKThemes.xaml:
<source lang = "xml">
<x:Double x:Key="AnnotationDefaultStrokeWidth">1</x:Double>
</source>
</tab>

<tab name="Mobile(Xamarin)">
On a Xamarin UBIKPdfViewer instance (e.g. in the UBIKDocumentContentArea template), you can configure its EnableSeparateInkStrokes value.
* True (default): Every ink stroke has its own session. You can select it and change its color/thickness/transparency/etc. separately from others.
* False: If you do not end the session explicitly by exiting the ink mode, all strokes belong in the same session. And they can only be interacted with as a whole.
<source lang = "xml">
xmlns:ctrls="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL"
<ctrls:UBIKPdfViewer
...
EnableSeparateInkStrokes="True" />
</source>
</tab>

</tabs>

==== UBIKWebView {{Version/WinXSince|5.1}} ====
As there is a bug in the WebView2 (only in WinX/UWP) where specific links cannot be opened, we introduced the UBIKWebView, which contains a workaround for this issue.
<br>
Example:
<source lang = "xml">
xmlns:ctrls="using:UBIK.WinX.UI.Controls"
<ctrls:UBIKWebView x:Name="WebContent" Source="{Binding DocumentViewModel.OnlineURI}" />
</source>

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

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

== 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 ==
Working with Properties is a foundational role of the UI customizer. Be aware that the term can refer to various elements of a content object's datamodel, including details like its Title, SubTitle, UID, classification info, etc. However, this article deals specifically with '''content properties'''; those which are displayed under the Property tab in the UBIK client.

=== Displaying Properties ===
Displaying with properties is an extremely common requirement in custom UIs. UBIK offers several different bindings, each with specific benefits. It may be enough to simply display the value of a simple string or numeric property somewhere in your UI, or else you might need to display complex properties or execute a certain property-based command.

The table below clarifies the various functionalities and how they can best be used in different scenarios.

It is important to note that for these bindings we are assuming a content viewmodel (ie. an object observed in the client, either after navigating to it, or else when viewing it as an item in the child list of another content object).

{| class="wikitable"
! Collection !! {{Tooltip|Performance|Could rendering be slowed down by using this binding, especially on ItemTemplates used in a list of many items.}} !! {{Tooltip|Capability|Extent of the viewmodel accessed}} !! {{Tooltip|Lazy-Loaded|Loaded on-demand (vs. always present)}}
|-
| Values || Great || Very limited - Read only, Property value only || No
|-
| PropertyItems || Good || Limited - Read only || No
|-
| PropertyByName || Ok up to 5 uses || Unlimited - Full PropertyViewModel || Yes
|-
| Properties.XItems || Impacted || Unlimited - Full PropertyViewModel || Yes
|-
|}

==== Values[MP_PROPERTY] ====
* This is the most basic and performant way to bind to a property value.
* This collection simply displays the 'true' value of a property, meaning that it is only useful displaying for simple properties, such as String, Int, Dbl, unformatted DateTime, etc. Properties that have a DisplayValue that is different from their true value, such as GUIDs or selective list items with labels, are not best displayed using this binding.
* For complex iproperties, it can be still be used in the xaml for non-display purposes, such as in combination with converters or commands. It is immediately present on the most basic content viewmodel (the ContentListItemViewModels used by child lists) without having to be loaded, and remains the best choice in most cases.

<tabs>
<tab name="Don't Do">
<source lang = "XML">
Command="{Binding NavigateToGuidCommand}" Command Parameter="{Binding Properties.AllItems[MP_GUID].Value}"
</source>
</tab>
<tab name="Instead do">
<source lang = "XML">
Command="{Binding NavigateToGuidCommand}" Command Parameter="{Binding Values[MP_GUID]}"
</source>
</tab>
</tabs>

==== PropertyItems[MP_PROPERTY]... ====
This collection can be used when the Value collection does not suffice for displaying appropriate values. This PropertyViewModel presents more options than the simple Values collection, however, <u>it should still only be used for displaying text in the UI</u> as it bypasses the modern functionality offered by UBIK, such as user rights, locked states, etc.

==== Properties.XItems[MP_PROPERTY]... ====
These collections were created as a response to the criticism that earlier collections like Values and PropertyItems did not expose enough of a content object's viewmodel to be useful to our ever more sophisticated custom UIs. These collections now provide the full PropertyViewModel, where all aspects of a property (including ''it's'' properties, such as Unit attached to Double, the seperate Min/Value/Max valueitems, Date and Time extracted from the DateTime property, Lon/Lat or Alt extracted from the Geo property, and many more) can be accessed in Bindings.
* However, the downside of accessing this huge viewmodel is the noticeable performance impact, as it loads all instances of properties for the context object, even though only one (MP_PROPERTY) is requested. This impact is felt especially when such as binding is used on an item template in a list with many content objects, of which each has many properties.
* These collections are [[Fast_Startup_(Client)|Lazy Loaded]]*, which means that they are not loaded by default, however, a single binding to that collection will load it. When used on an item template in a list, all viewmodels for all properties for all child items will simultaneously be loaded, leading to the performance impact described in this article.
* "Properties.XItems" is not a real collection. The most frequently used collections are Properties.AllItems, Properties.VisibleItems, Properties.EditableItems, and Properties.ImportantItems (properties which fall into the [[UBIK_WinX_Client_Basics#High_priority_properties|Priority threshold]]). The number of properties delivered to a content object in each collection (for example; all, 80%, 40% and 10%, respectively) is also a consideration when estimating the performance impact of binding to these collections; simply put, use the smallest collection possible where the desired property is consistently located.

==== PropertyByName[MP_PROPERTY]... ====
This collection was created to overcome the performance impact arising from using Properties.XItems, by individually loading the PropertyViewModel for the named property. However, note that the benefit only lasts while the binding is used sparingly; rendering performance will be roughly the same as loading the Properties collection after 3-5 uses on a single item template.

{{Hint|The Values[ ] collection delivers the property's value as a string. The equivalent for the other bindings (above shown as '...') is <code>{Binding Collection[PROPERTY_NAME].'''DisplayValue'''}</code>, however, the capability of these viewmodels goes far beyond the DisplayValue. Use [[Developer_Mode]] to learn more.}}

==== * Troubleshooting null property values ====
Because certain property collections are Lazy-loaded as described above, it may be the case that bindings to these properties appear null in certain circumstances, especially if the collection is loaded after the page is rendered, such as through a command or behavior. To troubleshoot this issue, you can ensure that the property collection is accessed during rendertime rather than runtime (simply put, while the page is being constructed rather than during normal use) by applying the same binding to, for example, a Label. This measure should still work if the Label is hidden from view using a visibility binding.

=== Editing Properties ===
There are currently 3 main ways to trigger property editing (aside from direct editing) in XAML:
* [[EditPropertyValueCommand]] uses a MetaProperty name as a parameter, to trigger the editing dialogue for that metaproperty.
** It is located on the ContentViewModel, and automatically triggers a Save and Commit once the edit is confirmed.
* Similarly, the (PropertyViewModel).ShowEditorCommand/.PropertyClickedCommand triggers the editing dialogue, however, being located on the PropertyViewModel, it is necessary to first access a single property, such as by triggering the command on a list item template, or by directly binding to a specific one using a metaproperty indexer.
** These two commands are equivalent, the ShowEditorCommand being more general and redirecting for Live Values or properties with Value Records, or else triggering the PropertyClickedCommand.
** These commands can be seen in action as the standard UI for properties when clicking on the icon to trigger "indirect" editing for any individual metaproperty.
** Property changes are not saved automatically, but set the ToSave flag on the ContentViewModel, meaning that a SaveAndCommit command is required to commit the changes.
* The [[XAML_Tips#SetPropertyValueCommand|Set Property Value Command]] sets a named property to a specific or calculated (such as through an [[EvalExpression]]) value.

== 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="Mobile(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. Similarly, audio document creation requires a file type "*.wav" to be included in the selective list.}}

* 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.

== Object Filtering ==
Filtering of objects is a common requirement in UBIK projects. The table below shows the three main approaches, with the functionality each offers.

{| class="wikitable"
! Type !! Configuration/Requirements !! {{Tooltip|Persisted|Filter criteria are retained when navigating, or even closing the client.}} !! {{Tooltip|Multiple/Complex Values|Multiple user inputs supported for a single filter property.}} !! {{Tooltip|Property type|Data elements supported as filter properties.}} !! {{Tooltip|Possible Item Source|Collections supported as item sources.}}
|-
| Query || Fully defined on the server || Yes || Limited (DateTime, Dbl, Int) where a range is possible. || {{Tooltip|Content properties|The kind displayed in the Property tab of the UBIK client}} only || {{Tooltip|Content objects|The kind displayed in the Children tab of the UBIK client}}, Documents
|-
| Property-Based Content Filters || Defined in XAML, requires custom [[SYSCLS_CHILDAREATEMPLATE|Child Area template name]] || Yes || No || {{Tooltip|Content properties|The kind displayed in the Property tab of the UBIK client}} only || {{Tooltip|Content objects|The kind displayed in the Children tab of the UBIK client}} only
|-
| Dynamic Filters || Fully defined in XAML || No || Yes || Any bindable data (eg. Content properties, metadefinitions, etc). || Content objects, Properties, Documents, etc
|-
|}

A [[Query]] is a container that delivers a defined collection of content objects. Properties can be added to the query to serve as filter criteria, where a user can perform their search by editing these properties.

[[Property_Based_Content_Filters]] are a xaml-based customization that connects a user input control (usually a textbox) with a specific content property on the content object. This user input is converted into filter criteria and applied directly to the child list, where only matched objects are retained.

[[HowTo:Implement_Custom_Filtering|Dynamic Filtering]] is the most flexible, but also the most complex, method of XAML-based filtering. A set of [[EvalExpression|EvalExpressions]] converts user inputs into a complex filter string, which is then applied immediately to whichever ItemsSource is defined in the [[XAML_Changes_in_UBIK_WinX_3.5#Filtering_by_expressions|ListCollectionView]]/[[Xamarin_XAML#FeatureRelated|SfDataSourceExt]]. Note that in this approach, user inputs are not directly connected to any data, which means that reloading the page in any way (eg. by navigation) causes the input controls to return to their xaml-defined state.

{{Attention|While any of the above approaches can be used, it is never recommended to mix approaches, as this causes multiple rounds of filtering per keystroke that will noticeably impact performance, especially when many objects and filters are involved!}}

== Miscellaneous ==
<br>

=== Behaviors in style definitions ===
It's very common and easy to attach behaviors to different UI controls to extend their functionalities. For example, see [[#Advanced_2|StringFormatConverter]].

For better code reusability, it's sometimes necessary to implement the functionality of a control in a style so that it can be applied to the same control used in various occasions. In this case, the regular behaviors won't work and you have to use a special type AttachBehavior with some limitations. Below is such an example.

<tabs>
<tab name="UWP">
In this example, a style for the Grid control is defined with a behavior which executes the EditPropertyValueCommand upon tapped. There are two things to note here:
* When attaching multiple behaviors to controls, you have to explicitly declare a BehaviorCollection and place all behaviors underneath. Unlike outside of style definitions, this is mandatory. Without it, only the last behavior will be effective.
* Bindings work the same way in general. However, it's not possible to bind to named elements through the <code>"{Binding ElementName=someName, Path=..."</code> syntax and there doesn't seem to be a way to achieve similar goals.
<source lang = "xml">
xmlns:behaviors="using:UBIK.WinX.Behaviors"
xmlns:core="using:Microsoft.Xaml.Interactions.Core"
<Style x:Key="UBIKNamePropertyGrid" TargetType="Grid">
<Setter Property="behaviors:AttachBehavior.Behaviors">
<Setter.Value>
<behaviors:BehaviorCollection>
<core:EventTriggerBehavior EventName="Tapped">
<core:InvokeCommandAction Command="{Binding EditPropertyValueCommand}" CommandParameter="MP_NAME" />
</core:EventTriggerBehavior>
</behaviors:BehaviorCollection>
</Setter.Value>
</Setter>
</Style>
</source>
</tab>
</tabs>
<br>

=== UBIKContentControl ===
In UWP XAML, one often uses a <code><ContentControl ... ContentTemplateSelector="{StaticResource TaskPropertyTemplateSelector}" /></code> to choose different templates depending on the binding context.
However, it seems to have its limit, namely the template selection happens only once at the beginning. In other words, the template will not change even when the binding context later changes and another template would be the choice.
For such scenarios, we have created a UBIKContentControl. See the example below.
<tabs>
<tab name="UWP">
When the IsLocked status changes on the ContentViewModel, the task direct edit template will be reselected.
<source lang = "xml">
xmlns:controls="using:UBIK.WinX.Controls"
<controls:UBIKContentControl
Content="{Binding MROViewModel}"
ContentTemplateSelector="{StaticResource TaskPropertyTemplateSelector}"
TemplateReselectTrigger="{Binding IsLocked}" />
</source>
</tab>
</tabs>
<br>

== Custom Icons ==
Moved to article [[XAML_Tips#Custom_Icons]].
<br>
<br>

== Differences between Mobile and UWP ==
As you maybe already noticed we have two different clients, one is WinX UWP and the other one Mobile, which is used to develop clients for three different platforms namely iOS, Android and Windows (-> it doesn’t really differentiate from the previously mentioned UWP except it’s developed in a different framework which is Maui 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 Mobile that you used in UWP.
More specific documentations about Mobile Customizing can be found under [[Mobile XAML]].

{{Attention|Please consider that Mobile Windows is not an official product and therefore it can't be guaranteed that all our features work without issues.}}

[[Category:Mobile|XAML]]
[[Category:WinX|XAML]]
[[Category:XAML|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:Mobile|XAML]]
[[Category:WinX|XAML]]
[[Category:XAML|XAML]]

Version 5.1 (Mobile)

2025-11-27T10:33:22Z

CWI: /* 5.1.??? on 202?-??-?? */

{{Attention|Existing pre 5.0 XAMLs are not compatible with UBIK Mobile client 5.1. Please refer to [[HowTo:Convert_Xamarin_XAMLs_to_Maui]] for migrating them to the new client.}}

{{Attention|UBIK 5 clients can only connect to {{UBIK}} Servers of [[Version 3.6(Server)|version 3.6]] and higher!}}

{{Attention|The minimum supported OS versions are:
* Android 9;
* iOS 12.}}

== Availability ==
{{key press|Android: Store}}{{key press|iOS: Store}}: Publicly available in Google Play Store / Apple App Store.

{{key press|Android: Store Beta}}: Publicly available in Google Play Store as beta versions. You can opt in or out of the beta at any time in the store.

{{key press|Android: Store Preview}}: Available through Google Play Store's [https://play.google.com/store/apps/details?id=com.augmensys.ubik.go invitation link].

{{key press|iOS: Store Beta}}: Available through Apple App Store's [https://testflight.apple.com/join/Kmb1HG9E invitation link].

{{key press|iOS: Store Preview}}: Available through Apple App Store's [https://testflight.apple.com/join/yHRnbYbt invitation link].

{{key press|Windows: Store Preview}}: The mobile Windows client is not an official product and is only distributed as test versions upon request and/or in our [https://release.augmensys.com/download/modules/client/mobile/ release portal].
<br/>

{{Attention|Some customized XAMLs might need an update to work properly. These changes are marked with a ⚠️}}

= Release Notes =

== Preview ==

=== 5.1.??? on 202?-??-?? ===
* Fixed an issue where the Chart Thresholds didn't update.
* Added support for configurable file-upload size restrictions, preventing oversized files from being uploaded and providing users with feedback when limits are exceeded.
* (Android) Fixed an issue in the WebView where some links could not be opened.

[[Category:Client|Version 5.1 (Mobile)]]
[[Category:Mobile|Version 5.1 (Mobile)]]
[[Category:Version 5.1|Version 5.1 (Mobile)]]

== Known issues ==
-
<br/>

= ⚠️ XAML Notes =
Due to the change of the underlying XAML technology, the existing XAMLs for the old mobile clients (pre 5.0) are no longer compatible. Please refer to [[HowTo:Convert_Xamarin_XAMLs_to_Maui]] for migrating them to the new client.

<headertabs />

[[Category:Client|Version 5.1 (Mobile)]]
[[Category:Mobile|Version 5.1 (Mobile)]]
[[Category:Version 5.1|Version 5.1 (Mobile)]]