getFormAsPDF

Method Type

JavaScript

Description

Opens the form in the runtime app user's web browser in PDF format.

Parameters

The method input is an object with these parameters, and a callback function.

Field Name Definition

isSave
Function:
Specifies whether to save the form in PDF format.
Type
bool
Accepted Values:
  • True - Saves the form in the runtime app user's web browser in PDF format.
  • False - The form is converted into a base64 encoded string, and returns to the callback function.

Output

A result object that gives the status, data, and error details.

Field Name Definition

isSuccess
Function:
Specifies whether a pop-up shows when the method completes successfully.
Type
bool
Accepted Values:
  • True - The method was successful.
  • False - The method was not successful.

data
Function:
Holds a base64 value or an empty object.

error
Function:
Specifies an error message if an error occurs.
Type
string
Accepted Values:
The contents of an error message.

Example

var options = {};
options.isSave = true/false;
eFormHelper.getFormAsPDF(options, function (result) 
{

  // Here, 'result' is the output parameter
  
  if (result.isSuccess) 
    {
      // Functionality goes here

      // result.data holds the base64encoded value when the 
      //"options.isSave" property value is false
      console.log(result.data);  
    }  
  else 
    {
      // logs the hold exception object
      console.log(result.error);  
    }      
});

Supported Versions

AgilePoint NX v6.0 SP1​ Software Update 1 and higher

Other Examples

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

  • AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
  • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
  • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.