Interface ICamIpcProgressIndicator

Controls the native progress indicator in the status area of the main application window over IPC. Obtain an instance via ICamIpcApplicationMainForm.CreateProcessIndicator, call Show to occupy the indicator, push progress with SetPercent/SetCaption, then Hide when done. Subscribe to Show/Hide/Break/Progress events via RegisterHandler with an ICamIpcHandlerProgressIndicator handler.

Namespace: CAMIPC.ApplicationMainForm

Assembly: CAMIPC.ApplicationMainForm.dll

Syntax

[Guid("C5F39E28-7D4A-4F1B-9C63-2E8B1D5A3F79")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface ICamIpcProgressIndicator

Methods

GetCaption(ref TExecuteContext)

Declaration

string GetCaption(ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
TExecuteContext	ExecuteContext

Returns

Type	Description
string

GetPercent(ref TExecuteContext)

Declaration

int GetPercent(ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
TExecuteContext	ExecuteContext

Returns

Type	Description
int

Hide(ref TExecuteContext)

Declaration

void Hide(ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
TExecuteContext	ExecuteContext

RegisterHandler(string, ICamIpcEventHandler, ICamIpcEventListener, ref TExecuteContext)

Declaration

void RegisterHandler(string HandlerIdent, ICamIpcEventHandler Handler, ICamIpcEventListener Listener, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
string	HandlerIdent
ICamIpcEventHandler	Handler
ICamIpcEventListener	Listener
TExecuteContext	ExecuteContext

SetCaption(string, ref TExecuteContext)

Declaration

void SetCaption(string Value, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
string	Value
TExecuteContext	ExecuteContext

SetPercent(int, ref TExecuteContext)

Declaration

void SetPercent(int Value, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
int	Value
TExecuteContext	ExecuteContext

Show(ref TExecuteContext)

Declaration

void Show(ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
TExecuteContext	ExecuteContext

UnregisterHandler(string, ref TExecuteContext)

Declaration

void UnregisterHandler(string HandlerIdent, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
string	HandlerIdent
TExecuteContext	ExecuteContext