Class CustomAttributesArrayHelper

Helper methods for ICamApiCustomAttributesArray

Inheritance

object

CustomAttributesArrayHelper

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 CustomAttributesArrayHelper

Methods

AddItemAt(ComWrapper<ICamApiCustomAttributesArray>, Guid, Guid, int)

Add atribute to the array at the end.

Declaration

public static int AddItemAt(this ComWrapper<ICamApiCustomAttributesArray> arr, Guid instanceID, Guid typeID, int atIndex)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesArray>	arr	COM wrapper.
Guid	instanceID	ID of item instance to add.
Guid	typeID	ID of item type.
int	atIndex	Desired index in array. '-1' means the end.

Returns

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

Count(ComWrapper<ICamApiCustomAttributesArray>)

Count of attributes in the array.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesArray>	arr

Returns

Type	Description
int

DefaultAttributeType(ComWrapper<ICamApiCustomAttributesArray>)

If defined non empty DefaultAttributeType then the user can change count of items inside array in window, otherwise not. An attribute of this type will be created.

Declaration

public static ComWrapper<ICamApiCustomAttribute> DefaultAttributeType(this ComWrapper<ICamApiCustomAttributesArray> arr)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesArray>	arr

Returns

Type	Description
ComWrapper<ICamApiCustomAttribute>

DefaultTypeID(ComWrapper<ICamApiCustomAttributesArray>)

If defined non empty DefaultTypeID (or DefaultAttributeType) then the user can change count of items inside array in window, otherwise not. An attribute of this type will be created.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesArray>	arr

Returns

Type	Description
Guid

Description(ComWrapper<ICamApiCustomAttributesArray>)

Detailed description of attribute visible for user.

Declaration

public static string Description(this ComWrapper<ICamApiCustomAttributesArray> arr)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesArray>	arr

Returns

Type	Description
string

IndexOfInstanceID(ComWrapper<ICamApiCustomAttributesArray>, 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<ICamApiCustomAttributesArray> arr, Guid instanceID)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesArray>	arr
Guid	instanceID

Returns

Type	Description
int

IndexOfTypeID(ComWrapper<ICamApiCustomAttributesArray>, 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<ICamApiCustomAttributesArray> arr, Guid typeID)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesArray>	arr
Guid	typeID

Returns

Type	Description
int

InstanceID(ComWrapper<ICamApiCustomAttributesArray>)

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

Declaration

public static Guid InstanceID(this ComWrapper<ICamApiCustomAttributesArray> arr)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesArray>	arr

Returns

Type	Description
Guid

IsUntyped(ComWrapper<ICamApiCustomAttributesArray>)

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<ICamApiCustomAttributesArray> arr)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesArray>	arr

Returns

Type	Description
bool

ItemInstanceID(ComWrapper<ICamApiCustomAttributesArray>, int)

Get or set child attribute by index in array (0..Count-1). For types it should be TypeID, for instances - InstanceID.

Declaration

public static Guid ItemInstanceID(this ComWrapper<ICamApiCustomAttributesArray> arr, int index)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesArray>	arr
int	index

Returns

Type	Description
Guid

ItemTypeID(ComWrapper<ICamApiCustomAttributesArray>, int)

Get or set child attribute by index in array (0..Count-1). For types it should be TypeID, for instances - InstanceID.

Declaration

public static Guid ItemTypeID(this ComWrapper<ICamApiCustomAttributesArray> arr, int index)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesArray>	arr
int	index

Returns

Type	Description
Guid

MoveItem(ComWrapper<ICamApiCustomAttributesArray>, int, int)

Move atribute from one position to another inside the array.

Declaration

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

Parameters

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

Returns

Type	Description
bool

Name(ComWrapper<ICamApiCustomAttributesArray>)

Name of attribute visible for user.

Declaration

public static string Name(this ComWrapper<ICamApiCustomAttributesArray> arr)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesArray>	arr

Returns

Type	Description
string

ParentInstanceID(ComWrapper<ICamApiCustomAttributesArray>)

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

Declaration

public static Guid ParentInstanceID(this ComWrapper<ICamApiCustomAttributesArray> arr)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesArray>	arr

Returns

Type	Description
Guid

RemoveItem(ComWrapper<ICamApiCustomAttributesArray>, int)

Remove atribute from the array.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesArray>	arr
int	index

Returns

Type	Description
bool

SetDefaultAttributeType(ComWrapper<ICamApiCustomAttributesArray>, ICamApiCustomAttribute)

If defined non empty DefaultAttributeType then the user can change count of items inside array in window, otherwise not. An attribute of this type will be created.

Declaration

public static void SetDefaultAttributeType(this ComWrapper<ICamApiCustomAttributesArray> arr, ICamApiCustomAttribute value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesArray>	arr
ICamApiCustomAttribute	value

SetDescription(ComWrapper<ICamApiCustomAttributesArray>, string)

Detailed description of attribute visible for user.

Declaration

public static void SetDescription(this ComWrapper<ICamApiCustomAttributesArray> arr, string value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesArray>	arr
string	value

SetName(ComWrapper<ICamApiCustomAttributesArray>, string)

Name of attribute visible for user.

Declaration

public static void SetName(this ComWrapper<ICamApiCustomAttributesArray> arr, string value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesArray>	arr
string	value

SetTransparent(ComWrapper<ICamApiCustomAttributesArray>, bool)

If transparent is False then the category itself will be invisible, but children attributes will be shown at parent level directly.

Declaration

public static void SetTransparent(this ComWrapper<ICamApiCustomAttributesArray> arr, bool value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesArray>	arr
bool	value

SetTypeCategoryID(ComWrapper<ICamApiCustomAttributesArray>, Guid)

TypeID of parent category inside which the attribute should appear.

Declaration

public static void SetTypeCategoryID(this ComWrapper<ICamApiCustomAttributesArray> arr, Guid value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesArray>	arr
Guid	value

Transparent(ComWrapper<ICamApiCustomAttributesArray>)

If transparent is False then the category itself will be invisible, but children attributes will be shown at parent level directly.

Declaration

public static bool Transparent(this ComWrapper<ICamApiCustomAttributesArray> arr)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesArray>	arr

Returns

Type	Description
bool

TypeCategoryID(ComWrapper<ICamApiCustomAttributesArray>)

TypeID of parent category inside which the attribute should appear.

Declaration

public static Guid TypeCategoryID(this ComWrapper<ICamApiCustomAttributesArray> arr)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesArray>	arr

Returns

Type	Description
Guid

TypeID(ComWrapper<ICamApiCustomAttributesArray>)

Unique identifier of the attribute in a library of attributes.

Declaration

public static Guid TypeID(this ComWrapper<ICamApiCustomAttributesArray> arr)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesArray>	arr

Returns

Type	Description
Guid

ValueType(ComWrapper<ICamApiCustomAttributesArray>)

Type of value the attribute has.

Declaration

public static TCustomAttributeValueType ValueType(this ComWrapper<ICamApiCustomAttributesArray> arr)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesArray>	arr

Returns

Type	Description
TCustomAttributeValueType