Class StringCustomAttributeHelper

Helper methods for ICamApiStringCustomAttribute

Inheritance

object

StringCustomAttributeHelper

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 StringCustomAttributeHelper

Methods

Description(ComWrapper<ICamApiStringCustomAttribute>)

Detailed description of attribute visible for user.

Declaration

public static string Description(this ComWrapper<ICamApiStringCustomAttribute> attr)

Parameters

Type	Name	Description
ComWrapper<ICamApiStringCustomAttribute>	attr

Returns

Type	Description
string

EnumValues(ComWrapper<ICamApiStringCustomAttribute>)

The list of available values if the attribute has Enum restriction.

Declaration

public static ComWrapper<ICamApiAttributeStringEnumValues> EnumValues(this ComWrapper<ICamApiStringCustomAttribute> attr)

Parameters

Type	Name	Description
ComWrapper<ICamApiStringCustomAttribute>	attr

Returns

Type	Description
ComWrapper<ICamApiAttributeStringEnumValues>

InstanceID(ComWrapper<ICamApiStringCustomAttribute>)

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

Declaration

public static Guid InstanceID(this ComWrapper<ICamApiStringCustomAttribute> attr)

Parameters

Type	Name	Description
ComWrapper<ICamApiStringCustomAttribute>	attr

Returns

Type	Description
Guid

IsUntyped(ComWrapper<ICamApiStringCustomAttribute>)

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<ICamApiStringCustomAttribute> attr)

Parameters

Type	Name	Description
ComWrapper<ICamApiStringCustomAttribute>	attr

Returns

Type	Description
bool

Name(ComWrapper<ICamApiStringCustomAttribute>)

Name of attribute visible for user.

Declaration

public static string Name(this ComWrapper<ICamApiStringCustomAttribute> attr)

Parameters

Type	Name	Description
ComWrapper<ICamApiStringCustomAttribute>	attr

Returns

Type	Description
string

ParentInstanceID(ComWrapper<ICamApiStringCustomAttribute>)

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

Declaration

public static Guid ParentInstanceID(this ComWrapper<ICamApiStringCustomAttribute> attr)

Parameters

Type	Name	Description
ComWrapper<ICamApiStringCustomAttribute>	attr

Returns

Type	Description
Guid

ReadOnly(ComWrapper<ICamApiStringCustomAttribute>)

Define the possibility to change value of the attribute by user.

Declaration

public static bool ReadOnly(this ComWrapper<ICamApiStringCustomAttribute> attr)

Parameters

Type	Name	Description
ComWrapper<ICamApiStringCustomAttribute>	attr

Returns

Type	Description
bool

Restrictions(ComWrapper<ICamApiStringCustomAttribute>)

Restrictions for value of the attribute.

Declaration

public static TAttributeValueRestriction Restrictions(this ComWrapper<ICamApiStringCustomAttribute> attr)

Parameters

Type	Name	Description
ComWrapper<ICamApiStringCustomAttribute>	attr

Returns

Type	Description
TAttributeValueRestriction

SetDescription(ComWrapper<ICamApiStringCustomAttribute>, string)

Detailed description of attribute visible for user.

Declaration

public static void SetDescription(this ComWrapper<ICamApiStringCustomAttribute> attr, string value)

Parameters

Type	Name	Description
ComWrapper<ICamApiStringCustomAttribute>	attr
string	value

SetName(ComWrapper<ICamApiStringCustomAttribute>, string)

Name of attribute visible for user.

Declaration

public static void SetName(this ComWrapper<ICamApiStringCustomAttribute> attr, string value)

Parameters

Type	Name	Description
ComWrapper<ICamApiStringCustomAttribute>	attr
string	value

SetReadOnly(ComWrapper<ICamApiStringCustomAttribute>, bool)

Define the possibility to change value of the attribute by user.

Declaration

public static void SetReadOnly(this ComWrapper<ICamApiStringCustomAttribute> attr, bool value)

Parameters

