Class OperationCatalogHelper

Helper methods for ICamApiOperationCatalog

Inheritance

object

OperationCatalogHelper

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 OperationCatalogHelper

Methods

Activate(ComWrapper<ICamApiOperationCatalog>)

Make this catalog the active one

Declaration

public static void Activate(this ComWrapper<ICamApiOperationCatalog> catalogCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalog>	catalogCom

AddGroup(ComWrapper<ICamApiOperationCatalog>, ComWrapper<ICamApiOperationCatalogItem>?, int, string)

Add a group under parent (null = top level) at the given index (out of range = append)

Declaration

public static ComWrapper<ICamApiOperationCatalogGroup> AddGroup(this ComWrapper<ICamApiOperationCatalog> catalogCom, ComWrapper<ICamApiOperationCatalogItem>? parent, int index, string caption)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalog>	catalogCom
ComWrapper<ICamApiOperationCatalogItem>	parent
int	index
string	caption

Returns

Type	Description
ComWrapper<ICamApiOperationCatalogGroup>

DeleteItem(ComWrapper<ICamApiOperationCatalog>, ComWrapper<ICamApiOperationCatalogItem>)

Delete item (a group or a user operation entry; standard operation entries cannot be deleted)

Declaration

public static void DeleteItem(this ComWrapper<ICamApiOperationCatalog> catalogCom, ComWrapper<ICamApiOperationCatalogItem> item)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalog>	catalogCom
ComWrapper<ICamApiOperationCatalogItem>	item

EnumerateItems(ComWrapper<ICamApiOperationCatalog>)

Enumerate all items of the catalog (groups and operations, depth-first)

Declaration

public static IEnumerable<ComWrapper<ICamApiOperationCatalogItem>> EnumerateItems(this ComWrapper<ICamApiOperationCatalog> catalogCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalog>	catalogCom

Returns

Type	Description
IEnumerable<ComWrapper<ICamApiOperationCatalogItem>>

FindOperation(ComWrapper<ICamApiOperationCatalog>, string)

Find the operation entry for the given type id anywhere in the catalog; a null wrapper if not found

Declaration

public static ComWrapper<ICamApiOperationCatalogOperation> FindOperation(this ComWrapper<ICamApiOperationCatalog> catalogCom, string typeId)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalog>	catalogCom
string	typeId

Returns

Type	Description
ComWrapper<ICamApiOperationCatalogOperation>

GetItems(ComWrapper<ICamApiOperationCatalog>)

Get iterator over all items of the catalog

Declaration

public static ComWrapper<ICamApiOperationCatalogItemIterator> GetItems(this ComWrapper<ICamApiOperationCatalog> catalogCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalog>	catalogCom

Returns

Type	Description
ComWrapper<ICamApiOperationCatalogItemIterator>

Id(ComWrapper<ICamApiOperationCatalog>)

Unique identifier of the catalog

Declaration

public static string Id(this ComWrapper<ICamApiOperationCatalog> catalogCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalog>	catalogCom

Returns

Type	Description
string

IsActive(ComWrapper<ICamApiOperationCatalog>)

Whether the catalog is the currently active one

Declaration

public static bool IsActive(this ComWrapper<ICamApiOperationCatalog> catalogCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalog>	catalogCom

Returns

Type	Description
bool

MoveItem(ComWrapper<ICamApiOperationCatalog>, ComWrapper<ICamApiOperationCatalogItem>, ComWrapper<ICamApiOperationCatalogItem>?, int)

Move item under newParent (null = top level) to the given index

Declaration

public static void MoveItem(this ComWrapper<ICamApiOperationCatalog> catalogCom, ComWrapper<ICamApiOperationCatalogItem> item, ComWrapper<ICamApiOperationCatalogItem>? newParent, int index)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalog>	catalogCom
ComWrapper<ICamApiOperationCatalogItem>	item
ComWrapper<ICamApiOperationCatalogItem>	newParent
int	index

Name(ComWrapper<ICamApiOperationCatalog>)

Catalog name shown in the configurations list

Declaration

public static string Name(this ComWrapper<ICamApiOperationCatalog> catalogCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalog>	catalogCom

Returns

Type	Description
string

SetName(ComWrapper<ICamApiOperationCatalog>, string)

Rename the catalog

Declaration

public static void SetName(this ComWrapper<ICamApiOperationCatalog> catalogCom, string value)

Parameters

Type	Name	Description
ComWrapper<ICamApiOperationCatalog>	catalogCom
string	value