Quik! Forms Engine Property List

Below is a list of every property in the Quik! Forms Engine. Properties are organized in tables by category.

Tip: To quickly find information on a specific property, use ctrl+F to search for the property name.

Required Credentials

Property	Type	Description

Property	Type	Description
Authentication Token	OAuth	Every API call requires an authentication token (see Rest Authentication)
QuikFormID	string	A comma separated list of form ids that are to be generated. To generate multiple copies of the same form, include that form's ID multiple times, separated by commas. The order in which you supply the FormIDs is the order in which they will appear in the form package. Required to generate a form.

General Configuration Properties

Property	Type	Description	Default Value (If Applicable)

Property	Type	Description	Default Value (If Applicable)
OutputFileName	string	Gets or sets the name of the output file(s). You do not need to add any file name extension (e.g. ".html" is not required). If left empty, Quik! will generate a file name by default. Possible output files include forms (HTML and PDF), and error logs (XML). This property is to be used locally, and not in a web service.
OutputPath	string	Gets or sets the location where the output files are created.
UNID	string	The read-only unique form view request ID generated by the form request. If used, the Quik! Forms Engine understands that the customer is regenerating a previously saved form package.
UserID	int	Customers that have more than one User account can use the UserID property to specify the usage of one specific User. If a customer has more than one User and does NOT include a UserID, then the customer’s default User (User associated with Master Credentials) is used.
ESignTrackingEnabled	bool	If FALSE, the Sign button will be displayed based on the value of the HTMLButtonSign.Show property. If TRUE, the Sign button will automatically be displayed if generated forms are marked as e-signable in the Quik! Forms Enterprise Manager. Note: Generated form must have at least one signature field in order for Sign button to display. If no signature fields are present, the Sign button will never be displayed.	FALSE
CustomJavaFileIncludePath	array of string	Gets or sets the customer's custom javascript file path in an include statement within the <BODY> tag. Only provide the URI, as the QFE will create the HTML tags automatically. Only one reference file link is supported at this time.
CustomJavaScript	list of strings	Gets or sets the customer's custom javascript text (function) in HTML format to append to the end of the HTML file. Multiple functions should be included within one line, with ';' appended to the end of each instruction.
iScrollFilePath	string	Sets the "src" attribute for the iScroll javascript file to use with the forms. Default version is 4.0 located in the "javascripts" folder where the HTML file is saved.
iScrollOff	bool	Sets iScroll on or off for the Form Viewer all browsers	FALSE
jQueryBlockUIFilePath	string	Sets the "src" attribute for the jQuery javascript file to use with the forms. Default version is located in the "javascripts" folder where the HTML file is saved.
jQueryFilePath	string	Sets the "src" attribute for the jQuery javascript file to use with the forms. Default version is 1.9.1-min located in the "javascripts" folder where the HTML file is saved.
jQueryUIFilePath	string	Sets the "src" attribute for the jQuery UI javascript file to use with the forms. Default version 1.10.3 is located in the "javascripts" folder where the HTML file is saved.
Results	object	A QuikResult object that contains information about any errors that occurred. If no errors occured, a success message is created.
TestDataMode	bool	Writes each field's name as a default value into the field in order to validate that the form was built properly before publishing the form to PUBLISH status.	FALSE
TestFinalFormsMode	bool	Gets or sets the value indicating whether to view forms in final mode. When TRUE, the forms in FINAL status within the Quik! build cycle will be displayed. Do NOT set this property to TRUE in your production environment.	FALSE
DraftMode	bool	When set to TRUE the PDF output by the execute/pdf or the print button will show the form with a “DRAFT” water mark on it. In addition, these transactions will NOT be counted as usage which allows for testing without incurring costs. Do NOT set this flag to TRUE for production use. This property will automatically set the formExpiryDate to 1 day from generation. NOTE: This property will automatically be set to TRUE when the TestFinalFormsMode flag is set to TRUE.	FALSE
GeoLocationOn	bool	Set the ability to capture the signer’s location using HTML5 Geolocation

Quik! Form Viewer Properties

Property	Type	Description	Default Value (If Applicable)

