Interface ICamApiProgressIndicator

Controls the native progress indicator in the status area of the main application window. Obtain an instance via ICamApiApplicationMainForm.CreateProcessIndicator, call Show to occupy the indicator, push progress with SetPercent/SetCaption, then Hide when done.

Namespace: CAMAPI.ApplicationMainForm

Assembly: CAMAPI.ApplicationMainForm.dll

Syntax

[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("B4F28D17-6C39-4E0A-8B52-1D9A7C4F3E08")]
public interface ICamApiProgressIndicator

Methods

GetCaption()

Current status caption

Declaration

string GetCaption()

Returns

Type	Description
string

GetPercent()

Current completion percent (0..100)

Declaration

int GetPercent()

Returns

Type	Description
int

Hide(out TResultStatus)

Declaration

void Hide(out TResultStatus ResultStatus)

Parameters

Type	Name	Description
TResultStatus	ResultStatus

RegisterHandler(string, ICamApiEventHandler, IListString, out TResultStatus)

Declaration

void RegisterHandler(string HandlerIdent, ICamApiEventHandler Handler, IListString Events, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
string	HandlerIdent
ICamApiEventHandler	Handler
IListString	Events
TResultStatus	ResultStatus

SetCaption(string, out TResultStatus)

Declaration

void SetCaption(string Value, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
string	Value
TResultStatus	ResultStatus

SetPercent(int, out TResultStatus)

Declaration

void SetPercent(int Value, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
int	Value
TResultStatus	ResultStatus

Show(out TResultStatus)

Declaration

void Show(out TResultStatus ResultStatus)

Parameters

Type	Name	Description
TResultStatus	ResultStatus

UnregisterHandler(string, out TResultStatus)

Declaration

void UnregisterHandler(string HandlerIdent, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
string	HandlerIdent
TResultStatus	ResultStatus