Show / Hide Table of Contents

Class CustomAttributesTreeNodeHelper

Helper methods for ICamApiCustomAttributesTreeNode

Inheritance

object

CustomAttributesTreeNodeHelper

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 CustomAttributesTreeNodeHelper

Methods

Arr(ComWrapper<ICamApiCustomAttributesTreeNode>)

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

Declaration

public static ComWrapper<ICamApiCustomAttributesArrayValueIndexer> Arr(this ComWrapper<ICamApiCustomAttributesTreeNode> node)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesArrayValueIndexer>

AsArray(ComWrapper<ICamApiCustomAttributesTreeNode>)

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

Declaration

public static ComWrapper<ICamApiCustomAttributesTreeNodesArray> AsArray(this ComWrapper<ICamApiCustomAttributesTreeNode> node)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesTreeNodesArray>

Attribute(ComWrapper<ICamApiCustomAttributesTreeNode>)

Attribute of the node.

Declaration

public static ComWrapper<ICamApiCustomAttribute> Attribute(this ComWrapper<ICamApiCustomAttributesTreeNode> node)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node

Returns

Type	Description
ComWrapper<ICamApiCustomAttribute>

Bol(ComWrapper<ICamApiCustomAttributesTreeNode>)

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

Declaration

public static ComWrapper<ICamApiCustomAttributesBooleanValueIndexer> Bol(this ComWrapper<ICamApiCustomAttributesTreeNode> node)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesBooleanValueIndexer>

Child(ComWrapper<ICamApiCustomAttributesTreeNode>)

First child node for this node.

Declaration

public static ComWrapper<ICamApiCustomAttributesTreeNode> Child(this ComWrapper<ICamApiCustomAttributesTreeNode> node)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesTreeNode>

CreateUntypedArrayChild(ComWrapper<ICamApiCustomAttributesTreeNode>, string)

Creates child instance array attribute that does not have any corresponding type attribute in the libraries.

Declaration

public static ComWrapper<ICamApiCustomAttributesArray> CreateUntypedArrayChild(this ComWrapper<ICamApiCustomAttributesTreeNode> node, string attributeName)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node
string	attributeName

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesArray>

CreateUntypedBooleanChild(ComWrapper<ICamApiCustomAttributesTreeNode>, string)

Creates child instance attribute with boolean value that does not have any corresponding type attribute in the libraries.

Declaration

public static ComWrapper<ICamApiBooleanCustomAttribute> CreateUntypedBooleanChild(this ComWrapper<ICamApiCustomAttributesTreeNode> node, string attributeName)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node
string	attributeName

Returns

Type	Description
ComWrapper<ICamApiBooleanCustomAttribute>

CreateUntypedCategoryChild(ComWrapper<ICamApiCustomAttributesTreeNode>, string)

Creates child instance category attribute that does not have any corresponding type attribute in the libraries.

Declaration

public static ComWrapper<ICamApiCustomAttributeCategory> CreateUntypedCategoryChild(this ComWrapper<ICamApiCustomAttributesTreeNode> node, string attributeName)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node
string	attributeName

Returns

Type	Description
ComWrapper<ICamApiCustomAttributeCategory>

CreateUntypedChild(ComWrapper<ICamApiCustomAttributesTreeNode>, string, string)

Creates child instance attribute that does not have any corresponding type attribute in the libraries.

Declaration

public static ComWrapper<ICamApiCustomAttribute> CreateUntypedChild(this ComWrapper<ICamApiCustomAttributesTreeNode> node, string className, string attributeName)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node
string	className
string	attributeName

Returns

Type	Description
ComWrapper<ICamApiCustomAttribute>

CreateUntypedFloatChild(ComWrapper<ICamApiCustomAttributesTreeNode>, string)

Creates child instance attribute with floating number value that does not have any corresponding type attribute in the libraries.

Declaration

public static ComWrapper<ICamApiFloatCustomAttribute> CreateUntypedFloatChild(this ComWrapper<ICamApiCustomAttributesTreeNode> node, string attributeName)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node
string	attributeName

Returns

Type	Description
ComWrapper<ICamApiFloatCustomAttribute>

