Class CompleteDdiMode

Represents the navigation mode used by Colectica Designer's Navigator control.

Inheritance

System.Object

NavigationModeBase

CompleteDdiMode

Inherited Members

NavigationModeBase.Name

NavigationModeBase.Weight

NavigationModeBase.GetChildrenOfType(Guid, Node, Boolean)

NavigationModeBase.GetChildrenOfType(Guid[], Node, Boolean)

Namespace: Algenta.Colectica.Navigator.Modes

Assembly: Algenta.Colectica.ViewModel.dll

Syntax

public class CompleteDdiMode : NavigationModeBase, INavigationMode

Constructors

CompleteDdiMode()

Initializes a new instance of the CompleteDdiMode class.

Declaration

public CompleteDdiMode()

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[]	The included types.

Overrides

NavigationModeBase.IncludedTypes

Remarks

Returns an empty array, because it should search all types.

Labels

Declaration

public ModernNavigationLabels Labels { get; set; }

Property Value

Type	Description
ModernNavigationLabels

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

NavigationModeBase.AreChildrenRemote(Node)

GetAllTypeGroups(Node, Boolean, ModernNavigationLabels)

Gets all type groups, which are used to organize item types in a categorical manner.

Declaration

public static Collection<Node> GetAllTypeGroups(Node parent, bool addPlaceholders, ModernNavigationLabels labels)

Parameters

Type	Name	Description
Node	parent	The parent item that will be associated with the newly created nodes.
System.Boolean	addPlaceholders	if set to true a placeholder node is added as a child to each newly created node.
ModernNavigationLabels	labels

Returns

Type	Description
Collection<Node>	A list of nodes to be added to a navigation hierarchy.

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

NavigationModeBase.GetChildItems(Node)

GetChildItems(Node, Boolean)

Gets the items that will become children of the specified item.

Declaration

public Collection<Node> GetChildItems(Node item, bool addPlaceholders)

Parameters

Type	Name	Description
Node	item	The parent node that will be associated with newly created nodes.
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 be added as children of the specified node.

GetResourcePackageTypeGroups(Node, Boolean)

Gets a hierarchical node structure to represent all DDI types found under ResourcePackages, grouped by category.

Declaration

public static Collection<Node> GetResourcePackageTypeGroups(Node parent, bool addPlaceholders)

Parameters

Type	Name	Description
Node	parent	The parent item that will be associated with the newly created nodes.
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 to be added to a navigation hierarchy.

GetTypeItemsForRepositoryItem(RepositoryItemMetadata, Node, Boolean)

Gets a list of nodes to display under the specified repository item node.

Declaration

public static Collection<Node> GetTypeItemsForRepositoryItem(RepositoryItemMetadata rim, Node parent, bool addPlaceholders)

Parameters

Type	Name	Description
RepositoryItemMetadata	rim	The item description of the item represented by the parent node.
Node	parent	The parent node which will be associated with newly created nodes.
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 be added as children of the specified node.

Extension Methods

Extensions.Yield<T>(T)