Kpok Patagon Framework

ParameterTreeNode

A node of the parameter tree.

Namespace:
KpokPatagon.Parameters
Type:
Class
Public:
Yes
Protected:
No
Sealed:
No
Abstract:
No
Implements:
KpokPatagon.Parameters.IParameterTreeNode

Constructors

ParameterTreeNode

Default constructor

Signature:
public Void ParameterTreeNode()

Properties

Caption

Localized caption.

Signature:
public String Caption { get; set; }

ChildNodes

List of child nodes.

Signature:
public IList<IParameterTreeNode> ChildNodes { get; }

Description

Localized description.

Signature:
public String Description { get; set; }

Name

Name of the tree node.

Signature:
public String Name { get; set; }

Parameters

A collection of parameter configuration for this node.

Signature:
public IList<ParameterConfiguration> Parameters { get; }

Parent

A reference to the parent node.

Signature:
public IParameterTreeNode Parent { get; set; }

Methods

FindGroup

Finds a parameter group with the specified name.

Signature:
public IParameterTreeNode FindGroup(name)
Returns

An IParameterTreeNodefor the specified name or null is there is no group for the specified name.

Parameters
Name Type Summary
name String Name of the parameter group to look for.
Exceptions
Type Summary
ArgumentNullOrEmptyException Thrown when name is null or empty.

FindParameter

Finds a parameter with the specified name.

Signature:
public ParameterConfiguration FindParameter(name)
Returns

A ParameterConfiguration for the specified name or null if there is no parameter with the specified name.

Parameters
Name Type Summary
name String Name of the parameter to find.
Exceptions
Type Summary
ArgumentNullOrEmptyException Thrown when name is null or empty.

ToString

Returns a textual representation of this tree node.

Signature:
public String ToString()

In this document