Interface IItemPickerNavigation
Provides an extension point for addins to customize the navigation of the ItemPicker.
Namespace: Algenta.Colectica.ViewModel
Assembly: Algenta.Colectica.ViewModel.dll
Syntax
public interface IItemPickerNavigationProperties
HideDetails
Gets a value indicating whether the ItemPicker's details area should be hidden when this addin is active.
Declaration
bool HideDetails { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
HideNavigator
Gets a value indicating whether the ItemPicker's navigator area should be hidden when this addin is active.
Declaration
bool HideNavigator { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Title
Gets text to be displayed in a banner at the top of the ItemPicker.
Declaration
string Title { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Methods
CanHandleItemSelection(ItemPickerContext)
Determines whether this addin will provide navigation information, based on the given the context.
Declaration
bool CanHandleItemSelection(ItemPickerContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ItemPickerContext | context | Describes the situation in which the ItemPicker is being displayed to the user. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
GetHistory(Node)
Gets the history for the provided node.
Declaration
Collection<Node> GetHistory(Node node)Parameters
| Type | Name | Description |
|---|---|---|
| Node | node | The node for which to retrieve history. |
Returns
| Type | Description |
|---|---|
| Collection<Node> | A list of nodes representing each version of the item represented by the node. |
GetNavigationNodes(ItemPickerContext)
Gets the navigation nodes to be displayed on the left side of the ItemPicker.
Declaration
Collection<Node> GetNavigationNodes(ItemPickerContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ItemPickerContext | context | Describes the situation in which the ItemPicker is being displayed to the user. |
Returns
| Type | Description |
|---|---|
| Collection<Node> |
GetSearchResults(ItemPickerContext, Node, String)
Gets the search results to be displayed on the right side of the ItemPicker.
Declaration
Collection<Node> GetSearchResults(ItemPickerContext context, Node selectedNode, string searchText)Parameters
| Type | Name | Description |
|---|---|---|
| ItemPickerContext | context | Describes the situation in which the ItemPicker is being displayed to the user. |
| Node | selectedNode | The node selected on the left side of the ItemPicker. |
| System.String | searchText | The search text entered by the user. |
Returns
| Type | Description |
|---|---|
| Collection<Node> |
HandleSelectedItem(IVersionable, Object)
Called when an item is selected from the ItemPicker.
Declaration
void HandleSelectedItem(IVersionable referencingItem, object item)Parameters
| Type | Name | Description |
|---|---|---|
| IVersionable | referencingItem | The item that should reference the selected item. |
| System.Object | item | The item that was selected from the ItemPicker. |