Show / Hide Table of Contents

Class ItemFinderMode

Represents a navigation mode used by Colectica Designer's ItemPicker.

Inheritance
System.Object
ItemFinderMode
Namespace: Algenta.Colectica.ViewModel.Navigator.Modes
Assembly: Algenta.Colectica.ViewModel.dll
Syntax
public class ItemFinderMode : object, INavigationMode

Constructors

ItemFinderMode(Guid, Guid[])

Initializes a new instance of the ItemFinderMode class.

Declaration
public ItemFinderMode(Guid targetType, Guid[] targetParentTypes)
Parameters
Type Name Description
Guid targetType

Gets or sets the type of the item being searched for in the ItemPicker.

Guid[] targetParentTypes

Gets the item types of items that are listed as parent types on the left side of the ItemPicker.

Properties

IncludedTypes

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

Declaration
public 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; }
Property Value
Type Description
System.String
Implements
INavigationMode.Name

TargetParentTypes

Gets the item types of items that are listed as parent types on the left side of the ItemPicker.

Declaration
public Collection<Guid> TargetParentTypes { get; }
Property Value
Type Description
Collection<Guid>

The target parent types.

TargetType

Gets or sets the type of the item being searched for in the ItemPicker.

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

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; }
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 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 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)

Extension Methods

Extensions.Yield<T>(T)
Back to top Copyright © 2009-2018 Colectica