Property	Type	Description	Default Value (If Applicable)
HTMLFieldFontColor	string	Gets or sets the font color for the form fields using an HTML color name or Hex code (e.g. #AA0000 for dark red or #000 for black)
HTMLFooter	string	Gets or sets the default footer HTML value to display as the footer with double-quotes escaped (for each double quote an extra one must be used – e.g. "" will produce a single double quote).	Forms powered by Quik! - <a href=""http://www.QuikForms.com"" target=""_blank"">www.QuikForms.com</a>
HTMLFooterStyle	string	Gets or sets the HTML footer CSS or style in CSS format.	font-family:sans-serif; font-size:8pt; font-style:italic; color:#aa0000; text-align:right; line-height:30px;
HTMLLogoAltText	string	Gets or sets the alternate text for the logo image	"Quik! Forms"
HTMLLogoPath	string	Gets or sets the full URI path to the logo file	""
HTMLMainInstruction	string	Gets or sets the main instruction line on the QFV page	"Complete Your Forms"
HTMLMetaNames	string	Gets or sets the meta names for the HTML page as a single string with double-quotes escaped (for each double quote an extra one must be used – e.g. "" will produce a single double quote)	"<meta name=""viewport"" content=""width=device-width, initial-scale=1.0, user-scalable=yes, minimum-scale=1.0, maximum-scale=1.0"" /><meta name=""apple-mobile-web-app-capable"" content=""yes"" /><meta name=""apple-mobile-web-app-status-bar-style"" content=""black"" />"
HTMLMinorInstruction	string	Gets or sets the minor instruction line on the QFV page	"Review and complete your forms below. When done, print, submit and/or save for your records."
HTMLReportFormError	string	HTML for contacting the administrator. By default, this is HTML for mailto://forms@efficienttech.com (<a href="mailto://forms@efficienttech.com" target="_blank">Report Problems</a>)"	mailto://forms@efficienttech.com (<a href="mailto://forms@efficienttech.com" target="_blank">Report Problems</a>)"
HTMLRequiredBorderColor	string	Gets or sets the color of the borders that surround Required Fields on a form
HTMLShowAltDataButtons	bool	Sets the flag for whether to hide Default Alternative Data Buttons. NOTE: This property only affects whether default alt data buttons are displayed. It does not affect whether custom alt data buttons are displayed.	TRUE
HTMLStyles	string	Gets or sets the CSS styles for the page as a single string. CAUTION: Changing the styles requires careful attention to detail and thorough testing of any changes in all supported browsers.	See Configuring The User Interface
HTMLTitle	string	Gets or sets the title of the HTML page
HTMLLoadingImage	string	Gets or sets the loading image to display when the form loads	"loading.gif"
HostFormOnQuik	bool	When TRUE save the form into Amazon and return a short URL such as https://quikforms.com/viewform/4om6-aGKOqZ3V. CAUTION: Customers should NOT set this property to TRUE unless the forms they are generating are blank or do not include private data, as use of this property sends client data to Quik! to store for up to 24 hours.
InputMaskPath	string	Sets the “src” attribute for the InputMask javascript file to use with the forms. This property is seldom used by customers.
LogoURL	string	URL that should be displayed in a new window when the Form Viewer logo is clicked.
OutputTempFiles	bool	When TRUE, outputs files to the server's temporary directory. If FALSE, outputs files to the OutputPath location
PreviewMode	bool	When TRUE, this property causes the form to be generated in preview mode overriding other settings. Preview mode hides all the buttons in the form viewer, makes the form read-only, and users cannot fill, print, sign or anything. Forms generated when TRUE will not count as a billable transaction in the Quik! system.
PrintEditablePDF	bool	Sets the Print button to generate a PDF that is prefilled and editable
ProductLicenseID	string	The Quik! LicenseID that matches the CustomerUserID
RequireDocName	bool	This forces the user, when True, to Save the document with a name before submitting. This property applies when using Routing Rules only.
RoutingRuleFormGroupID	string	Pass a Form Group ID to run the routing rules associated to that group. This property is intended for use with the FormLinks product only. Please contact Quik! for more information.
RoutingRulesOn	bool	When TRUE routing rules are turned on and applied to the form. This property is intended for use with the FormLinks product only. Please contact Quik! for more information.
SaveSubmitCombined	bool	When FALSE, only the SubmitURL is invoked (if provided). If set to TRUE (default), the SaveURL is invoked first, followed by the SubmitURL.	TRUE
SetFormReadOnly	bool	When TRUE, this property locks all fields on the form, making them "read-only"
ShowCalculatedFieldPopups	bool	When TRUE, calculated field popups are displayed. Calculated fields combine multiple pieces of information (e.g. when a form asks for an owner name, the calculated field called "FullName" is used, which is comprised of the owner's first name, middle name and last name). This property only controls whether or not the popup will display when typing into a calculated field. For turning on/off the concatenation function of calculated fields, see the “FieldCalcOverride” property for form fields in the AddFieldToForm Method documentation.	TRUE
ShowFormsAssignedPerRole	bool	When TRUE, a column labeled “Forms Included” appears. This column displays which forms each signer appears on.	FALSE
ShowMultilinePopups	bool	When TRUE, multiline popups are displayed. Multiline popups are used for large text fields.
SignSubmitCombined	bool	When TRUE, makes the Sign button event first invoke the Submit event and Submit URL before starting the signature process. The Submit validation for required fields will also be triggered but a failed validation will not stop the signature process using the default Submit Javascript.	FALSE
SubmitContentType	RequestContentType	This property can be used when customers would like to process submitted form data in JSON format instead of UrlEncoded. Enum Values: RequestContentType.Json RequestContentType.UrlEncoded RequestContentType.Legacy Legacy and UrlEncoded use url encoded key pair values.	Legacy
AutoCenterFieldsOff	bool	When FALSE, the form page in the Quik! Form Viewer will auto-center to the location of the active field.	TRUE
DisableAttachments	bool	If True, this property hides the attachment panel in the Quik! Form Viewer and any attachment icons near fields on the form.	FALSE
FormExpiryDate	Date	A customer-entered date and time that a form will expire, not to exceed the default value of 10 days from the current system date. Expected Format: `YYYY-MM-DDT00:00:00` (with or without timestamp)
HTML4Compatible	bool	When TRUE, the HTML output will be backwards compatible to HTML 4 browsers including Internet Explorer 8.0. When TRUE, the file size of a generated HTML form can be as much as 50% larger than when this property is set to FALSE.
HTMLBodyOnloadFunction	string	Customers can set a javascript that will be triggered on body onload event. Body onload() occurs after loading the document's DOM as well as resources (images etc.)
ESignSuccessBehavior	Enumerator	This property controls the behavior of the buttons in the HTML Form Viewer after the e-sign event occurs. The setting chosen will determine if the print button and/or sign button continue to function or display after e-signing.	AllowPrintOnly - This option hides all buttons except the print button and sets all fields to read-only, allowing the user to print their submitted form with no editable fields in the PDF HideSignButton - This option only hides the sign button so the e-sign event cannot be used again, however other buttons like the Save, Submit, Print, etc. still function.

HTML Buttons Properties

Property	Type	Description	Default Value (If Applicable)

Property	Type	Description	Default Value (If Applicable)
HTMLButtonClear.Name	string	Sets the name of the Clear button. The Clear button deletes all field data that has been pre-filled or entered by the user.	"Clear"
HTMLButtonClear.Show	bool	Shows/Hides the Clear button. The Clear button deletes all field data that has been pre-filled or entered by the user.	TRUE
HTMLButtonClear.Title	string	Sets the tooltip of the Clear button. The Clear button deletes all field data that has been pre-filled or entered by the user.	"Clear all fields of form data."
HTMLButtonLoad.Name	string	Sets the name of the Load button. The Load button loads the saved version of the form for the user to continue to fill out.	"Load"
HTMLButtonLoad.Show	bool	Shows/Hides the Load button. The Load button loads the saved version of the form for the user to continue to fill out.	TRUE
HTMLButtonLoad.Title	string	Sets the tooltip of the Load button. The Load button loads the saved version of the form for the user to continue to fill out.	"Load your saved data for this set of forms."
HTMLButtonPrint.Name	string	Sets the name of the Print button. The Print button exports and downloads the form as a PDF.	"Print"
HTMLButtonPrint.Show	bool	Shows/Hides the Print button. The Print button exports and downloads the form as a PDF.	TRUE
HTMLButtonPrint.Title	sring	Sets the tooltip of the Print button. The Print button exports and downloads the form as a PDF.	"Create a PDF of this form for printing."
HTMLButtonReset.Name	string	Sets the name of the Reset button. The Reset button deletes all field data that has been entered by the user (pre-filled data will remain).	"Reset"
HTMLButtonReset.Show	bool	Shows/Hides the Reset button. The Reset button deletes all field data that has been entered by the user (pre-filled data will remain).	TRUE
HTMLButtonReset.Title	string	Sets the tooltip of the Reset button. The Reset button deletes all field data that has been entered by the user (pre-filled data will remain).	"Reset all fields to their original state and data."