Class OperationCatalogItemHelper

Helper methods for ICamApiOperationCatalogItem and its facets (ICamApiOperationCatalogGroup, ICamApiOperationCatalogOperation)

Inheritance

object

OperationCatalogItemHelper

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 OperationCatalogItemHelper

Methods

AsGroup(ComWrapper<ICamApiOperationCatalogItem>)

Cast to the group facet; a null wrapper if the item is an operation

Declaration

public static ComWrapper<ICamApiOperationCatalogGroup> AsGroup(this ComWrapper<ICamApiOperationCatalogItem> itemCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalogItem>	itemCom

Returns

Type	Description
ComWrapper<ICamApiOperationCatalogGroup>

AsOperation(ComWrapper<ICamApiOperationCatalogItem>)

Cast to the operation facet; a null wrapper if the item is a group

Declaration

public static ComWrapper<ICamApiOperationCatalogOperation> AsOperation(this ComWrapper<ICamApiOperationCatalogItem> itemCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalogItem>	itemCom

Returns

Type	Description
ComWrapper<ICamApiOperationCatalogOperation>

Caption(ComWrapper<ICamApiOperationCatalogItem>)

Localized caption

Declaration

public static string Caption(this ComWrapper<ICamApiOperationCatalogItem> itemCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalogItem>	itemCom

Returns

Type	Description
string

IconFile(ComWrapper<ICamApiOperationCatalogGroup>)

Aliased path to the group icon file

Declaration

public static string IconFile(this ComWrapper<ICamApiOperationCatalogGroup> groupCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalogGroup>	groupCom

Returns

Type	Description
string

Id(ComWrapper<ICamApiOperationCatalogItem>)

Unique identifier of the item inside the catalog

Declaration

public static string Id(this ComWrapper<ICamApiOperationCatalogItem> itemCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalogItem>	itemCom

Returns

Type	Description
string

IsUserOperation(ComWrapper<ICamApiOperationCatalogOperation>)

Whether the entry references a user operation rather than a plain operation type

Declaration

public static bool IsUserOperation(this ComWrapper<ICamApiOperationCatalogOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalogOperation>	operationCom

Returns

Type	Description
bool

Kind(ComWrapper<ICamApiOperationCatalogItem>)

Whether the item is a group or an operation

Declaration

public static TCamApiOperationCatalogItemKind Kind(this ComWrapper<ICamApiOperationCatalogItem> itemCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalogItem>	itemCom

Returns

Type	Description
TCamApiOperationCatalogItemKind

Order(ComWrapper<ICamApiOperationCatalogItem>)

Sort key within the parent

Declaration

public static double Order(this ComWrapper<ICamApiOperationCatalogItem> itemCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalogItem>	itemCom

Returns

Type	Description
double

Parent(ComWrapper<ICamApiOperationCatalogItem>)

Parent item, or a null wrapper for a top-level item

Declaration

public static ComWrapper<ICamApiOperationCatalogItem> Parent(this ComWrapper<ICamApiOperationCatalogItem> itemCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalogItem>	itemCom

Returns

Type	Description
ComWrapper<ICamApiOperationCatalogItem>

SetCaption(ComWrapper<ICamApiOperationCatalogItem>, string)

Set caption (meaningful for groups)

Declaration

public static void SetCaption(this ComWrapper<ICamApiOperationCatalogItem> itemCom, string value)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalogItem>	itemCom
string	value

SetIconFile(ComWrapper<ICamApiOperationCatalogGroup>, string)

Set the aliased path to the group icon file

Declaration

public static void SetIconFile(this ComWrapper<ICamApiOperationCatalogGroup> groupCom, string value)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalogGroup>	groupCom
string	value

SetVisible(ComWrapper<ICamApiOperationCatalogItem>, bool)

Set visibility in the "New operation" window

Declaration

public static void SetVisible(this ComWrapper<ICamApiOperationCatalogItem> itemCom, bool value)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalogItem>	itemCom
bool	value

TypeId(ComWrapper<ICamApiOperationCatalogOperation>)

Id of the referenced operation type, or of the user operation when IsUserOperation(ComWrapper<ICamApiOperationCatalogOperation>) is true

Declaration

public static string TypeId(this ComWrapper<ICamApiOperationCatalogOperation> operationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalogOperation>	operationCom

Returns

Type	Description
string

Visible(ComWrapper<ICamApiOperationCatalogItem>)

Visibility in the "New operation" window

Declaration

public static bool Visible(this ComWrapper<ICamApiOperationCatalogItem> itemCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalogItem>	itemCom

Returns

Type	Description
bool