resource()

The resource() function returns information about an image resource. It can also be used to check if a file exists.

This function is useful in a Control Script, for example to check the number of pages or the page height and width before setting it as a background (see Control Script: Setting a Print section's background).

resource(location, pageNumber)

location

The location should be a URL relative to the template root or an absolute file-based URL (without protocol), e.g. "C:/myfile.pdf".

pageNumber (optional)

The desired page. Counting starts at 1. If no page number is given, information about the first page will be retrieved.

The returned object is of the type ImageInfo. It has the following fields:

Field Type Description
height float The height of the current page (in points).
page Number Current page number (counting from 1) within the resource.
pages Number The total number of pages in the resource.
width float The width of the current page (in points)

Examples

This script retrieves the second page of a PDF that is present in the template's resources.

var pdf = resource("images/stamp.pdf", 2);
var height = pdf.height;
var width = pdf.width;
var numberOfPages = pdf.pages;

In this script, the function is used to check if a file exists.

if(resource("C:/paw.pdf")){
//exists
} else {
//oops
}
 
  • Last Topic Update: 03, October, 2017 03:53 AM
  • Last Published: 23, May, 2019 01:55 PM