Class CustomAttributesTreeNodesArrayHelper

Helper methods for ICamApiCustomAttributesTreeNodesArray

Inheritance

object

CustomAttributesTreeNodesArrayHelper

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 CustomAttributesTreeNodesArrayHelper

Methods

AddNewItemOfTypeID(ComWrapper<ICamApiCustomAttributesTreeNodesArray>, Guid, int)

Add new atribute of the given type ID to the array at specified index.

Declaration

public static int AddNewItemOfTypeID(this ComWrapper<ICamApiCustomAttributesTreeNodesArray> arr, Guid typeID, int insertAtIndex)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNodesArray>	arr	COM wrapper.
Guid	typeID	Type ID of the attribute to add.
int	insertAtIndex	Index of desired position, '-1' means the end.

Returns

Type	Description
int	Resulting item index. '-1' if no item added.

AddNewItemOfTypeName(ComWrapper<ICamApiCustomAttributesTreeNodesArray>, string, int)

Add new atribute of the given type name to the array at specified index.

Declaration

public static int AddNewItemOfTypeName(this ComWrapper<ICamApiCustomAttributesTreeNodesArray> arr, string typeName, int insertAtIndex)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNodesArray>	arr	COM wrapper.
string	typeName	Type name of the attribute to add.
int	insertAtIndex	Index of desired position, '-1' means the end.

Returns

Type	Description
int	Resulting item index. '-1' if no item added.

Count(ComWrapper<ICamApiCustomAttributesTreeNodesArray>)

Count of nodes inside the array.

Declaration

public static int Count(this ComWrapper<ICamApiCustomAttributesTreeNodesArray> arr)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNodesArray>	arr

Returns

Type	Description
int

DefaultTypeID(ComWrapper<ICamApiCustomAttributesTreeNodesArray>)

If defined non empty DefaultTypeID then the user can change count of items inside array in window, otherwise not.

Declaration

public static Guid DefaultTypeID(this ComWrapper<ICamApiCustomAttributesTreeNodesArray> arr)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNodesArray>	arr

Returns

Type	Description
Guid

IndexOfInstanceID(ComWrapper<ICamApiCustomAttributesTreeNodesArray>, Guid)

Returns an index of the item inside this array by its InstanceID. Result is -1 if no such item inside.

Declaration

public static int IndexOfInstanceID(this ComWrapper<ICamApiCustomAttributesTreeNodesArray> arr, Guid instanceID)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNodesArray>	arr
Guid	instanceID

Returns

Type	Description
int

IndexOfTypeID(ComWrapper<ICamApiCustomAttributesTreeNodesArray>, Guid)

Returns an index of the item inside this array by its TypeID. Result is -1 if no such item inside.

Declaration

public static int IndexOfTypeID(this ComWrapper<ICamApiCustomAttributesTreeNodesArray> arr, Guid typeID)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNodesArray>	arr
Guid	typeID

Returns

Type	Description
int

Item(ComWrapper<ICamApiCustomAttributesTreeNodesArray>, int)

Get item of the array by index (0..Count-1).

Declaration

public static ComWrapper<ICamApiCustomAttributesTreeNode> Item(this ComWrapper<ICamApiCustomAttributesTreeNodesArray> arr, int index)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNodesArray>	arr
int	index

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesTreeNode>

MoveItem(ComWrapper<ICamApiCustomAttributesTreeNodesArray>, int, int)

Move atribute from one position to another inside the array.

Declaration

public static bool MoveItem(this ComWrapper<ICamApiCustomAttributesTreeNodesArray> arr, int fromIndex, int toIndex)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNodesArray>	arr
int	fromIndex
int	toIndex

Returns

Type	Description
bool

RemoveItem(ComWrapper<ICamApiCustomAttributesTreeNodesArray>, int)

Remove atribute at index from the array.

Declaration

public static bool RemoveItem(this ComWrapper<ICamApiCustomAttributesTreeNodesArray> arr, int index)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNodesArray>	arr
int	index

Returns

Type	Description
bool

SetCount(ComWrapper<ICamApiCustomAttributesTreeNodesArray>, int)

Count of nodes inside the array.

Declaration

public static void SetCount(this ComWrapper<ICamApiCustomAttributesTreeNodesArray> arr, int value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesTreeNodesArray>	arr
int	value