Type	Name	Description
ComWrapper<ICamApiStringCustomAttribute>	attr
bool	value

SetRestrictions(ComWrapper<ICamApiStringCustomAttribute>, TAttributeValueRestriction)

Restrictions for value of the attribute.

Declaration

public static void SetRestrictions(this ComWrapper<ICamApiStringCustomAttribute> attr, TAttributeValueRestriction value)

Parameters

Type	Name	Description
ComWrapper<ICamApiStringCustomAttribute>	attr
TAttributeValueRestriction	value

SetTypeCategoryID(ComWrapper<ICamApiStringCustomAttribute>, Guid)

TypeID of parent category inside which the attribute should appear.

Declaration

public static void SetTypeCategoryID(this ComWrapper<ICamApiStringCustomAttribute> attr, Guid value)

Parameters

Type	Name	Description
ComWrapper<ICamApiStringCustomAttribute>	attr
Guid	value

SetUnits(ComWrapper<ICamApiStringCustomAttribute>, string)

Measurement units of the attribute.

Declaration

public static void SetUnits(this ComWrapper<ICamApiStringCustomAttribute> attr, string value)

Parameters

Type	Name	Description
ComWrapper<ICamApiStringCustomAttribute>	attr
string	value

SetValue(ComWrapper<ICamApiStringCustomAttribute>, string)

Value of the attribute.

Declaration

public static void SetValue(this ComWrapper<ICamApiStringCustomAttribute> attr, string value)

Parameters

Type	Name	Description
ComWrapper<ICamApiStringCustomAttribute>	attr
string	value

SetVisible(ComWrapper<ICamApiStringCustomAttribute>, bool)

Visibility of the attribute for user.

Declaration

public static void SetVisible(this ComWrapper<ICamApiStringCustomAttribute> attr, bool value)

Parameters

Type	Name	Description
ComWrapper<ICamApiStringCustomAttribute>	attr
bool	value

TypeCategoryID(ComWrapper<ICamApiStringCustomAttribute>)

TypeID of parent category inside which the attribute should appear.

Declaration

public static Guid TypeCategoryID(this ComWrapper<ICamApiStringCustomAttribute> attr)

Parameters

Type	Name	Description
ComWrapper<ICamApiStringCustomAttribute>	attr

Returns

Type	Description
Guid

TypeID(ComWrapper<ICamApiStringCustomAttribute>)

Unique identifier of the attribute in a library of attributes.

Declaration

public static Guid TypeID(this ComWrapper<ICamApiStringCustomAttribute> attr)

Parameters

Type	Name	Description
ComWrapper<ICamApiStringCustomAttribute>	attr

Returns

Type	Description
Guid

Units(ComWrapper<ICamApiStringCustomAttribute>)

Measurement units of the attribute.

Declaration

public static string Units(this ComWrapper<ICamApiStringCustomAttribute> attr)

Parameters

Type	Name	Description
ComWrapper<ICamApiStringCustomAttribute>	attr

Returns

Type	Description
string

Value(ComWrapper<ICamApiStringCustomAttribute>)

Value of the attribute.

Declaration

public static string Value(this ComWrapper<ICamApiStringCustomAttribute> attr)

Parameters

Type	Name	Description
ComWrapper<ICamApiStringCustomAttribute>	attr

Returns

Type	Description
string

ValueType(ComWrapper<ICamApiStringCustomAttribute>)

Type of value the attribute has.

Declaration

public static TCustomAttributeValueType ValueType(this ComWrapper<ICamApiStringCustomAttribute> attr)

Parameters

Type	Name	Description
ComWrapper<ICamApiStringCustomAttribute>	attr

Returns

Type	Description
TCustomAttributeValueType

Visible(ComWrapper<ICamApiStringCustomAttribute>)

Visibility of the attribute for user.

Declaration

public static bool Visible(this ComWrapper<ICamApiStringCustomAttribute> attr)

Parameters

Type	Name	Description
ComWrapper<ICamApiStringCustomAttribute>	attr

Returns

Type	Description
bool