CreateUntypedIntegerChild(ComWrapper<ICamApiCustomAttributesTreeNode>, string)

Creates child instance attribute with integer number value that does not have any corresponding type attribute in the libraries.

Declaration

public static ComWrapper<ICamApiIntegerCustomAttribute> CreateUntypedIntegerChild(this ComWrapper<ICamApiCustomAttributesTreeNode> node, string attributeName)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node
string	attributeName

Returns

Type	Description
ComWrapper<ICamApiIntegerCustomAttribute>

CreateUntypedStringChild(ComWrapper<ICamApiCustomAttributesTreeNode>, string)

Creates child instance attribute with string value that does not have any corresponding type attribute in the libraries.

Declaration

public static ComWrapper<ICamApiStringCustomAttribute> CreateUntypedStringChild(this ComWrapper<ICamApiCustomAttributesTreeNode> node, string attributeName)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node
string	attributeName

Returns

Type	Description
ComWrapper<ICamApiStringCustomAttribute>

FindChild(ComWrapper<ICamApiCustomAttributesTreeNode>, string)

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

Declaration

public static ComWrapper<ICamApiCustomAttributesTreeNode> FindChild(this ComWrapper<ICamApiCustomAttributesTreeNode> node, string fullName)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node
string	fullName

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesTreeNode>

FindChildByInstanceID(ComWrapper<ICamApiCustomAttributesTreeNode>, Guid, bool)

Find child 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> FindChildByInstanceID(this ComWrapper<ICamApiCustomAttributesTreeNode> node, Guid instanceID, bool deep)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node
Guid	instanceID
bool	deep

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesTreeNode>

FindChildByTypeID(ComWrapper<ICamApiCustomAttributesTreeNode>, Guid, bool)

Find child 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> FindChildByTypeID(this ComWrapper<ICamApiCustomAttributesTreeNode> node, Guid typeID, bool deep)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node
Guid	typeID
bool	deep

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesTreeNode>

Flt(ComWrapper<ICamApiCustomAttributesTreeNode>)

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<ICamApiCustomAttributesTreeNode> node)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesFloatValueIndexer>

FullName(ComWrapper<ICamApiCustomAttributesTreeNode>)

Full name of the node inside tree divided by dots.

Declaration

public static string FullName(this ComWrapper<ICamApiCustomAttributesTreeNode> node)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node

Returns

Type	Description
string

HasChild(ComWrapper<ICamApiCustomAttributesTreeNode>, string)

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

Declaration

public static bool HasChild(this ComWrapper<ICamApiCustomAttributesTreeNode> node, string fullName)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node
string	fullName

Returns

Type	Description
bool

InstanceID(ComWrapper<ICamApiCustomAttributesTreeNode>)

Unique identifier of the attribute in the object's attributes collection.

Declaration

public static Guid InstanceID(this ComWrapper<ICamApiCustomAttributesTreeNode> node)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node

Returns

Type	Description
Guid

Int(ComWrapper<ICamApiCustomAttributesTreeNode>)

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

Declaration

public static ComWrapper<ICamApiCustomAttributesIntegerValueIndexer> Int(this ComWrapper<ICamApiCustomAttributesTreeNode> node)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesIntegerValueIndexer>

IsUndefined(ComWrapper<ICamApiCustomAttributesTreeNode>)

The value is True only if the attribute is not defined in any of the libraries connected to the application, but it was not explicitly created as untyped.

Declaration

public static bool IsUndefined(this ComWrapper<ICamApiCustomAttributesTreeNode> node)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node

Returns

Type	Description
bool

IsUntyped(ComWrapper<ICamApiCustomAttributesTreeNode>)

The value is True only if the attribute is explicitly created as untyped (without declaration in any library).

Declaration

public static bool IsUntyped(this ComWrapper<ICamApiCustomAttributesTreeNode> node)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node

Returns

Type	Description
bool

Name(ComWrapper<ICamApiCustomAttributesTreeNode>)

Name of attribute inside the node.

Declaration

public static string Name(this ComWrapper<ICamApiCustomAttributesTreeNode> node)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node

Returns

Type	Description
string

NodeID(ComWrapper<ICamApiCustomAttributesTreeNode>)

