FreeFlow class library

FreeFlow.Client Namespace

Class library exposing workflow functionality. The Connection class provides the base functionality for connecting to the engine and sending and receiving XML messages. It supports user authentication and raising flags. The AlertsList class provides access to a user's alerts. The BlankFormsList class provides access to a user's blank forms list. The ActionPage class allows programmatic initiation of blank forms. The FolderPage class allows programmatic access to folders.

Namespace hierarchy

Classes

Class Description
Action An action available at a folder stage or from the blank forms list.
ActionPage A folder in an action.
AlertsList A list containing alerts
AttachmentField An attachment field.
BlankFormsList A list containing blank forms
ButtonField A button field.
CheckField A checkbox field.
ClientScript A client-side script.
ClientScriptEvent A client-side script call attached to a field event.
ClientScriptEventName Names of client script events.
ClientScriptEvents A collection of client script events.
Connectable Base abstract class for anything that needs to connect to the engine
Connection Class used to connect to the engine. All communication with the engine is through this class. Configuration is via the ConnectionType, Engine and HttpServer properties. If HTTP is used, a HTTP connection is used to connect to the web server and then DCOM/COM is used to connect to the engine. It is assumed the web part is installed in the default location. i.e. http://webserver/escripts If a more configurable setup is required then contact the author.
CurrencyField A currency field.
DateTimeField A date-time field.
DropDownField A dropdown field.
Field A field on a form.
FolderPage View onto a read-only folder at a stage
Form A form
GridColumn A column in a grid.
GridField A grid field.
ImageField An image field.
LabelField A Label field.
List Abstract base class for any list based data
ListField A list field.
MemoField A memo field.
NumberField A number field.
RadioGroupField A radio group field.
Refreshable Base abstract class for anything that needs to be refreshed
RuleField A rule field.
SignatureField A signature field.
StatusField A status field.
TextField A text field.
UdpXmlDebugger Debugger for XML.

Interfaces

Interface Description
IFolder Interface for any folder based class.

Enumerations

Enumeration Description
Align Alignment of text in a label or text field.
ButtonOperation Operation that occurs when the button is pressed
ClientScriptLanguage The language used for client scripts.
ConnectionType The type of connection to the engine.
DateTimeType Type of a date-time field.
FormType The type of forms to list
GridType The type of a grid.
Orientation Radio group orientation.
RaiseFlagBy Defines how flags will be raised against the engine
RuleStyle Rule border style.