Class FinDocketForm

Generic implementation of a Form that provides feedback about the progress of an online banking activity.

Inheritance
object
MarshalByRefObject
Component
Control
ScrollableControl
ContainerControl
Form
FinDocketForm
Implements
Inherited Members
Namespace: Subsembly.FinTS.Forms
Assembly: Subsembly.FinTS.Win32.dll
Syntax
public class FinDocketForm : Form, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl, IFinDocket
Remarks

This Form implements the abstract IFinDocket interface.

Constructors

FinDocketForm()

Declaration
public FinDocketForm()

FinDocketForm(string)

Declaration
public FinDocketForm(string sCaption)
Parameters
Type Name Description
string sCaption

Text for the Window caption.

Properties

State

Provides the current state of the Docket instance.

Declaration
public FinDocketState State { get; }
Property Value
Type Description
FinDocketState
Remarks

This property may be checked from a background thread.

Methods

Append(string, int, string)

Declaration
public void Append(string sSegmentType, int nStatusCode, string sMessageText)
Parameters
Type Name Description
string sSegmentType
int nStatusCode
string sMessageText

Finish(string)

Finishes up the Docket by waiting for the user to click on the FINISH button.

Declaration
public void Finish(string sTrace = null)
Parameters
Type Name Description
string sTrace

Optionally a detailed trace may be provided. If so, then the docket will show a button which can be clicked in order to display the trace details.
Remarks

This method may only be invoked in the Running, or the Cancelled state. It switches into the Finished state. It does not wait for the user to click the FINISH button, but returns immediately.

Exceptions
Type Condition
ObjectDisposedException

The Docket is in the Closed state.
InvalidOperationException

The Docket is not in the Running or the Cancelled state.

InitDocket(string)

Initialises the Docket with the given heading.

Declaration
public void InitDocket(string sHeading)
Parameters
Type Name Description
string sHeading
Remarks

This method may only be invoked in the Null state.

Exceptions
Type Condition
ObjectDisposedException

The Docket is in the Closed state.
InvalidOperationException

The Docket is not in the Null state.

OnClosed(EventArgs)

Declaration
protected override void OnClosed(EventArgs e)
Parameters
Type Name Description
EventArgs e
Overrides

ShowDocket(IWin32Window)

Makes the Docket visible.

Declaration
public void ShowDocket(IWin32Window aParentWindow)
Parameters
Type Name Description
IWin32Window aParentWindow

Optional parent window that will be the owner of this docket while it is shown. If null, then the docket will not have an owner.
Remarks

This method may only be invoked in the Ready state. It makes the Docket visible and switches it into the Running state.

Exceptions
Type Condition
ObjectDisposedException

The Docket is in the Closed state.
InvalidOperationException

The Docket is not in the Ready state.

Implements