Class AttributeFloatEnumValuesHelper

Helper methods for ICamApiAttributeFloatEnumValues

Inheritance

object

AttributeFloatEnumValuesHelper

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 AttributeFloatEnumValuesHelper

Methods

AddValue(ComWrapper<ICamApiAttributeFloatEnumValues>, double, string)

Add possible value to the list. Returns resulting index of the value in this list.

Declaration

public static int AddValue(this ComWrapper<ICamApiAttributeFloatEnumValues> enumVals, double value, string caption)

Parameters

Type	Name	Description
ComWrapper<ICamApiAttributeFloatEnumValues>	enumVals
double	value
string	caption

Returns

Type	Description
int

Extendable(ComWrapper<ICamApiAttributeFloatEnumValues>)

Can user add its own values to the enum list or not.

Declaration

public static bool Extendable(this ComWrapper<ICamApiAttributeFloatEnumValues> enumVals)

Parameters

Type	Name	Description
ComWrapper<ICamApiAttributeFloatEnumValues>	enumVals

Returns

Type	Description
bool

RemoveValue(ComWrapper<ICamApiAttributeFloatEnumValues>, int)

Attempts to remove the ValueIndex item from the list. Returns True if success.

Declaration

public static bool RemoveValue(this ComWrapper<ICamApiAttributeFloatEnumValues> enumVals, int valueIndex)

Parameters

Type	Name	Description
ComWrapper<ICamApiAttributeFloatEnumValues>	enumVals
int	valueIndex

Returns

Type	Description
bool

SetExtendable(ComWrapper<ICamApiAttributeFloatEnumValues>, bool)

Can user add its own values to the enum list or not.

Declaration

public static void SetExtendable(this ComWrapper<ICamApiAttributeFloatEnumValues> enumVals, bool value)

Parameters

Type	Name	Description
ComWrapper<ICamApiAttributeFloatEnumValues>	enumVals
bool	value

SetValue(ComWrapper<ICamApiAttributeFloatEnumValues>, int, double)

Set the value by its index in the list.

Declaration

public static void SetValue(this ComWrapper<ICamApiAttributeFloatEnumValues> enumVals, int index, double value)

Parameters

Type	Name	Description
ComWrapper<ICamApiAttributeFloatEnumValues>	enumVals
int	index
double	value

SetValueCaption(ComWrapper<ICamApiAttributeFloatEnumValues>, int, string)

Returns the value caption visible to user by its index in the list.

Declaration

public static void SetValueCaption(this ComWrapper<ICamApiAttributeFloatEnumValues> enumVals, int index, string value)

Parameters

Type	Name	Description
ComWrapper<ICamApiAttributeFloatEnumValues>	enumVals
int	index
string	value

Value(ComWrapper<ICamApiAttributeFloatEnumValues>, int)

Returns the value by its index in the list.

Declaration

public static double Value(this ComWrapper<ICamApiAttributeFloatEnumValues> enumVals, int index)

Parameters

Type	Name	Description
ComWrapper<ICamApiAttributeFloatEnumValues>	enumVals
int	index

Returns

Type	Description
double

ValueCaption(ComWrapper<ICamApiAttributeFloatEnumValues>, int)

Returns the value caption visible to user by its index in the list.

Declaration

public static string ValueCaption(this ComWrapper<ICamApiAttributeFloatEnumValues> enumVals, int index)

Parameters

Type	Name	Description
ComWrapper<ICamApiAttributeFloatEnumValues>	enumVals
int	index

Returns

Type	Description
string

ValuesCount(ComWrapper<ICamApiAttributeFloatEnumValues>)

Count of enum values in the list.

Declaration

public static int ValuesCount(this ComWrapper<ICamApiAttributeFloatEnumValues> enumVals)

Parameters

Type	Name	Description
ComWrapper<ICamApiAttributeFloatEnumValues>	enumVals

Returns

Type	Description
int