Unique ID of node.

Declaration

public static Guid NodeID(this ComWrapper<ICamApiCustomAttributesTreeNode> node)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node

Returns

Type	Description
Guid

Parent(ComWrapper<ICamApiCustomAttributesTreeNode>)

Parent node for this node.

Declaration

public static ComWrapper<ICamApiCustomAttributesTreeNode> Parent(this ComWrapper<ICamApiCustomAttributesTreeNode> node)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesTreeNode>

SetValueAsBoolean(ComWrapper<ICamApiCustomAttributesTreeNode>, bool)

Value of the attribute as boolean if it has value.

Declaration

public static void SetValueAsBoolean(this ComWrapper<ICamApiCustomAttributesTreeNode> node, bool value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node
bool	value

SetValueAsDouble(ComWrapper<ICamApiCustomAttributesTreeNode>, double)

Value of the attribute as floating point number if it has value.

Declaration

public static void SetValueAsDouble(this ComWrapper<ICamApiCustomAttributesTreeNode> node, double value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node
double	value

SetValueAsInteger(ComWrapper<ICamApiCustomAttributesTreeNode>, int)

Value of the attribute as integer number if it has value.

Declaration

public static void SetValueAsInteger(this ComWrapper<ICamApiCustomAttributesTreeNode> node, int value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node
int	value

SetValueAsString(ComWrapper<ICamApiCustomAttributesTreeNode>, string)

Value of the attribute as string if it has value.

Declaration

public static void SetValueAsString(this ComWrapper<ICamApiCustomAttributesTreeNode> node, string value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node
string	value

Sibling(ComWrapper<ICamApiCustomAttributesTreeNode>)

Next sibling node for this node.

Declaration

public static ComWrapper<ICamApiCustomAttributesTreeNode> Sibling(this ComWrapper<ICamApiCustomAttributesTreeNode> node)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesTreeNode>

Str(ComWrapper<ICamApiCustomAttributesTreeNode>)

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

Declaration

public static ComWrapper<ICamApiCustomAttributesStringValueIndexer> Str(this ComWrapper<ICamApiCustomAttributesTreeNode> node)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesStringValueIndexer>

Tree(ComWrapper<ICamApiCustomAttributesTreeNode>)

Owning tree of the node.

Declaration

public static ComWrapper<ICamApiCustomAttributesTree> Tree(this ComWrapper<ICamApiCustomAttributesTreeNode> node)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesTree>

TypeID(ComWrapper<ICamApiCustomAttributesTreeNode>)

Unique identifier of the attribute in a library of attributes.

Declaration

public static Guid TypeID(this ComWrapper<ICamApiCustomAttributesTreeNode> node)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node

Returns

Type	Description
Guid

ValueAsBoolean(ComWrapper<ICamApiCustomAttributesTreeNode>)

Value of the attribute as boolean if it has value.

Declaration

public static bool ValueAsBoolean(this ComWrapper<ICamApiCustomAttributesTreeNode> node)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node

Returns

Type	Description
bool

ValueAsDouble(ComWrapper<ICamApiCustomAttributesTreeNode>)

Value of the attribute as floating point number if it has value.

Declaration

public static double ValueAsDouble(this ComWrapper<ICamApiCustomAttributesTreeNode> node)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node

Returns

Type	Description
double

ValueAsInteger(ComWrapper<ICamApiCustomAttributesTreeNode>)

Value of the attribute as integer number if it has value.

Declaration

public static int ValueAsInteger(this ComWrapper<ICamApiCustomAttributesTreeNode> node)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node

Returns

Type	Description
int

ValueAsString(ComWrapper<ICamApiCustomAttributesTreeNode>)

Value of the attribute as string if it has value.

Declaration

public static string ValueAsString(this ComWrapper<ICamApiCustomAttributesTreeNode> node)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node

Returns

Type	Description
string

ValueType(ComWrapper<ICamApiCustomAttributesTreeNode>)

Type of value the attribute has.

Declaration

public static TCustomAttributeValueType ValueType(this ComWrapper<ICamApiCustomAttributesTreeNode> node)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNode>	node

Returns

Type	Description
TCustomAttributeValueType