Skip to content

Latest commit

 

History

History
111 lines (64 loc) · 2 KB

PDFFileOptions.rst

File metadata and controls

111 lines (64 loc) · 2 KB

PDFFileOptions

app.preferences.PDFFileOptions

Description

Options for opening a PDF file, used with the jsobjref/Application.open method.

All properties are optional.


Properties

PDFFileOptions.pageToOpen

app.preferences.PDFFileOptions.pageToOpen

Description

What page should be used when opening a multipage document.

Default: 1

Type

Number (long)


PDFFileOptions.parent

app.preferences.PDFFileOptions.parent

Description

The object’s container.

Type

Object; read-only.


PDFFileOptions.pDFCropToBox

app.preferences.PDFFileOptions.pDFCropToBox

Description

Which box should be used when placing a multipage document.

Default: PDFBoxType.PDFMediaBox

Type

jsobjref/scripting-constants.PDFBoxType


PDFFileOptions.typename

app.preferences.PDFFileOptions.typename

Description

The class name of the object.

Type

String; read-only.


Example

Opening a PDF with options

// Opens a PDF file with specified options
var pdfOptions = app.preferences.PDFFileOptions;
pdfOptions.pDFCropToBox = PDFBoxType.PDFBOUNDINGBOX;
pdfOptions.pageToOpen = 2;

// Open a file using these preferences
var fileRef = filePath;

if (fileRef != null) {
  var docRef = open(fileRef, DocumentColorSpace.RGB);
}