Embed Comprehensive Field into Document

Table of Contents

What are the comprehensive fields and why you may need it?

Comprehensive fields are the featured fields which will store all the information of your fields like field name, field type, options, formats etc.

Hence comprehensive fields stores all the information of the fields. It will help you to share your document template with all field configurations. So, when you copy the template all fields are loaded automatically with full configuration by reading this comprehensive field information.

How can you insert comprehensive fields inside document?

You can insert comprehensive fields in two ways

1. Just switch on the "Insert Comprehensive Field" toggle and start inserting fields

2. Comprehensive field follows syntax below

"${field_name|field_type|option1: value1; option2: value2; ........}"

field_name : name of the field

field_type : one of text, paragraph, checkbox, choice, dropdown, number, date, time

options : field parameters

You can also write the comprehensive field information in the document directly by following the same syntax.

Standard field Parameters

  • required: true/false
  • description: field description

Full list of field parameters of each field type

1. Textbox

    • type : text
    • description : field description
    • width : field width(in px)
    • required : true/false

Field Output:

Form Output:

Example :

${Student Name|text|width:250;required:true;description:Name of the Student }

2. Number :

    • type : number
    • description : field description
    • width : field width(in px)
    • required : true/false
    • numberFormatIndex : index of number format

Number format indexes

1 - 0 (default)

2 - 0.00

3 - 0.0000

4 - 0,000.00

5 - 0.000.00

Field Output:

Form Output:

Example :

${Student Number|number|width:250;required:true;numberFormatIndex:0; description: Student Number}

3. Drop down :

    • type : drop down
    • description : field description
    • width : field width(in px)
    • required : true/false
    • options : drop down options(comma separated)

Field Output:

Form Output:

Example:

${Student Grade|dropdown|options:A,A+,B,B+; width: 200; required:true;description: Student Grade}

4. Paragraph:

    • type : paragraph
    • description : field description
    • width : field width(in px)
    • height : field height(in px)
    • required : true/false

Field Output:

Form Output:

Example:

${ Student Address|paragraph|width:400;height:200;required:true; description:Student Address }

5. Date

    • type : date
    • description : field description
    • width : field width(in px)
    • required : true/false
    • format: date formats
    • timezone: your timezone

Field Output:

Form Output:

Example:

${Student Joining Date|date|format:MM/DD/YYYY;timezone:Asia/Calcutta;width:500; required:false;description:Student Joining Date}

6. Time

    • type : time
    • description : field description
    • width : field width(in px)
    • required : true/false
    • format: time formates
    • timezone: your timezone

Field Output:

Form Output:

Example:

${School Time|time|format:hh:mm a;timezone:Asia/Calcutta;width:500;required:false;description:School Time }

7. Check box :

    • type : checkbox
    • description : field description
    • width : field width(in px)
    • required : true/false
    • orientation:row/column
    • options : checkbox options(comma separated)

Field Output:

Form Output:

Example:

${Student Subjects|checkbox|options:Maths,Science,Biology;width: 200;required:true;orientation:row;description: Student Subjects}

8. Choice

    • type : choice
    • description : field description
    • width : field width(in px)
    • required : true/false
    • orientation:row/column
    • options : choice options(comma separated)

Field Output:

Form Output:

Example:

${Student Gender|choice|options:Male,Female,Other;width: 200;orientation:column;required:true;description:Student Gender }