Click or drag to resize

WorkflowPage Class

Abstract super class for all web forms used by WorkflowGen actions.
Inheritance Hierarchy

Namespace:  WorkflowGen.My.Web.UI.WebForms
Assembly:  WorkflowGen.My (in WorkflowGen.My.dll) Version: 4.3.0.0 (4.3.0.0)
Syntax
public abstract class WorkflowPage : Page

The WorkflowPage type exposes the following members.

Constructors
  NameDescription
Public methodWorkflowPage
Constructor is used to give default values to properties
Top
Properties
  NameDescription
Public propertyBindCaptionsToFormData
Determine if the field captions are saved to the Form Data dataset
Public propertyCaptionsCssClasses
List of controls Css class names to be excluded in the form data (separated by a coma (,))
Public propertyColorizeRequiredColumnsInGridViewHeader
Are the GridView headers colorized depending on the fields requirements ? (Simple mode only)
Public propertyCurrentSignatureId
The current signature id that will be used to sign the data
Public propertyCurrentTimeZone
The current user time zone
Public propertyCurrentTimeZoneInfo
The current user time zone info in XML
Public propertyCurrentWorkflowActionName
The current action name
Public propertyFieldsColorization
The fields colorization type
Protected propertyFieldsHelper
The Fields helper used for the required, read-only, hidden fields.
Public propertyFormArchive
The Form Archive
Public propertyFormArchiveCssPath
File name of the css file for archive content
Public propertyFormArchiveFileName
File name of the archived form
Public propertyFormData
The simple mode dataset
Public propertyHandleSubmitButton
Determines if we automatically add the Submit Button event handler (only in Simple Mode)
Public propertyHtmlEncodeText
Determines if we encode html in label's Text property
Public propertyInvalidCurrencyErrorMessage
The invalid currency error message
Public propertyInvalidCurrencyGridViewsErrorMessage
The invalid currency for grid views error message
Public propertyInvalidDateErrorMessage
The invalid date error message for the number formats.
Public propertyInvalidDateGridViewErrorMessage
The invalid date error message for the gridviews number formats.
Public propertyInvalidNumberErrorMessage
The invalid number error message
Public propertyInvalidNumberGridViewErrorMessage
The invalid number error message for the gridviews number formats.
Public propertyInvalidTimeErrorMessage
The invalid time error message for the time formats.
Public propertyIsSessionLess
Determines if the workflowPage is using the Session or not for storing internal settings. Performances are better if WorkflowPage uses Session.
Public propertyIsSimpleMode
Determines if the workflowPage is being used in Simple or advanced mode.
Public propertyIsStandAloneMode Obsolete.
Was the web form instantiated by WorkflowGen or directly ?
Public propertyIsXmlSigningEnabled
Is the automatic XML signing enabled ?
Public propertyLangId
The current language of the workflowGen user
Public propertyParamsXPath
The xpath expression used to retreive the action parameters
Public propertyReadOnlyFieldsBorderColor
The read-only controls border color
Public propertyRemoveValidatorsInFormArchive
Determines if all the validators will be hidden automatically in the Form Archive
Public propertyRemoveViewStateInFormArchive
Determines if the View State will be hidden automatically in the Form Archive
Public propertyRemoveWebResourcesInFormArchive
Determines if all the WebResource.axd will be hidden automatically in the Form Archive
Public propertyRequiredColumnsInGridViewsErrorMessage
The required error message for required columns in GridViews
Public propertyRequiredFieldsBorderColor
The required controls border color
Public propertyRequiredFieldsErrorMessage
The required error message for required fields
Public propertyRequiredGridViewsErrorMessage
The required error message for required GridViews
Public propertySaveFormDataWithSchema
Determines if the workflowPage is saving the FormData with its schema
Public propertyStoragePath
The eFormASPX storage path
Public propertyUseClientSideOptimization
Determines if the workflowPage is using client side javascript optimizations or not
Public propertyValidateRequiredFields
Determines if required fields will be validated when submitting the form
Public propertyXmlSignatures
A collection of XmlElement which are the signatures of the previous actions. The first key is the signature Id and the second key is the index of the action.
Top
Methods
  NameDescription
Protected methodBindFormDataToFields
Bind the form data to the right field properties.
Protected methodChangeFormArchiveLayout
Changes the layout for the archive form
Protected methodChangeFormLayout
Makes fields Read-only, required or hidden depending on Workflow parameters
Protected methodFillFormData(DataSet)
Fills a dataset with the information of the dataOUT.xml file
Protected methodFillFormData(XmlDocument)
Fills a XmlDocument with the information of the dataOUT.xml file
Public methodStatic memberFormatAccordingToFieldDataType
Returns the inputValue in the format specified according to it's datatype and the user culture
Protected methodGetFormArchive
Gets the form archive html in a string
Protected methodInitializeCulture
Method used to initialize the culture with the WorkflowGen currently connected user
(Overrides PageInitializeCulture.)
Protected methodIsXmlSignatureValid(String)
Verify if the last action of a signature is valid
Protected methodIsXmlSignatureValid(String, Int32)
Verify if a certain signature is valid
Protected methodOnLoadComplete
This function is called just after the Page_Load, it is used to change the form layout (required, read-only)
(Overrides PageOnLoadComplete(EventArgs).)
Protected methodOnPreLoad
All the initialization is done here before the Page_Load of the client is called.
(Overrides PageOnPreLoad(EventArgs).)
Protected methodRender
Write the static html form and return to WFG
(Overrides PageRender(HtmlTextWriter).)
Protected methodSaveFieldsData
Saves the field values to the form data.
Protected methodSaveFileAttachment(HttpPostedFile)
Save a file attachment to eFormASPX StoragePath, in the "upload" subdirectory.
Protected methodSaveFileAttachment(HttpPostedFile, String)
Save a file attachment to eFormASPX StoragePath, in the "upload" subdirectory.
Protected methodSaveFormData(DataSet)
Saves the form data to the instance path
Protected methodSaveFormData(XmlDocument)
Saves the form data to the instance path
Protected methodSaveFormData(DataSet, Boolean)
Saves the form data to the instance path
Protected methodSubmitToWorkflow
Submits everything to WorkflowGen
Protected methodSubmitToWorkflow(Boolean)
Submits everything to WorkflowGen Determines if the form submission is in draft mode (e.g. disable required gridviews).
Protected methodSubmitToWorkflow(DataSet)
Saves the form data and submits everything to the workflow
Protected methodSubmitToWorkflow(XmlDocument)
Saves the form data and submits everything to the workflow
Protected methodSubmitToWorkflow(DataSet, Boolean)
Save the fields data in the form data, saves the form data and then submits everything to the workflow
Public methodWriteErrorMessage(String, String, Boolean)
Write an error message to the HttpResponse
Public methodWriteErrorMessage(String, String, Exception)
Write an error message to the HttpResponse
Public methodWriteErrorMessage(String, String, Exception, Boolean)
Write an error message to the HttpResponse
Protected methodXmlSignatureExists(String)
Return true if a signature exists for the Id that was passed.
Protected methodXmlSignatureExists(String, Int32)
Return true if a signature exist for the Id and Index that was passed
Top
See Also