Interface INavigationModeGroup
Provides properties and methods that Addins can use to define a custom Task Mode user interface.
Namespace: Algenta.Colectica.Navigator
Assembly: Algenta.Colectica.ViewModel.dll
Syntax
public interface INavigationModeGroupProperties
Modes
Gets a list of navigation modes available as part of the Task Mode defined by the implementing class.
Declaration
List<INavigationMode> Modes { get; }Property Value
| Type | Description |
|---|---|
| List<INavigationMode> |
Name
The name of the Task Mode.
Declaration
string Name { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Weight
The order in which the interface should be listed on the Task Mode's main screen
Declaration
int Weight { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Remarks
The Task Mode's main screen is currently hard-coded, so this property is not yet used.
Methods
PropagateVersionChange(Node, IVersionable, MultilingualString)
Propagates the version change to other items.
Declaration
Collection<IVersionable> PropagateVersionChange(Node editedNode, IVersionable editedItem, MultilingualString logMessage)Parameters
| Type | Name | Description |
|---|---|---|
| Node | editedNode | The node that was changed. |
| IVersionable | editedItem | The IVersionable item that was changed |
| MultilingualString | logMessage | The log message. |
Returns
| Type | Description |
|---|---|
| Collection<IVersionable> | A collection of items, including the changed item, which have had their version changed as a result of the change to the editedItem. |
ShouldViewBeReadOnly(RepositoryItemNode, ObservableCollection<String>)
Allows a TaskMode to determine whether the item being opened should be presented to the user with a read-only view.
Declaration
bool ShouldViewBeReadOnly(RepositoryItemNode node, ObservableCollection<string> tags)Parameters
| Type | Name | Description |
|---|---|---|
| RepositoryItemNode | node | A navigation node representing the item being opened. |
| ObservableCollection<System.String> | tags | The tags assigned to the item being opened. |
Returns
| Type | Description |
|---|---|
| System.Boolean |