Class ProgressIndicatorHelper

Helper functions for ICamIpcProgressIndicator — drives the native status-bar progress indicator of a running ENCY instance over IPC.

Inheritance
object
ProgressIndicatorHelper
Inherited Members
Namespace: CAMIPC.DotnetHelper
Assembly: CAMIPC.DotnetHelper.dll
Syntax
public static class ProgressIndicatorHelper

Methods

CreateProcessIndicator(ComWrapper<ICamIpcApplicationMainForm>, string)

Create a controller for the native progress indicator. Call Show(ComWrapper<ICamIpcProgressIndicator>) on the result to occupy the status bar, then push progress via SetPercent/SetCaption.

Declaration
public static ComWrapper<ICamIpcProgressIndicator> CreateProcessIndicator(this ComWrapper<ICamIpcApplicationMainForm> mainFormCom, string caption)
Parameters
Type Name Description
ComWrapper<ICamIpcApplicationMainForm> mainFormCom
string caption
Returns
Type Description
ComWrapper<ICamIpcProgressIndicator>

GetCaption(ComWrapper<ICamIpcProgressIndicator>)

Current status caption.

Declaration
public static string GetCaption(this ComWrapper<ICamIpcProgressIndicator> indicatorCom)
Parameters
Type Name Description
ComWrapper<ICamIpcProgressIndicator> indicatorCom
Returns
Type Description
string

GetPercent(ComWrapper<ICamIpcProgressIndicator>)

Current completion percent (0..100).

Declaration
public static int GetPercent(this ComWrapper<ICamIpcProgressIndicator> indicatorCom)
Parameters
Type Name Description
ComWrapper<ICamIpcProgressIndicator> indicatorCom
Returns
Type Description
int

Hide(ComWrapper<ICamIpcProgressIndicator>)

Hide the indicator and release the status bar. Throws if the indicator is not currently occupying the status bar.

Declaration
public static void Hide(this ComWrapper<ICamIpcProgressIndicator> indicatorCom)
Parameters
Type Name Description
ComWrapper<ICamIpcProgressIndicator> indicatorCom

RegisterHandler(ComWrapper<ICamIpcProgressIndicator>, string, ICamIpcEventHandler, ICamIpcEventListener)

Register a handler for progress indicator events (Show/Hide/Break/Progress).

Declaration
public static void RegisterHandler(this ComWrapper<ICamIpcProgressIndicator> indicatorCom, string handlerIdent, ICamIpcEventHandler handler, ICamIpcEventListener listener)
Parameters
Type Name Description
ComWrapper<ICamIpcProgressIndicator> indicatorCom
string handlerIdent
ICamIpcEventHandler handler
ICamIpcEventListener listener

SetCaption(ComWrapper<ICamIpcProgressIndicator>, string)

Set the status caption shown next to the indicator. Throws if the indicator is not currently occupying the status bar.

Declaration
public static void SetCaption(this ComWrapper<ICamIpcProgressIndicator> indicatorCom, string caption)
Parameters
Type Name Description
ComWrapper<ICamIpcProgressIndicator> indicatorCom
string caption

SetPercent(ComWrapper<ICamIpcProgressIndicator>, int)

Set completion percent (0..100). Throws if the indicator is not currently occupying the status bar.

Declaration
public static void SetPercent(this ComWrapper<ICamIpcProgressIndicator> indicatorCom, int percent)
Parameters
Type Name Description
ComWrapper<ICamIpcProgressIndicator> indicatorCom
int percent

Show(ComWrapper<ICamIpcProgressIndicator>)

Show the indicator and occupy the status bar. Throws if the status bar is already used by another running process.

Declaration
public static void Show(this ComWrapper<ICamIpcProgressIndicator> indicatorCom)
Parameters
Type Name Description
ComWrapper<ICamIpcProgressIndicator> indicatorCom

UnregisterHandler(ComWrapper<ICamIpcProgressIndicator>, string)

Unregister a previously registered progress indicator event handler.

Declaration
public static void UnregisterHandler(this ComWrapper<ICamIpcProgressIndicator> indicatorCom, string handlerIdent)
Parameters
Type Name Description
ComWrapper<ICamIpcProgressIndicator> indicatorCom
string handlerIdent