Class CustomAttributesTreeHelper

Helper methods for ICamApiCustomAttributesTree

Inheritance

object

CustomAttributesTreeHelper

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: CAMAPI.DotnetHelper

Assembly: CAMAPI.DotnetHelper.dll

Syntax

public static class CustomAttributesTreeHelper

Methods

Arr(ComWrapper<ICamApiCustomAttributesTree>)

Get child node as Array by its full name (divided by dots).

Declaration

public static ComWrapper<ICamApiCustomAttributesArrayValueIndexer> Arr(this ComWrapper<ICamApiCustomAttributesTree> tree)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTree>	tree

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesArrayValueIndexer>

AsArray(ComWrapper<ICamApiCustomAttributesTree>)

Cast of this node to array if its type is array exactly, otherwise null.

Declaration

public static ComWrapper<ICamApiCustomAttributesTreeNodesArray> AsArray(this ComWrapper<ICamApiCustomAttributesTree> tree)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTree>	tree

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesTreeNodesArray>

Bol(ComWrapper<ICamApiCustomAttributesTree>)

Get or set child node value as Boolean by its full name (divided by dots).

Declaration

public static ComWrapper<ICamApiCustomAttributesBooleanValueIndexer> Bol(this ComWrapper<ICamApiCustomAttributesTree> tree)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTree>	tree

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesBooleanValueIndexer>

ClearAllUndefinedAttributes(ComWrapper<ICamApiCustomAttributesTree>)

Delete all attributes from the object that are not defined in any of the libraries attached to the application. Returns true if at least one of attributes deleted, otherwise false.

Declaration

public static bool ClearAllUndefinedAttributes(this ComWrapper<ICamApiCustomAttributesTree> tree)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTree>	tree

Returns

Type	Description
bool

CreateIterator(ComWrapper<ICamApiCustomAttributesTree>)

Creates new attributes tree iterator which points to root.

Declaration

public static ComWrapper<ICamApiCustomAttributesTreeIterator> CreateIterator(this ComWrapper<ICamApiCustomAttributesTree> tree)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTree>	tree

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesTreeIterator>

FindNodeByInstanceID(ComWrapper<ICamApiCustomAttributesTree>, Guid, bool)

Find node by its InstanceID in tree of nodes. If Deep is true then it will search inside child nodes too.

Declaration

public static ComWrapper<ICamApiCustomAttributesTreeNode> FindNodeByInstanceID(this ComWrapper<ICamApiCustomAttributesTree> tree, Guid instanceID, bool deep)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTree>	tree
Guid	instanceID
bool	deep

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesTreeNode>

FindNodeByName(ComWrapper<ICamApiCustomAttributesTree>, string)

Find node by its full name in tree of nodes (divided by dots).

Declaration

public static ComWrapper<ICamApiCustomAttributesTreeNode> FindNodeByName(this ComWrapper<ICamApiCustomAttributesTree> tree, string fullName)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTree>	tree
string	fullName

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesTreeNode>

FindNodeByTypeID(ComWrapper<ICamApiCustomAttributesTree>, Guid, bool)

Find node by its TypeID in tree of nodes. If Deep is true then it will search inside child nodes too.

Declaration

public static ComWrapper<ICamApiCustomAttributesTreeNode> FindNodeByTypeID(this ComWrapper<ICamApiCustomAttributesTree> tree, Guid typeID, bool deep)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTree>	tree
Guid	typeID
bool	deep

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesTreeNode>

Flt(ComWrapper<ICamApiCustomAttributesTree>)

Get or set child node value as Floating point number by its full name (divided by dots).

Declaration

public static ComWrapper<ICamApiCustomAttributesFloatValueIndexer> Flt(this ComWrapper<ICamApiCustomAttributesTree> tree)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTree>	tree

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesFloatValueIndexer>

HasNode(ComWrapper<ICamApiCustomAttributesTree>, string)

Returns true only if there is a node with specified full name in tree of nodes (divided by dots).

Declaration

public static bool HasNode(this ComWrapper<ICamApiCustomAttributesTree> tree, string fullName)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTree>	tree
string	fullName

Returns

Type	Description
bool

Int(ComWrapper<ICamApiCustomAttributesTree>)

Get or set child node value as Integer by its full name (divided by dots).

Declaration

public static ComWrapper<ICamApiCustomAttributesIntegerValueIndexer> Int(this ComWrapper<ICamApiCustomAttributesTree> tree)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTree>	tree

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesIntegerValueIndexer>

Root(ComWrapper<ICamApiCustomAttributesTree>)

Root node of the tree.

Declaration

public static ComWrapper<ICamApiCustomAttributesTreeNode> Root(this ComWrapper<ICamApiCustomAttributesTree> tree)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTree>	tree

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesTreeNode>

Str(ComWrapper<ICamApiCustomAttributesTree>)

Get or set child node value as String by its full name (divided by dots).

Declaration

public static ComWrapper<ICamApiCustomAttributesStringValueIndexer> Str(this ComWrapper<ICamApiCustomAttributesTree> tree)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTree>	tree

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesStringValueIndexer>