Class OperationCatalogHelper

Helper methods for ICamIpcOperationCatalog

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: CAMIPC.DotnetHelper

Assembly: CAMIPC.DotnetHelper.dll

Syntax

public static class OperationCatalogHelper

Methods

Activate(ComWrapper<ICamIpcOperationCatalog>)

Make this catalog the active one

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcOperationCatalog>	catalogCom

AddGroup(ComWrapper<ICamIpcOperationCatalog>, ComWrapper<ICamIpcOperationCatalogItem>?, int, string)

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

Declaration

public static ComWrapper<ICamIpcOperationCatalogGroup> AddGroup(this ComWrapper<ICamIpcOperationCatalog> catalogCom, ComWrapper<ICamIpcOperationCatalogItem>? parent, int index, string caption)

Parameters

Type	Name	Description
ComWrapper<ICamIpcOperationCatalog>	catalogCom
ComWrapper<ICamIpcOperationCatalogItem>	parent
int	index
string	caption

Returns

Type	Description
ComWrapper<ICamIpcOperationCatalogGroup>

DeleteItem(ComWrapper<ICamIpcOperationCatalog>, ComWrapper<ICamIpcOperationCatalogItem>)

Delete item (a group or a user operation entry)

Declaration

public static void DeleteItem(this ComWrapper<ICamIpcOperationCatalog> catalogCom, ComWrapper<ICamIpcOperationCatalogItem> item)

Parameters

Type	Name	Description
ComWrapper<ICamIpcOperationCatalog>	catalogCom
ComWrapper<ICamIpcOperationCatalogItem>	item

EnumerateItems(ComWrapper<ICamIpcOperationCatalog>)

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

Declaration

public static IEnumerable<ComWrapper<ICamIpcOperationCatalogItem>> EnumerateItems(this ComWrapper<ICamIpcOperationCatalog> catalogCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcOperationCatalog>	catalogCom

Returns

Type	Description
IEnumerable<ComWrapper<ICamIpcOperationCatalogItem>>

FindOperation(ComWrapper<ICamIpcOperationCatalog>, string)

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

Declaration

public static ComWrapper<ICamIpcOperationCatalogOperation> FindOperation(this ComWrapper<ICamIpcOperationCatalog> catalogCom, string typeId)

Parameters

Type	Name	Description
ComWrapper<ICamIpcOperationCatalog>	catalogCom
string	typeId

Returns

Type	Description
ComWrapper<ICamIpcOperationCatalogOperation>

Id(ComWrapper<ICamIpcOperationCatalog>)

Unique identifier of the catalog

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcOperationCatalog>	catalogCom

Returns

Type	Description
string

IsActive(ComWrapper<ICamIpcOperationCatalog>)

Whether the catalog is the currently active one

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcOperationCatalog>	catalogCom

Returns

Type	Description
bool

MoveItem(ComWrapper<ICamIpcOperationCatalog>, ComWrapper<ICamIpcOperationCatalogItem>, ComWrapper<ICamIpcOperationCatalogItem>?, int)

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

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcOperationCatalog>	catalogCom
ComWrapper<ICamIpcOperationCatalogItem>	item
ComWrapper<ICamIpcOperationCatalogItem>	newParent
int	index

Name(ComWrapper<ICamIpcOperationCatalog>)

Catalog name shown in the configurations list

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcOperationCatalog>	catalogCom

Returns

Type	Description
string

SetName(ComWrapper<ICamIpcOperationCatalog>, string)

Rename the catalog

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcOperationCatalog>	catalogCom
string	value