In This Topic ▼

emptyPageMode Property

Summary

Determines how empty pages are treated during the conversion.

Syntax

TypeScript

JavaScript

Object.defineProperty(DocumentConverterJobData.prototype, 'emptyPageMode', 
   get: function(), 
   set: function(value) 
)

emptyPageMode: DocumentConverterEmptyPageMode;

Determines how empty pages are treated during the conversion. Default value is DocumentConverterEmptyPageMode.None.

Remarks

This option controls how the document converter treats empty pages during the conversion as follows:

Value	Description
DocumentConverterEmptyPageMode.None	Do not do anything special. No detection is performed and empty pages will be added to the output document and the result is guaranteed to have same number of pages as the input. This is the default behavior.
DocumentConverterEmptyPageMode.Skip	Empty pages are skipped and not added to the final document. If the user instructs the converter to use the annotations during conversion, then any page that is empty but has an annotation container with objects is considered none-empty and is added to the output document.
DocumentConverterEmptyPageMode.SkipIgnoreAnnotations	Similar to Empty with the annotations ignored. Empty pages are skipped even if they have annotations.

The document converter uses the following to detect if a page is empty:

If raster conversion is used, a blank page detector image processing command is run on the raster image to detect if the page is empty. The default options only detects if the page is fully empty.
If SVG conversion is used, the converter will enumerate all the elements in the page's SVG document object. The page is considered empty if it does not contain any elements besides the root <svg> element.

Requirements