Class LimitedPathModeBase

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

Inheritance
System.Object
NavigationModeBase
LimitedPathModeBase
SubjectNavigationModeBase
Inherited Members
Namespace: Algenta.Colectica.ViewModel.Navigator.Modes
Assembly: Algenta.Colectica.ViewModel.dll
Syntax
public class LimitedPathModeBase : NavigationModeBase, INavigationMode

Constructors

LimitedPathModeBase(String, Guid, Int32, Guid[])

Initializes a new instance of the LimitedPathModeBase class.

Declaration
public LimitedPathModeBase(string name, Guid targetType, int weight, params Guid[] topLevelTypes)
Parameters
Type Name Description
System.String name

The name of the mode.
Guid targetType

The type of item that will be a leaf node in the navigation hierarchy.
System.Int32 weight

The weight of the mode, used when the mode is displayed in a list of modes.
Guid[] topLevelTypes

The item types that may appear at the top level of the navigation hierarchy defined by the mode.

Properties

IncludedTypes

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

Declaration
public override Guid[] IncludedTypes { get; }
Property Value
Type Description
Guid[]
Overrides

Paths

Gets a list of paths that are valid in this mode.

Declaration
public List<LimitedPath> Paths { get; }
Property Value
Type Description
List<LimitedPath>

TargetType

Gets or sets the type item that will be a leaf node in the navigation hierarchy.

Declaration
public Guid TargetType { get; set; }
Property Value
Type Description
Guid

Methods

AreChildrenRemote(Node)

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

Declaration
public override 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.
Overrides

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 override 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.
Overrides

Extension Methods