Class NavigationModeBase

Provides a base class from which implementations of INavigationMode may derive.

Inheritance

System.Object

NavigationModeBase

CompleteDdiMode

LimitedTypeModeBase

ModernNavigationMode

ResourceMode

LimitedPathModeBase

Namespace: Algenta.Colectica.Navigator.Modes

Assembly: Algenta.Colectica.ViewModel.dll

Syntax

public abstract class NavigationModeBase : object, INavigationMode

Properties

IncludedTypes

Gets an array of all IVersionable item types that may be displayed by this mode.

Declaration

public abstract Guid[] IncludedTypes { get; }

Property Value

Type	Description
Guid[]	The included types.

Implements

INavigationMode.IncludedTypes

Name

Gets the name of the navigation mode, which may be displayed in user interfaces that allow the user to switch between different modes.

Declaration

public string Name { get; protected set; }

Property Value

Type	Description
System.String

Implements

INavigationMode.Name

Weight

Gets the order in which this Addin should be displayed. Lower values are displayed higher or further to the left.

Declaration

public int Weight { get; protected set; }

Property Value

Type	Description
System.Int32

Implements

INavigationMode.Weight

Methods

AreChildrenRemote(Node)

Returns a value indicating whether the children of the specified node are determined by making network calls.

Declaration

public abstract bool AreChildrenRemote(Node item)

Parameters

Type	Name	Description
Node	item	The item for which children will be requested.

Returns

Type	Description
System.Boolean	true if network activity is required to determine the children of the specified node; otherwise false.

Implements

INavigationMode.AreChildrenRemote(Node)

GetChildItems(Node)

Gets the child items of the specified node. If AreChildrenRemote returned true, this method wil be called on a background thread.

Declaration

public abstract Collection<Node> GetChildItems(Node item)

Parameters

Type	Name	Description
Node	item	The node for which children are being requested.

Returns

Type	Description
Collection<Node>	A list of nodes that will be added as children of the specified node.

Implements

INavigationMode.GetChildItems(Node)

GetChildrenOfType(Guid, Node, Boolean)

Gets a list of nodes that will become children of the specified item.

Declaration

public Collection<Node> GetChildrenOfType(Guid targetType, Node item, bool addPlaceholders)

Parameters

Type	Name	Description
Guid	targetType	The type of items to find.
Node	item	The item for which children are being searched.
System.Boolean	addPlaceholders	if set to true a placeholder node is added as a child to each newly created node.

Returns

Type	Description
Collection<Node>	A list of nodes that will become children of the specified item.

GetChildrenOfType(Guid[], Node, Boolean)

Gets a list of nodes that will become children of the specified item.

Declaration

public Collection<Node> GetChildrenOfType(Guid[] targetTypes, Node item, bool addPlaceholders)

Parameters

Type	Name	Description
Guid[]	targetTypes	The types of items to find.
Node	item	The item for which children are being searched.
System.Boolean	addPlaceholders	if set to true a placeholder node is added as a child to each newly created node.

Returns

Type	Description
Collection<Node>	A list of nodes that will become children of the specified item.

Extension Methods

Extensions.Yield<T>(T)