Enum FinDocketState

Enumerates the states of the FinDocketForm.

Namespace: Subsembly.FinTS.Forms

Assembly: Subsembly.FinTS.Win32.dll

Syntax

[Flags]
public enum FinDocketState

Remarks

The states are defined as disjoint bit flags. Thus a set of states can be easily checked by a binary AND operation.

Fields

Name	Description
Cancelled	The user did click on the Cancel button while the Docket was Running. The Docket is now waiting for the Online Banking activity to be aborted and the Docket to be closed by the user.
Closed	The Docket was closed and is disposed and cannot be made visible again.
Finished	The Finish(String) method was called and the Docket now waits for the user to click the FINISH button. In this state the Docket will automatically close itself an switch to the Closed state as soon as the user clicks the FINISH button.
Null	The initial state of the Docket after it was created. In this state the Docket must be iniatialised by calling InitDocket(String) before any other method may be called. Successfully initialising the Docket switches it into the Ready state.
Ready	The Docket was initialised and is now ready to be shown. In this state it is still invisible. The method ShowDocket(IWin32Window) may now be called in order to show the Docket and switch it into the Running state.
Running	The Docket is visible and the Online Banking activity is running in the background appending to the Docket by calling Append(String, Int32, String). If the Online Banking activity completes, then the Finish(String) method must be called in order to switch to Finished. If the Online Banking activity is cancelled by the user, then the Docket switches into the Cancelled state.
Visible	Mask that includes the bits for all visible states, which are Running, Cancelled, and Finished.