Class FinDocketForm
Generic implementation of a Form that provides feedback about the progress of an online banking activity.
public class FinDocketForm : Form, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl, IFinDocket
- Inheritance
-
FinDocketForm
- Implements
- Inherited Members
Remarks
This Form implements the abstract IFinDocket interface.
Constructors
FinDocketForm()
public FinDocketForm()
FinDocketForm(string)
public FinDocketForm(string sCaption)
Parameters
sCaptionstringText for the Window caption.
Properties
State
Provides the current state of the Docket instance.
public FinDocketState State { get; }
Property Value
Remarks
This property may be checked from a background thread.
Methods
Append(string, int, string)
public void Append(string sSegmentType, int nStatusCode, string sMessageText)
Parameters
Finish(string)
Finishes up the Docket by waiting for the user to click on the FINISH button.
public void Finish(string sTrace = null)
Parameters
sTracestringOptionally 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
- ObjectDisposedException
The Docket is in the Closed state.
- InvalidOperationException
InitDocket(string)
Initialises the Docket with the given heading.
public void InitDocket(string sHeading)
Parameters
sHeadingstring
Remarks
This method may only be invoked in the Null state.
Exceptions
- ObjectDisposedException
The Docket is in the Closed state.
- InvalidOperationException
The Docket is not in the Null state.
OnClosed(EventArgs)
protected override void OnClosed(EventArgs e)
Parameters
ShowDocket(IWin32Window)
Makes the Docket visible.
public void ShowDocket(IWin32Window aParentWindow)
Parameters
aParentWindowIWin32WindowOptional 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
- ObjectDisposedException
The Docket is in the Closed state.
- InvalidOperationException
The Docket is not in the Ready state.