Class CustomAttributeCategoryHelper

Helper methods for ICamApiCustomAttributeCategory

Inheritance

object

CustomAttributeCategoryHelper

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 CustomAttributeCategoryHelper

Methods

Description(ComWrapper<ICamApiCustomAttributeCategory>)

Detailed description of attribute visible for user.

Declaration

public static string Description(this ComWrapper<ICamApiCustomAttributeCategory> category)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributeCategory>	category

Returns

Type	Description
string

InstanceID(ComWrapper<ICamApiCustomAttributeCategory>)

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

Declaration

public static Guid InstanceID(this ComWrapper<ICamApiCustomAttributeCategory> category)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributeCategory>	category

Returns

Type	Description
Guid

IsUntyped(ComWrapper<ICamApiCustomAttributeCategory>)

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<ICamApiCustomAttributeCategory> category)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributeCategory>	category

Returns

Type	Description
bool

Name(ComWrapper<ICamApiCustomAttributeCategory>)

Name of attribute visible for user.

Declaration

public static string Name(this ComWrapper<ICamApiCustomAttributeCategory> category)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributeCategory>	category

Returns

Type	Description
string

ParentInstanceID(ComWrapper<ICamApiCustomAttributeCategory>)

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

Declaration

public static Guid ParentInstanceID(this ComWrapper<ICamApiCustomAttributeCategory> category)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributeCategory>	category

Returns

Type	Description
Guid

SetDescription(ComWrapper<ICamApiCustomAttributeCategory>, string)

Detailed description of attribute visible for user.

Declaration

public static void SetDescription(this ComWrapper<ICamApiCustomAttributeCategory> category, string value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributeCategory>	category
string	value

SetName(ComWrapper<ICamApiCustomAttributeCategory>, string)

Name of attribute visible for user.

Declaration

public static void SetName(this ComWrapper<ICamApiCustomAttributeCategory> category, string value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributeCategory>	category
string	value

SetTransparent(ComWrapper<ICamApiCustomAttributeCategory>, 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<ICamApiCustomAttributeCategory> category, bool value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributeCategory>	category
bool	value

SetTypeCategoryID(ComWrapper<ICamApiCustomAttributeCategory>, Guid)

TypeID of parent category inside which the attribute should appear.

Declaration

public static void SetTypeCategoryID(this ComWrapper<ICamApiCustomAttributeCategory> category, Guid value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributeCategory>	category
Guid	value

Transparent(ComWrapper<ICamApiCustomAttributeCategory>)

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<ICamApiCustomAttributeCategory> category)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributeCategory>	category

Returns

Type	Description
bool

TypeCategoryID(ComWrapper<ICamApiCustomAttributeCategory>)

TypeID of parent category inside which the attribute should appear.

Declaration

public static Guid TypeCategoryID(this ComWrapper<ICamApiCustomAttributeCategory> category)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributeCategory>	category

Returns

Type	Description
Guid

TypeID(ComWrapper<ICamApiCustomAttributeCategory>)

Unique identifier of the attribute in a library of attributes.

Declaration

public static Guid TypeID(this ComWrapper<ICamApiCustomAttributeCategory> category)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributeCategory>	category

Returns

Type	Description
Guid

ValueType(ComWrapper<ICamApiCustomAttributeCategory>)

Type of value the attribute has.

Declaration

public static TCustomAttributeValueType ValueType(this ComWrapper<ICamApiCustomAttributeCategory> category)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributeCategory>	category

Returns

Type	Description
TCustomAttributeValueType