Show / Hide Table of Contents

Interface IModernShell

Provides methods to interact with the Colectica desktop application.

Namespace: Algenta.Colectica.ViewModel
Assembly: Algenta.Colectica.ViewModel.dll
Syntax
public interface IModernShell

Properties

Client

Gets the repository client from which the active item was retrieved.

Declaration
RepositoryClientBase Client { get; }
Property Value
Type Description
RepositoryClientBase

CurrentNode

Gets the navigator Node currently displayed in the main item view.

Declaration
Node CurrentNode { get; }
Property Value
Type Description
Node

SelectedRemoteClient

Gets the repository client that is selected in the ribbon.

Declaration
RepositoryClientBase SelectedRemoteClient { get; }
Property Value
Type Description
RepositoryClientBase

Methods

NavigateTo(Node, object, bool, bool)

Displays an item in the main content view.

Declaration
void NavigateTo(Node node, object vm, bool requiresBreadcrumb = true, bool requiresSave = false)
Parameters
Type Name Description
Node node

The navigator node of the item to be displayed.

object vm

The item to be displayed. A DataTemplate should exist for the item's type.

bool requiresBreadcrumb

if set to true a breadcrumb will be added to the navigation.

bool requiresSave

if set to true the shell should save the active item before showing the new item.

NavigateToItem(RepositoryItemMetadata)

Retrieves an IVersionable item using the current Client, and displays the item.

Declaration
void NavigateToItem(RepositoryItemMetadata metadata)
Parameters
Type Name Description
RepositoryItemMetadata metadata

An item description containing the identification of the item to be retrieved and displayed.

ShowFlyout(IFlyout)

Displays a flyout view.

Declaration
void ShowFlyout(IFlyout vm)
Parameters
Type Name Description
IFlyout vm

The flyout to be displayed.

In this article
Back to top Generated by DocFX