printForm

Method Type

Description

Prints an eForm the way it shows in your web browser in WYSIWYG format or with the default print view that uses the web browser settings.

Prerequisites

In AgilePoint NX releases before AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0, Software Update 2, Cumulative Update 6, you can only print an eForm based on the browser settings, which is called default print view. In AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0, Software Update 2, Cumulative Update 6 or higher, you can print an eForm with the default print view or in WYSIWYG format.

Parameters

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

Field Name	Definition
width	Description: Specifies the width of the form. Type int Allowed Values: An integer. Represents A number of pixels Rules: If you do not specify the width value of the form, by default, it inherits the width of the form that is open.

Output

Field Name	Definition
isSuccess	Description: Specifies whether a pop-up shows when the method completes successfully. Type bool Allowed Values: True - The method was successful. False - The method was not successful.
error	Description: Specifies an error message if an error occurs. Type string Allowed Values: The contents of an error message.

Example

var options = {};
options.width = "512";  // Integer in pixel
eFormHelper.printForm(options, function (result) 
{
  // Here, 'result' is the output parameter

  if (result.isSuccess) 
  {
      // Functionality goes here
  }  
  else 
  {
    // logs the hold exception object
    console.log(result.error);  
  }      
});

Supported Versions

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

Other Examples

(Example) Use Custom JavaScript in an eForm
JavaScript Methods for eForm Builder - Examples for JavaScript methods that are available out-of-the-box (OOTB) in AgilePoint NX.

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.