WorkflowPage Class

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

Inheritance Hierarchy

SystemObject
  System.Web.UIControl
    System.Web.UITemplateControl
      System.Web.UIPage
        WorkflowGen.My.Web.UI.WebFormsWorkflowPage

Namespace: WorkflowGen.My.Web.UI.WebForms
Assembly: WorkflowGen.My (in WorkflowGen.My.dll) Version: 9.1.0.0 (9.1.0.20241025)

Syntax

Copy

public abstract class WorkflowPage : Page

Public MustInherit Class WorkflowPage
	Inherits Page

The WorkflowPage type exposes the following members.

Constructors

	Name	Description
	WorkflowPage	Constructor is used to give default values to properties

Top

Properties

	Name	Description
	BindCaptionsToFormData	Determine if the field captions are saved to the Form Data dataset
	CaptionsCssClasses	List of controls Css class names to be excluded in the form data (separated by a coma (,))
	ColorizeRequiredColumnsInGridViewHeader	Are the GridView headers colorized depending on the fields requirements ? (Simple mode only)
	CurrentSignatureId	The current signature id that will be used to sign the data
	CurrentTimeZone	The current user time zone
	CurrentTimeZoneInfo	The current user time zone info in XML
	CurrentWorkflowActionName	The current action name
	FieldsColorization	The fields colorization type
	FieldsHelper	The Fields helper used for the required, read-only, hidden fields.
	FormArchive	The Form Archive
	FormArchiveCssPath	File name of the css file for archive content
	FormArchiveFileName	File name of the archived form
	FormData	The simple mode dataset
	HandleSubmitButton	Determines if we automatically add the Submit Button event handler (only in Simple Mode)
	HtmlEncodeText	Determines if we encode html in label's Text property
	InvalidCurrencyErrorMessage	The invalid currency error message
	InvalidCurrencyGridViewsErrorMessage	The invalid currency for grid views error message
	InvalidDateErrorMessage	The invalid date error message for the number formats.
	InvalidDateGridViewErrorMessage	The invalid date error message for the grid views number formats.
	InvalidNumberErrorMessage	The invalid number error message
	InvalidNumberGridViewErrorMessage	The invalid number error message for the grid views number formats.
	InvalidTimeErrorMessage	The invalid time error message for the time formats.
	IsOidcAuthSessionRefreshEnabled	Determines if we enable the OIDC auth session refresh management (enabled by default)
	IsSessionLess	Determines if the workflowPage is using the Session or not for storing internal settings. Performances are better if WorkflowPage uses Session.
	IsSimpleMode	Determines if the workflowPage is being used in Simple or advanced mode.
	IsStandAloneMode	Obsolete. Was the web form instantiated by WorkflowGen or directly ?
	IsXmlSigningEnabled	Is the automatic XML signing enabled ?
	LangId	The current language of the workflowGen user
	ParamsXPath	The xpath expression used to retrieve the action parameters
	ReadOnlyFieldsBorderColor	The read-only controls border color
	RemoveValidatorsInFormArchive	Determines if all the validators will be hidden automatically in the Form Archive
	RemoveViewStateInFormArchive	Determines if the View State will be hidden automatically in the Form Archive
	RemoveWebResourcesInFormArchive	Determines if all the WebResource.axd will be hidden automatically in the Form Archive
	RequiredColumnsInGridViewsErrorMessage	The required error message for required columns in GridViews
	RequiredFieldsBorderColor	The required controls border color
	RequiredFieldsErrorMessage	The required error message for required fields
	RequiredGridViewsErrorMessage	The required error message for required GridViews
	SaveFormDataWithSchema	Determines if the workflowPage is saving the FormData with its schema
	StoragePath	The eFormASPX storage path
	UseClientSideOptimization	Determines if the workflowPage is using client side javascript optimizations or not
	ValidateRequiredFields	Determines if required fields will be validated when submitting the form
	XmlSignatures	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

	Name	Description
	BindFormDataToFields(DataSet)	Bind the form data to the right field properties.
	BindFormDataToFields(DataSet, Boolean)	Bind the form data to the right field properties.
	ChangeFormArchiveLayout	Changes the layout for the archive form
	ChangeFormLayout	Makes fields Read-only, required or hidden depending on Workflow parameters
	CurrentUserAccessToken	Retrieve the current user's access token
	FillFormData(DataSet)	Fills a dataset with the information of the dataOUT.xml file
	FillFormData(XmlDocument)	Fills a XmlDocument with the information of the dataOUT.xml file
	FormatAccordingToFieldDataType	Returns the inputValue in the format specified according to it's datatype and the user culture
	GetFormArchive	Gets the form archive html in a string
	GetUnicodeStringRepresentation	Convert provided string to its unicode representation (i.e.: \u0012\u0025)
	InitializeCulture	Method used to initialize the culture with the WorkflowGen currently connected user (Overrides PageInitializeCulture.)
	IsXmlSignatureValid(String)	Verify if the last action of a signature is valid
	IsXmlSignatureValid(String, Int32)	Verify if a certain signature is valid
	OnLoadComplete	This function is called just after the Page_Load, it is used to change the form layout (required, read-only) (Overrides PageOnLoadComplete(EventArgs).)
	OnPreLoad	All the initialization is done here before the Page_Load of the client is called. (Overrides PageOnPreLoad(EventArgs).)
	OnPreRenderComplete	OnPreRenderComplete (Overrides PageOnPreRenderComplete(EventArgs).)
	OnUnload	OnUnload (Overrides ControlOnUnload(EventArgs).)
	Render	Write the static html form and return to WFG (Overrides PageRender(HtmlTextWriter).)
	SaveFieldsData	Saves the field values to the form data.
	SaveFileAttachment(HttpPostedFile)	Save a file attachment to eFormASPX StoragePath, in the "upload" sub directory.
	SaveFileAttachment(HttpPostedFile, String)	Save a file attachment to eFormASPX StoragePath, in the "upload" sub directory.
	SaveFormData(DataSet)	Saves the form data to the instance path
	SaveFormData(XmlDocument)	Saves the form data to the instance path
	SaveFormData(DataSet, Boolean)	Saves the form data to the instance path
	SubmitToWorkflow	Submits everything to WorkflowGen
	SubmitToWorkflow(Boolean)	Submits everything to WorkflowGen Determines if the form submission is in draft mode (e.g. disable required grid views).
	SubmitToWorkflow(DataSet)	Saves the form data and submits everything to the workflow
	SubmitToWorkflow(XmlDocument)	Saves the form data and submits everything to the workflow
	SubmitToWorkflow(DataSet, Boolean)	Save the fields data in the form data, saves the form data and then submits everything to the workflow
	WriteErrorMessage(String, String, Boolean)	Write an error message to the HttpResponse
	WriteErrorMessage(String, String, Exception)	Write an error message to the HttpResponse
	WriteErrorMessage(String, String, Exception, Boolean)	Write an error message to the HttpResponse
	XmlSignatureExists(String)	Return true if a signature exists for the Id that was passed.
	XmlSignatureExists(String, Int32)	Return true if a signature exist for the Id and Index that was passed

Top

Reference

WorkflowGen.My.Web.UI.WebForms Namespace