View source for Multi Select (UBIK Client)

The Multi Select mode aims to improve the efficiency of performing actions on a large number of selected objects (XAMARIN & 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 an item, activates the Multi Select mode. A panel at the left side gets displayed.
</tab>

<tab name="XAMARIN">
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>

=== Multi Select panel ===

<tabs>
<tab name="UWP">
The header displays the count of the currently selected items and three buttons.
The first one is to selecting all items, the second for deselecting all items at one click. The "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 dont share any common properties, it will remain empty.
The "other options" tab contains buttons to perform actions on all selected items.
</tab>

<tab name="XAMARIN">
The Multi Select panel in the XAMARIN 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 (XAMARIN)]]

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

In UWP, there are some additional selection options further to the above mentioned "Select All" and "Deselect All" buttons. 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 not yet included in the XAMARIN UI.

==== Copy and Paste ====
To copy multiple branches, the <code>CopyBranchesCommand</code> can be used without any additional CommandParameters.
The <code>PasteBranchCommand</code> already supports pasting multiple branches, therefore, it can be used to paste the previously copied objects. To clarify, the UI (XAMARIN & 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.

[[Category:WinX|Mass Edit (UBIK WinX)]]

==== Download Branches ====
To download multiple branches, <code>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>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>InvokeOnItemsCommand</code> with a KeyValueList containing <code>Key="Command"</code> and <code>Value="DeleteContentCommand"</code> as CommandParameter can be used.

==== Download and Checkout ====
The Download and Checkout actions are not yet included in the XAMARIN UI. As shown in the following UWP example, it can be provided like 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 InvokeOnItemsCommand}">
    <Button.CommandParameter>
        <controls:KeyValueList>
            <controls:KeyValueParameter Key="Command" Value="BranchDownloadCommand" />
            <controls:KeyValueParameter Key="CheckOut" Value="True" />
        </controls:KeyValueList>
    </Button.CommandParameter>
</Button>
</source>

[[Category:WinX|Mass Edit (UBIK WinX)]]

==== Checkout ====
To checkout multiple objects, the <code>InvokeOnItemsCommand</code> with a KeyValueList containing <code>Key="Command"</code> and <code>Value="CheckOutContentCommand"</code> and a KeyValueList with <code>Key="SelectedItemsOnly"</code> set to <code>Value="True"</code> as CommandParameter can be used. It can be inspected in the following UWP example. The Checkout action is not yet included in the XAMARIN UI.
<source lang = "xml">
<Button ... Command="{Binding InvokeOnItemsCommand}">
    <Button.CommandParameter>
        <controls:KeyValueList>
            <controls:KeyValueParameter Key="Command" Value="CheckOutContentCommand" />
            <controls:KeyValueParameter Key="SelectedItemsOnly" Value="True" />
        </controls:KeyValueList>
    </Button.CommandParameter>
</Button>

</source>

[[Category:WinX|Mass Edit (UBIK WinX)]]

==== Release ====
Releasing selected objects is similar to the Checkout action, except for one parameter. Therefore, the <code>InvokeOnItemsCommand</code> with a KeyValueList containing <code>Key="Command"</code> and <code>Value="ReleaseContentCommand"</code> and a KeyValueList with <code>Key="SelectedItemsOnly"</code> set to <code>Value="True"</code> as CommandParameter can be implemented. The Release action is not yet included in the XAMARIN UI.

==== Revert local changes ====
To revert locally executed changes on objects, the <code>InvokeOnItemsCommand</code> with a KeyValueList containing <code>Key="Command"</code> and <code>Value="RevertLocalChangesCommand"</code> as CommandParameter should be used. The Revert local changes action is not yet included in the XAMARIN UI.

[[Category:WinX|Mass Edit (UBIK WinX)]]

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

[[Category:WinX|Mass Edit (UBIK WinX)]]