DL PDF Toolkit User Guide - Datalogics · 2019-12-02 · 1.2 DL PDF Toolkit User Guide An Introduction to DL PDF Toolkit Datalogics DL PDF Toolkit is a framework of basic common Application

Datalogics®

Installation & User Guide

DL PDF Toolkit

DatalogicsD L P D F T O O L K I T

User Guide

DRAFT COPY -- Some components may be partial or incomplete; all are subject to change. Please contact Datalogics Support for the latest revisions to this guide.

This guide is part of the Datalogics DL PDF Toolkit v1.0 suite; 04/12/07.Copyright 1999-2007 Datalogics Incorporated. All Rights Reserved. Use of Datalogics software is subject to the applicable license agreement.DL PDF Toolkit is a trademark of Datalogics Incorporated. Other products mentioned herein as Datalogics products are also trademarks or registered trademarks of Datalogics, Incorporated.Adobe, Adobe PDF Library, PostScript, Acrobat, Distiller, Exchange and Reader are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States or other countries.HP and HP-UX are registered trademarks of Hewlett Packard Corporation.IBM, AIX, AS/400, OS/400, MVS, and OS/390 are registered trademarks of International Business Machines. Java, J2EE, J2SE, J2ME, all Java-based marks, Sun and Solaris are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries.Linux is a registered trademark of Linus Torvalds.Microsoft, Windows and Windows NT are trademarks or registered trademarks of Microsoft Corporation.SAS/C is a registered trademark of SAS Institute Inc.UNIX is a registered trademark of The Open Group.All other trademarks and registered trademarks are the property of their respective owners.

For additional information, contact:Datalogics, Incorporated101 North Wacker Drive, Suite 1800Chicago, Illinois 60606-7301

Phone: 312-853-8200Fax: [email protected]

http://www.datalogics.com


T o C . i

1 Getting Started 1.1

An Introduction to DL PDF Toolkit 1.2

What You Should Know 1.2

How to Use this Book 1.3

What’s New in This Release 1.4

What’s New in Previous Releases 1.5

2 Installing the DL PDF Toolkit 2.1

Installation 2.2

3 DL PDF Toolkit Overview 3.1

DL PDF Toolkit Overview 3.2

Organization 3.2

Current Tools 3.2

4 Using DL PrintAPI 4.1

Overview 4.2

Running the DLPrintAPI_cpp Sample Application 4.2

Running the DLPrintAPI_cs Sample Application 4.8

5 Using DL WatermarkAPI 5.1

Overview 5.2

Running the DLWatermarkAPI_cpp Sample Application 5.3

DLWatermarkAPI_cpp Arguments and Options 5.5

Running the DLWatermarkAPI_cs Sample Application 5.18

DLWatermarkAPI_cs Arguments and Options 5.21

A DL PDF Toolkit Reference Appendix A.1

T o C . i i DL PDF Toolkit User Guide

1
Getting Started
This chapter introduces Datalogics DL PDF Toolkit.

Experienced users may want to skip directly to the section

“What’s New in This Release” on page 1.4 for

information on the latest enhancements and additions.

1.1

1 . 2 DL PDF Toolkit User Guide

An Introduction to DL PDF Toolkit

Datalogics DL PDF Toolkit is a framework of basic common Application Programming Interfaces (APIs)

to encapsulate reusable functionality, use and sharing among various Datalogics PDF utilities. This shared

component forms the “base layer,” or the core functionality layer, upon which these utilities rely.

DL PDF Toolkit is not intended to be a licensable end-user product by itself. Instead, it provides a basic

set of API calls which will provide general services to a collection of other DL products such as DL

PrintAPI and DL WatermarkAPI.

The scope and utility of DL PDF Toolkit is intended to grow as Datalogics products require additional

functionality appropriate for inclusion into the utility API. This guide will be updated as functionality is

added to DL PDF Toolkit. Whenever you upgrade an existing DL utility product, or purchase a new one,

be sure to obtain the latest release of this guide as well, to ensure that you have the latest utility

documentation. Latest additions and enhancements will be listed in “What’s New in This Release” on

page 1.4, as well as in accompanying ReadMe.txt files.

This utility makes use of the Adobe PDF Library and Datalogics Interface (DLI) to facilitate the rapid

creation of PDF via a true Adobe internal interface for interpreting the input documents.

The Adobe PDF Library and Datalogics Interface are also available separately from Datalogics, on

multiple platforms, to enable you to add true Adobe PDF processing and output capability to your own

applications. Contact your Datalogics representative or visit the Datalogics website at http://

www.datalogics.com for more details.

What You Should Know

This document is intended for programmers and other users who are familiar with PDF documents, file

manipulation and general computer processes, or by application designers who are constructing an

application based on the Adobe PDF Library and DLI package.



G e t t i n g S t a r t e d 1 . 3

How to Use this Book

This book has been created to guide you through the process of installing and operating the DL PDF

Toolkit utility and its sample applications.

This chapter, Getting Started, outlines the chapters to follow, explains the document conventions used

here, and lists other related documentation which you may find useful for your work. Follow-on chapters

will outline the the steps needed to install DL PDF Toolkit and perform application development with it.

The following list provides an outline of the chapters as well as a brief description of their contents. Click

on each Chapter title below to jump to its first page.

Chapter 1: "Getting Started" (This chapter) This introduces the DL PDF Toolkit utility and describes

the contents of this book.

Chapter 2: "Installing the DL PDF Toolkit" outlines unpacking and installation of the product

files.

Chapter 3: "DL PDF Toolkit Overview" gives a general explanation of DL PDF Toolkit and its

components, available tools, basic API calls common to all tool applications, and error handling

procedures.

Chapter 4: "Using DL PrintAPI" describes the PrintAPI_cpp and PrintAPI_cs sample

applications included with the DL PrintAPI utility.

Chapter 5: "Using DL WatermarkAPI"describes the WatermarkAPI_cpp and

WatermarkAPI_cs sample applications included with the DL WatermarkAPI utility.

Reference Appendix A: "DL PDF Toolkit Reference Appendix" provides full details on each

interface available in DL PDF Toolkit.


D o c u m e n t C o n v e n t i o n s

The following documentation conventions appear throughout the manual to help you differentiate regular

text from product and program names, and to distinguish command syntax.

• Product and program names are set in italic type.

• Multi-line examples are separated from the text and set in

Courier monospace

• Directory names and filenames are contained within the text and set in Courier monospace.

• All user interface names in this paper are prefixed dlf (representing DL PDF Toolkit)

• DL PDF Toolkit Interface names will be universally in lower case. Enumerator values will be

universally UPPER CASE.

• Commands are contained within the text and set in Courier monospace. If you are reading this

document in PDF form via Adobe Acrobat or Adobe Reader, clicking on a blue command will usually

jump you to a Reference Appendix for full information on that command.

• New terms are italicized.

• Page numbers in this book do not correspond to page numbers in the PDF file. The numbering scheme

(e.g. 4.1 or A.10) indicates the chapter number (4) or appendix letter (A) first, followed by the page

number (1 or 10), separated by a period.

What’s New in This Release

This section contains highlights of new additions and enhancements to DL PDF Toolkit v1.0 (or higher).

You should also check any accompanying readme.txt file in the software folder or directory, which

contains last-minute information on the current release of the software or the documentation files.

Minor version upgrades may be made as running changes rather than full releases, so the version or sub-

version number of your release may be newer than those listed here. See the accompanying readme.txt

file for the very latest changes and enhancements.

I n i t i a l R e l e a s e o f DL PDF Toolkit

This release of DL PDF Toolkit v1.0 is built with Adobe PDF Library v7.0.7Plus and is intended to

accompany the DL PrintAPI and DL WatermarkAPI utilities.

G e t t i n g S t a r t e d 1 . 5

What’s New in Previous Releases

This section contains highlights of new additions and enhancements to past releases of DL PDF Toolkit.

I n i t i a l R e l e a s e o f DL PDF Toolkit

The initial release of DL PDF Toolkit was built with Adobe PDF Library v7.0.1Plus, and was intended to

accompany the DL PDFPrint utility.


2
Installingthe DL PDF Toolkit
This chapter discusses installation of the Datalogics DL

PDF Toolkit, which in turn will enable you to add DL

PDF functionality to your own applications.

2.1


Installation

Installation of the DL PDF Toolkit SDK is straightforward, consisting primarily of unpacking a self-

extracting setup executable to obtain the supporting files (DLL and source), and placing them where

desired for immediate use (e.g. via the prebuilt DL PrintAPI applications) or further development in your

own projects. DL PDF Toolkit is distributed on Windows platforms only, in .DLL form.

U n p a c k i n g t h e T o o l k i t

1 The release is packaged as a self-extracting executable (.exe) file. Download it via your secure ftp

account at ftp.datalogics.com or copy it from your release CD-ROM, as appropriate, into a

temporary folder on your machine. Click on the DL PDF Toolkit .zip file to begin the process by

unpacking the installation files, yielding an .exe application and an .msi installer:

NOTE: These illustrations are for demonstration only. The actual contents of your

DL PDF Toolkit release may vary.

ftp.datalogics.com

I n s t a l l i n g t h e D L P D F T o o l k i t 2 . 3

2 After initial unpacking, a Windows Installer pop-up window may appear briefly as the process loads:

3 When the Welcome screen appears, click Next to begin:


4 By default, the installer places the files in C:\Program Files\Datalogics\DL PDF Toolkit\:

If file size is a concern, select Disk Cost to get a listing of space availability for your installation:

If viewing the Disk Cost screen, click OK to return to the Select Installation Folder screen, and select a

different location if desired. Click the Next button on the Select Installation Folder screen to continue.


5 Installation is ready to begin at this point:

Click the Next button to continue.

6 A progress bar will show the activity as installation proceeds:


7 Click the Close button when installation completes:

8 At this point, you should find a new DL PDFToolkit folder in the location you selected:


9 Opening that folder reveals files representing the DL PDFToolkit and its supporting libraries:

The \Include folder contains the header files for the applications. The \Resources folder contains

subfolders holding the Fonts, CMap (Character Map) files and Unicode mappings required for PDF

work. The \Samples folder contains the sample applications distributed with the DL PDFToolkit:

Installation itself is complete at this point, but you can go on to test the prebuilt C++ Print sample

PrintAPI_cpp.exe application (PrintAPI_cpp) or the C# Print sample DLPrintAPI_cs.exe

application (DLPrintAPI) provided in this release. Even if you are planning to build your own print

application based on DL PDF Toolkit, some initial testing with either sample is recommended, to


ensure that your installation of DL PDF Toolkit ran correctly and that you have all the necessary

resources in place. See “Overview” on page 4.2 or “Running the DLPrintAPI_cs Sample Application”

on page 4.8 for more information.

3
DL PDF Toolkit Overview
This chapter introduces the basics of Datalogics DL PDF

Toolkit.

3.1


DL PDF Toolkit Overview

The Datalogics DL PDF Toolkit offers a basic framework for constructing PDF utility applications to

perform various tasks with a minimum of expert PDF document knowledge required. It comprises various

tools for building tasks to quickly and efficiently perform work such as printing and watermarking of PDF

documents, with tools for other operations to follow in the future.

Organization

Layout of DL PDF Toolkit is straightforward. It consists of a basic framework for building an application

and performing basic operations common to all toolkits, such as application startup and shutdown

(initialization and termination) operations, file handling (e.g. open existing files, close them, create new

ones, etc.) and processing and exception or error handling (e.g. process logging, error message logging,

abnormal shutdown, etc.).

Current Tools

The DL PDF Toolkit will be expanded as time goes by, with future modules added as needed based on

developments in PDF usage, customer requests, or any other needs for simplified and efficient PDF

document handling. For each of the current tools summarized here, a dedicated chapter for that tool

follows later in this guide, and the Reference Appendix lists all available API calls in the current release.

As Chapter 1 explained in “Document Conventions” on page 1.4, clicking on any blue highlighted

command (e.g. CEventLogAppender), will jump you to that command’s full definition in the Reference

Appendix.

Each tool is usually accompanied by one or more buildable sample applications to demonstrate how it can

be used in a command-line or GUI environment. Buildable C++ and/or C# code is provided for building a

basic, functional tool as either a standalone utility program or a component of a larger application.

DL PrintAPI

The DL PrintAPI tool provides API calls to simplify the task of printing PDF documents to an output

device, including functionality for queueing documents, compiling separate files into a single run, and

configuring the output as desired, plus full control of output options supported by the selected device (e.g.

duplex output, bin selection, etc.).

As delivered, DL PDF Toolkit includes two prebuilt DL PrintAPI sample applications: a C++ command-

line interface application (see “Running the DLPrintAPI_cpp Sample Application” on page 4.2), and a C#

D L P D F T o o l k i t O v e r v i e w 3 . 3

example demonstrating the same processes via a Graphical User Interface (see “Running the

DLPrintAPI_cs Sample Application” on page 4.8). Full buildable source-code files are provided. You can

use the included samples as-is, or as templates for modules within a larger application of your own

creation.

More information on DL PrintAPI begins with “Using DL PrintAPI” on page 4.1.

DL WatermarkAPI

The DL WatermarkAPI tool provides API calls to simplify the task of watermarking PDF documents in

various ways as desired, including functionality for overlaid text, underlaid watermarks, screening,

rotation, scaling, application of images (e.g. background patterns, wallpaper, form templates) and other

effects or combinations of effects, colors, typefaces and artwork.

As delivered, DL PDF Toolkit includes two prebuilt DL WatermarkAPI sample applications: a C++

command-line interface application (see “Running the DLWatermarkAPI_cpp Sample Application” on

page 5.3), and a C# example demonstrating the same processes via a Graphical User Interface (see

“Running the DLWatermarkAPI_cs Sample Application” on page 5.18). Full buildable source-code files

are provided, and you are encouraged to read through those to see how a PDF watermarking utility can be

coded and built. You can use the included samples as-is, or as templates for modules within a larger

application of your own creation.

More information on DL WatermarkAPI begins with “Using DL WatermarkAPI” on page 5.1.


4
Using DL PrintAPI
This chapter discusses the DL PrintAPI tool, as well as its

accompanying prebuilt sample applications

DLPrintAPI_cpp and DLPrintAPI_cs, provided

with your release of Datalogics DL PDF Toolkit.

4.1


Overview

The DL PrintAPI tool provides API calls to simplify the task of printing PDF documents to an output

device, including functionality for queueing documents, compiling separate files into a single run, and

configuring the output as desired, plus full control of output options supported by the selected device (e.g.

duplex output, bin selection, etc.).

As delivered, DL PDF Toolkit includes two prebuilt DL PrintAPI sample applications: a C++ command-

line interface application (below), and a C# example demonstrating the same processes via a Graphical

User Interface (see “Running the DLPrintAPI_cs Sample Application” on page 4.8). Full buildable source-

code files are provided, and you are encouraged to read through those to see how a PDF print utility can

be coded and built. You can use the included samples as-is, or as templates for modules within a larger

application of your own creation.

Running the DLPrintAPI_cpp Sample Application

The DLPrintAPI_cpp command-line interface allows you to generate printed output via three different

basic approaches:

• Command-line parameter list of PDF files: specifying individual filename(s) to be printed

• Folder contents: all PDF files within a given folder name will be printed (other file types will be ignored)

• Print list: Similar to the Folder-contents option, but specifying a list filename, a plain text file containing

a list of all PDF files to be printed in the given job

Regardless of how you specify the files to be printed, you can also set print parameters for Number of

Copies and Page Scaling. If the printer allows it, you can also specify Collation, Duplex mode and Paper

Source (by PDF page size) as desired.

NOTE: The DLPrintAPI_cpp application is built from different source code than

DLPrintAPI_cs. These are not intended to be comprehensive: due to coding

differences, not all options in one sample may be present in the other. For full

details on any option or method call, please see the “DL PDF Toolkit Reference

Appendix” on page A.1

U s i n g D L P r i n t A P I 4 . 3

D L P r i n t A P I _ c p p S a m p l e U s a g e

As delivered in a default installation, you will find the DLPrintAPI_cpp.exe application in

C:\Program Files\Datalogics\DL PDF Toolkit\. In a DOS window or console session,

entering the command DLPrintAPI_cpp by itself will give you a short Usage message in reply:

Quick-Reference Argument Summary

Click on the boldface arguments below to jump to their full definitions on the following pages.

binlist Display the list of available paper bins (Optional; No Default)

collate Specify page collation, on printers that support this feature.(Optional; Default n)

copies Specify number of copies to be printed. (Optional; Default 1)

duplex Specify page duplex mode, on printers that support this feature.(Optional; Default s)

[<filename(s)> | folder | filelist]Name(s) of file(s) to be printed (entered directly on command line), or name of folder containing file(s) to be printed, or name of list file containing name(s) of file(s) to be printed. (Select one; Required)

paperbin Name of selected paper bin (Optional; Default to Printer’s Default Bin)

NOTE: Remember that you can use the -binlist switch to obtain a list of valid

paper bins for your selected printer.


printer Name of printer to receive output. Include the server name if not a local printer. (Optional; Default to Designated Default Printer)

scale Specify page scaling. (Optional; Default r)

source Specify page size chosen by PDF page size. (Optional; Default n)

A r g u m e n t s a n d O p t i o n s

While PrintAPI_cpp can be run with as few as one command-line argument (input file(s) to print), you

have numerous options and additional command-line arguments available to you.

Remember that the source code for this sample application is provided within the release (in a default

Windows installation, you can find it in C:\Program Files\Datalogics\DL PDF

Toolkit\Samples\DLPrintAPI_cpp), so that you can make your own alterations and rebuild as

desired.

binlist

binlist (Optional; No Default )

-binlist

The -binlist switch causes the application to display a list of paper bin names to the standard output.

The name of the paper bin can then be used to specify a specific paper source bin (or tray) via the

paperbin argument.

If no printer is specified on the command line, the -binlist switch will return a list of available bin

names for the default printer. Valid only on printers that support this feature. (Optional; Default to

Designated Default Printer)

collate

collate=[y | n] (Default n)

collate=y

The collate argument allows you to specify collation on printers that support this feature. (Optional;

Default n)

NOTE: You can always enter the command dlprintapi_cpp by itself to

generate a Usage message listing the command-line syntax.


copies

copies=numcopies (Default 1)

copies=2copies=17

The copies argument allows you to specify the number of copies desired. (Optional; Default 1)

duplex

duplex=[s | h | v] (Default s)

duplex=hduplex=v

The duplex argument allows you to specify duplex (2-sided) printing on printers that support this feature.

The s value denotes single-sided printing (the default); h and v values denote double sided printing, with

the page flipped to its second side either horizontally or vertically, respectively. (Optional; Default s)

[<filename(s)> | folder | filelist]

You must select one of these methods for specifying the file(s) to be printed:

<filename(s)> (No Default )

customer_news.pdf<doc1.pdf doc2.pdf doc3.pdf ... docn.pdf>

To print individual selected files, simply list them in desired order on the command line, including path or

folder names where necessary.

folder=<foldername> (No Default )

folder=c:\Watchedfolder=c:\May_Reports

The command-line keyword folder can be used to print all the PDF files within the specified folder.

Files will be ordered alphabetically by filename within the print job. If you want to specify an alternate

order of printing sequence, consider either renaming your files with alphabetic or numeric sequence

prefixes (e.g. a_January.pdf, b_February.pdf, c_March.pdf, etc.), or using the filelist

command (below) instead.


filelist=<filename> (No Default )

filelist=all_chapters.txtfilelist=june_projects.txt

The command-line keyword filelist can be used to print all selected documents in a specific order.

Compile the filelist as a plain text file, with the name of each PDF file to be printed on a separate line.

paperbin

paperbin=<bin_name> (No Default)

paperbin=letterpaperbin=legal

The paperbin argument specifies specifies the paper source bin or tray by its name. The names of the

paper bins can be determined by calling PrintAPI_cpp with the -binlist switch. The default is the

default paper bin of the selected printer. (Optional; Default to Default Bin of Printer)

printer

printer=<printername>(Optional; Default to Designated Default Printer)

printer=hp_postscriptprinter=\\finance_dept\xerox_proof

<printer> specifies the name of the printer that will receive the output print stream. This printer can be

locally mounted, such as in the first command sample above, or accessible via a network server, such as in

the second sample above. If not local, the name of the print server must be included preceding the name of

the printer. (Optional; Default to Designated Default Printer)

NOTE: Any file pathnames containing spaces (e.g. C:\Program

Files\Datalogics\...) must be enclosed within double quotes

(e.g."C:\Program Files\Datalogics\...") on the command line, or

filename parsing errors will occur. You do not need to use double quotes if listing

these filenames within a filelist file.

NOTE: The Server name must be specified for remote printing. To point to a

printer on a remote server, give the fully-attributed printer name in the form

"\\ServerName\Printer Name"


scale

scale=[f | r] (Default r)

scale=fscale=r

The scale argument specifies one of two possible scaling options:

• Fit to Printer Margins

• Reduce to Printer Margins

allowing you to specify how oversized or undersized documents should be scaled in relation to the paper

size.

The f value will enlarge undersized documents and reduce oversize documents as necessary to fit the

paper. The original aspect ratio is retained; the page image will be centered on the media, with any excess

whitespace evenly divided on each side.

The r value reduces oversized documents to printer-margin size, but does not expand undersized

documents; those will be centered on the media in their original size. (Optional; Default r)

source

source=[y | n] (Default n)

source=y

The source argument allows you to specify whether paper source should be selected by page size, useful in

cases where a document of different page sizes is fed to a printer offering multiple paper sizes. Valid only

on printers that support this feature. (Optional; Default n)


Running the DLPrintAPI_cs Sample Application

O v e r v i e w

The C# sample application DLPrintAPI_cs not only demonstrates the same processes as

DLPrintAPI_cpp, but also allows the user to build the print job queue in a more intuitive, graphical

manner, via C# methods to generate a Graphical User Interface. It uses the selected printer’s operating

system information to provide option choices correct for that specific printer (e.g. bin selection options),

and provides a means for deleting selected jobs from the queue, rather than having to abandon the entire

queue if last-minute changes are required.

D L P r i n t A P I _ c s S a m p l e U s a g e

As delivered in a default installation, you will find the DLPrintAPI_cs.exe application in

C:\Program Files\Datalogics\DL PDF Toolkit\. Double-clicking on the file will open the

initial screen:

NOTE: The DLPrintAPI_cs application is built from different source code than

DLPrintAPI_cpp. These are not intended to be comprehensive: due to coding

differences, not all options in one sample may be present in the other. For full

details on any option or method call, please see the “DL PDF Toolkit Reference

Appendix” on page A.1


P r i n t e r S e l e c t i o n

The printer selected at startup is the default printer for your machine, e.g. an HP DeskJet 5600 series in

the screen shot above. If a different printer will be used for this job, you should select it first, before

making any other job choices, as many print options presented are guided by (or limited by) the named

printer.

Click on the Select button to obtain a popup Print window, open the pulldown list of available printers,

and click on your choice:

4 . 1 0 DL PDF Toolkit User Guide

F i l e S e l e c t i o n

After selecting your printer, click the Add Document button to pop up a file selection window:

Repeat the process for each file to be added to the job. Files will be processed in the order that they are

selected, and will be listed in order on the main screen as you accumulate them.

U s i n g D L P r i n t A P I 4 . 1 1

F i l e R e m o v a l

The Remove button allows you to remove selected files from the job. Click to highlight the selected file to

be removed, then click the Remove button:


F i l e P r i n t i n g

After selecting the files and printing parameters for your job, click the Print button to submit it. The

Pending Transactions display of the main screen will clear after all the files have been submitted to the

queue:

This will generate one job for all selected files, not a separate job for each file. The print options selected

will apply equally to all files within the job:

The default Document Name for the job is "PDF Document," and the other job statistics are totals for all

selected files combined.

5
Using DL WatermarkAPI
This chapter discusses the DL WatermarkAPI tool, as

well as its sample applications WatermarkAPI_cpp and

WatermarkAPI_cs, provided with your release of

Datalogics DL PDF Toolkit.

5.1


Overview

The DL WatermarkAPI tool provides API calls to simplify the task of watermarking PDF documents in

various ways as desired, including functionality for overlaid text, underlaid watermarks, screening,

rotation, scaling, application of images (e.g. background patterns, wallpaper, form templates) and other

effects or combinations of effects, colors, typefaces and artwork.

As delivered, DL PDF Toolkit includes two prebuilt DL WatermarkAPI sample applications: a C++

command-line interface application (see below), and a C# example demonstrating the same processes via

a Graphical User Interface (see “Running the DLWatermarkAPI_cs Sample Application” on page 5.18).

Full buildable source-code files are provided, and you are encouraged to read through those to see how a

PDF print utility can be coded and built. You can use the included samples as-is, or as templates for

modules within a larger application of your own creation.

U s i n g D L W a t e r m a r k A P I 5 . 3

Running the DLWatermarkAPI_cpp Sample Application

The DLWatermarkAPI_cpp command-line interface allows you to generate watermark output (either

text or images) via a variety of settings for appearance, positioning, color, font usage, and many other

preferences.

D L W a t e r m a r k A P I _ c p p S a m p l e U s a g e

As delivered in a default installation, you will find the DLWatermarkAPI_cpp.exe application in

C:\Program Files\Datalogics\DL PDF Toolkit\. In a DOS window or console session,

entering the command DLWatermarkAPI_cpp by itself will give you a Usage message in reply:

NOTE: The DLWatermarkAPI_cpp application is built from different source

code than DLWatermarkAPI_cs. These are not intended to be comprehensive:

due to coding differences, not all options in one sample may be present in the

other. For full details on any option or method call, please see the “DL PDF Toolkit

Reference Appendix” on page A.1


Quick-Reference Argument Summary

Click on the boldface arguments below to jump to their full definitions on the following pages.

color Color of watermark text (Optional; Do Not Abbreviate; Default black)

constantsize Specify whether watermark should remain the same absolute size (Yes), or scale to match changing page sizes within the document (No) (Optional; Printing Only; Default N)

file Target file to be modified with watermarking (Required; No Default)

font Name of font to be used for watermark text, selected from the available -fontlist names (Optional; Default Helvetica)

-fontlist Command-line switch to generate a listing of available font names (Optional; No Default)

horizontalorigin Origin (zero) location for measurement of horizontalposition value, specified as Center, Left or Right edge of document (Optional; Default C)

horizontalposition Horizontal position of lower left corner of watermark (Optional; Default 0.0)

horizontalunits Units of measurement for horizontalposition value, in Inches, Centimeters or Points (Optional; Default I)

opacity Percentage of watermark opacity (Optional; Default 100)

pagefile Name of pagefile to be used as watermark image (Optional; No Default)

pagefrom First page of document (counting from 1) to be modfied with watermark (Optional; Default 1)

pagenumber Sequence number (counting from 1) of selected page within pagefile to be used as watermark image (Optional; Default 1)

pagesubset Specify pages of document to be modified with watermark: All, Even pages only or Odd pages only (Optional; Default A)

pageto Last page of document (counting from 1) to be modfied with watermark (Optional; No Default)

rotation Angle of rotation of watermark text, in degrees of counterclockwise rotation from horizontal (Optional; Default 0)

scale Percentage of original watermark size (Optional; Default 100)

NOTE: Except where specified, only the first letter of a command-line argument

value should be given. (e.g. "zlocation=B," not "zlocation=bottom")


showwhendisplaying Specify whether watermark will appear when viewed on-screen (Optional; Default Y)

showwhenprinting Specify whether watermark will appear in printed output (Optional; Default Y)

size Size of watermark text, in points (Optional; Default 24)

text Text string to be used as watermark (Optional; No Default)

verticalorigin Origin (zero) location for measurement of verticalposition value, specified as Center, Top or Bottom edge of document (Optional; Default C)

verticalposition Vertical position of lower left corner of watermark (Optional; Default 0.0)

verticalunits Units of measurement for verticalposition value, in Inches, Centimeters or Points (Optional; Default I)

zlocation Specify whether watermark will be overlaid on page content (Top) or placed under it (Below) (Optional; Default T)

DLWatermarkAPI_cpp Arguments and Options

While DLWatermarkAPI_cpp can be run with as few as two command-line arguments (file to

watermark, and text of watermark), you have numerous options and additional command-line

arguments available to you.



Toolkit\Samples\DLWatermarkAPI_cpp), so that you can make your own alterations and rebuild

as desired.

Command-line arguments and options are grouped by general function below.

NOTE: You can always enter the command dlwatermarkapi_cpp by itself to

generate a Usage message listing the command-line syntax.


B a s i c A r g u m e n t s

file

file=<file_name> (Required; No Default)

file=sample.pdffile=C:\annual_reports\2006.pdfile="C:\annual reports\2006.pdf"

The file argument specifies the file to be watermarked.

-fontlist

-fontlist (Optional)

-fontlist

The -fontlist argument compiles a list of available fonts on your machine, and displays the list on-

screen. The full list is compiled before being shown, so on machines with many font resources available,

there may be a noticeable delay before any feedback is seen.

Font names listed here are valid values that can be used in the font argument when setting your

watermark text.

NOTE: Any file pathnames containing spaces (e.g. C:\Program

Files\Datalogics\...) must be enclosed within double quotes

(e.g."C:\Program Files\Datalogics\...") on the command line, or

filename parsing errors will occur.

NOTE: The watermarking process acts on the original input file. It does not create

a new output copy. If you want to save an original (unwatermarked) copy, you

should make a backup before running this utility.


T e x t W a t e r m a r k O p t i o n s

text

text=<watermark_text>(Optional; No Default)

text=PROOFtext="Internal Use Only"text="Sample Copy"

The text argument accepts a text string to be used as a watermark. If the string is longer than one word

(i.e. you have one or more spaces in the text), it must be enclosed within Double Quote characters.

font

font=<font_name> (Optional; Default Helvetica)

font=CordiaNew,Boldfont=CenturySchoolbook

The font argument allows you to specify an alternate font for use in your watermark text string, if the

default Helvetica face is either not wanted or not available. The name of the font to be used for

watermark text should be selected from the available -fontlist names. (Optional; Default Helvetica)

size

size=pointsize (Default 24)

size=16size=30

The size argument allows you to specify the desired point size for your text watermark.

(Optional; Default 24)

NOTE: Any watermark text containing spaces (e.g. Internal Use Only) must

be enclosed within double quotes (e.g."Internal Use Only") on the

command line, or text parsing errors will occur.

NOTE: The size specified by the size argument will also be affected by the

scale argument, if present. See “scale” on page 5.11 for more details.


color

color=[red | green | blue | cyan | magenta | yellow | black](Default black)

color=greencolor=magenta

The -color argument allows you to select an alternate color for your watermark text. (Default black)

P a g e W a t e r m a r k O p t i o n s

pagefile

pagefile=<file_name>(Optional; No Default)

pagefile=template.pdfpagefile=C:\shipping_forms\packing_slip.pdfpagefile="C:\Monthly Reports\Template.pdf"

The pagefile argument specifies a PDF file (which can be an image) to be used as watermark on the

pages of the target file. Examples include form templates, background images or boilerplate text.

pagenumber

pagenumber=page (Default 1)

pagenumber=3pagenumber=25

When importing a page image from another file, the pagenumber argument allows you to specify a

specific page within that file, as opposed to extracting the first page by default. This can be useful when

selecting a particular page template, header or form template from a template collection, for example.


CAUTION: Do not abbreviate the color argument value. The name of the

selected color must be spelled out as shown here.

NOTE: Any pagefile pathnames containing spaces (e.g. C:\Monthly

Reports\...) must be enclosed within double quotes (e.g."C:\Monthly

Reports\...") on the command line, or filename parsing errors will occur.


G e n e r a l A p p e a r a n c e

rotation

rotation=angle (degrees)(Default 0)

rotation=30rotation=-45rotation=315

The watermark is set horizontally by default. You can set it to any angle as desired, measured in degrees of

counterclockwise rotation. A negative value will rotate the watermark clockwise instead; e.g. specifying a

rotation of -45 (to rotate clockwise) yields the same result as a rotation of 315 (rotating

counterclockwise). Rotation is about the midpoint of the watermark, centered on the page, unless you

reposition it elsewhere. (See “Position Options” on page 5.12 for more positioning arguments.)



opacity

opacity=percentage (%)(Default 100)

opacity=30opacity=75

The watermark is normally set as 100% opaque by default. You can lighten its opacity, rendering it

translucent enough to allow objects behind it to show through, by setting its opacity argument to a

suitable value between 0 (clear) and 100 (opaque).

NOTE: Remember that DLWatermarkAPI_cpp sets the watermark on top of the

page content by default. If content visibility is a problem as a result, consider

either making the watermark translucent (via the opacity argument) or placing

the watermark below the page content instead of on top of it (via the

zlocation argument). Different effects can be achieved each way.

U s i n g D L W a t e r m a r k A P I 5 . 1 1

scale

scale=percentage (%)(Default 100)

scale=75scale=150

The scale argument allows you to scale the watermark either up or down from its nominal size, as

desired. Values above its default value of 100 will enlarge the watermark; values below 100 will reduce it.

(See “size” on page 5.7 for details on setting the nominal size.)

zlocation

zlocation=[T | B] (Default T)

zlocation=B

The zlocation argument specifies whether the watermark is to be placed on Top of the page content or

Below it. (i.e. If Below, the watermarket is applied first, then the page content is set on top of it.)

(Optional; Default T)

showwhendisplaying

showwhendisplaying=[Y | N](Default Y)

showwhendisplaying=N

The showwhendisplaying argument controls whether the watermark will appear when the page is

viewed on-screen (e.g. via Adobe Acrobat or Adobe Reader). (Default Y)

showwhenprinting

showwhenprinting=[Y | N](Default Y)

showwhenprinting=N

The showwhenprinting argument controls whether the watermark will appear when the page is

rendered or printed. (Default Y)

NOTE: Remember that DLWatermarkAPI_cpp sets the watermark on top of the

page content by default. If content visibility is a problem as a result, consider

either making the watermark translucent (via the opacity argument) or placing

the watermark below the page content instead of on top of it (via the

zlocation argument). Different effects can be achieved each way.


constantsize

constantsize=[Y | N](Optional; Printing Only; Default N)

constantsize=Y

The constantsize argument controls whether the watermark should remain the same size

(constantsize=Y) or scale to match changing page sizes within the document (constantsize=N)

when the document is rendered or printed. (Optional; Printing Only; Default N)

P o s i t i o n O p t i o n s

Positioning arguments allow you to center the watermark on the page (with or without rotation), or move

it towards any edge or corner as desired, such as to align a form template with document text.

Origin arguments (horizontalorigin, verticalorigin, or both) can set the watermark against a

selected page boundary: Left or Right, Top or Bottom, or any combination of the pair:


Position commands (horizontalposition, verticalposition, or both) can make arbitrary

position adjustments as needed: Left or Right, Up or Down, or any combination of the pair:

horizontalposition

horizontalposition=Xoffset(Default 0.0)

horizontalposition=1.5horizontalposition=-2

The horizontalposition argument allows you to offset the watermark position either left or right as

desired. Positive Xoffset values will shift the watermark to the right; negative values will shift it to the

NOTE: horizontalposition and verticalposition arguments do not

observe page boundaries. Watermarks close to the edge may bleed off. (See

illustration above.) If this is a problem, consider using horizontalorigin

and/or verticalorigin arguments instead.


left. This argument accepts values in inches, centimeters or points, whichever units were specified via the

horizontalunits argument.

If approximate positioning is all you need, the default Inches units of measurement will probably suffice,

but if a finer degree of adjustment is needed, use the horizontalunits argument to select Centimeters

(horizontalunits=C) or Points (horizontalunits=P) instead.

horizontalunits

horizontalunits=[I | C | P](Default I)

horizontalunits=Chorizontalunits=P

The horizontalunits argument specifies the units of measurement for the horizontalposition

argument, used when making horizontal adjustments to watermarket positioning on the page. If

approximate positioning is all you need, the default Inch units of measurement (horizontalunits=I)

will probably suffice; select Centimeters (horizontalunits=C) or Points (horizontalunits=P) if a

finer degree of adjustment is needed instead. (Optional; Default I)

horizontalorigin

horizontalorigin=[L | C | R](Default C)

horizontalorigin=Lhorizontalorigin=R

The horizontalorigin argument specifies the horizontal location of the origin about which the

watermark will be positioned and/or rotated. By default its horizontal position will be the center of the

page, so that, for example, a text watermark will be centered upon it and remain equidistant from the

page boundaries, even if rotated. (Optional; Default C)

verticalposition

verticalposition=Yoffset(Default 0.0)

verticalposition=1.5verticalposition=-2

The verticalposition argument allows you to offset the watermark position either up or down as

desired. Positive Yoffset values will shift the watermark up; negative values will shift it down. This


argument accepts values in inches, centimeters or points, whichever units were specified via the

verticalunits argument.

If approximate positioning is all you need, the default Inches units of measurement will probably suffice,

but if a finer degree of adjustment is needed, use the verticalunits argument to select Centimeters

(verticalunits=C) or Points (verticalunits=P) instead.

verticalunits

verticalunits=[I | C | P](Default I)

verticalunits=Cverticalunits=P

The verticalunits argument specifies the units of measurement for the verticalposition

argument, used when making vertical adjustments to watermarket positioning on the page. If

approximate positioning is all you need, the default Inches units of measurement (verticalunits=I)

will probably suffice; select Centimeters (verticalunits=C) or Points (verticalunits=P) if a finer

degree of adjustment is needed instead. (Optional; Default I)

verticalorigin

verticalorigin=[T | C | B](Default C)

verticalorigin=Tverticalorigin=B

The verticalorigin argument specifies the vertical location of the origin about which the watermark

will be positioned and/or rotated. By default its vertical position will be the center of the page, so that, for

example, a text watermark will be centered upon it and remain equidistant from the page boundaries,

even if rotated. (Optional; Default C)


P a g e R a n g e O p t i o n s

pagefrom

pagefrom=page (Default 1)

pagefrom=5pagefrom=250

The watermarking process by default marks all pages of the target file, starting with the first. You can use

the pagefrom argument to skip the indicated number of pages at the beginning of the file, and begin

watermarking at some point other than the beginning of the document. (Optional; Default 1)

pageto

pageto=page (Default Last Page)pageto=7pageto=290

The watermarking process by default marks all pages of the target file, continuing to the end. You can use

the pageto argument to stop at the indicated number of pages into the file, rather than continue to the

end of the document. (Optional; Default Last Page)

pagesubset

pagesubset=[A | E | O](Default A)

pagesubset=Epagesubset=O

The watermarking process by default marks all pages of the target file, both odd and even (right/left or

recto/verso) pages. You can use the pagesubset argument to specify that only even-numbered or odd-

NOTE: The value given here is the page’s sequential order in the file, counting

from 1; it is not whatever folio number it may show on the page. For example, if

you selected Page iii, and that is the fifth page of your file, you would pass in a

value of 5 here, not 3.



you selected Page iii, and that is the fifth page of your file, you would pass in a



numbered pages should be watermarked, rather than all of them (the default setting).

(Optional; Default A)

NOTE: Odd or Even values selected here refer to the page’s sequential order in

the file, counting from 1, not whatever folio number it may show on the page.


Running the DLWatermarkAPI_cs Sample Application

The DLWatermarkAPI_cs Graphical User Interface (GUI) allows you to generate watermark output

(either text or images) via an interactive screen interface, for choosing a variety of settings for appearance,

positioning, color, font usage, and many other preferences.

D L W a t e r m a r k A P I _ c s S a m p l e U s a g e

As delivered in a default installation, you will find the DLWatermarkAPI_cs.exe application in

C:\Program Files\Datalogics\DL PDF Toolkit\. Running the executable will generate a GUI

NOTE: The DLWatermarkAPI_cs application is built from different source code

than DLWatermarkAPI_cpp. These are not intended to be comprehensive: due

to coding differences, not all options in one sample may be present in the other.

For full details on any option or method call, please see the “DL PDF Toolkit

Reference Appendix” on page A.1


window with a variety of interface components available for configuring the work:

The GUI layout is partitioned into logical groupings of fields, menus and buttons by function,

corresponding to their area of work and to the subheadings below. Click on the boldface items to jump to

their detailed discussion in the following section:

Target Group

File Target file to be modified with watermarking (Required; No Default)


Pages from (Under Page Range Options... submenu) First page of document (counting from 1) to be modfied with watermark (Optional; Default 1)

Subset (Under Page Range Options... submenu) Specify pages of document to be modified with watermark: All, Even pages only or Odd pages only (Optional; Default A)

[Pages] to (Under Page Range Options... submenu) Last page of document (counting from 1) to be modfied with watermark (Optional; Default Last Page)

Source Group

font Name of font to be used for watermark text, selected from the available font resources found on the machine (Optional; Default first font in compiled alphabetic list)

[Page]File Name of pagefile to be used as watermark image (Optional; No Default)

Page Number Sequence number (counting from 1) of selected page within pagefile to be used as watermark image (Optional; Default 1)

Size Size of watermark text, in points (Optional; Default 8)

Text Text string to be used as watermark (Optional; No Default)

Appearance Group

Constant Size (Under Appearance Options... submenu) Specify whether watermark should remain the same absolute size (Yes), or scale to match changing page sizes within the document (No) (Optional; Printing Only; Default N) (Unchecked)

Opacity Percentage of watermark opacity (Optional; Default 100)

Rotation Angle of rotation of watermark text, in degrees of counterclockwise rotation from horizontal (Optional; Default 0) (None)

Scale Percentage of original watermark size (Optional; Default 50)

Show When Displaying (Under Appearance Options... submenu) Specify whether watermark will appear when viewed on-screen (Optional; Default Y) (Checked)

Show When Printing (Under Appearance Options... submenu) Specify whether watermark will appear in printed output (Optional; Default Y) (Checked)

Location Specify whether watermark will be overlaid on page content (On Top Of) or placed under it (Behind) (Optional; Default B)


Position Group

Vertical Distance Vertical position of lower left corner of watermark (Optional; Default 0)

Vertical Units Units of measurement for Vertical_Distance value, in Inches, Centimeters or Points (Optional; Default Points)

Vertical from Origin (zero) location for measurement of Vertical_Distance value, specified as Center, Top or Bottom edge of document (Optional; Default Center)

Horizontal Distance Horizontal position of lower left corner of watermark (Optional; Default 0)

Horizontal Units Units of measurement for Horizontal_Distance value, in Inches, Centimeters or Points (Optional; Default Points)

Horizontal from Origin (zero) location for measurement of Horizontal_Distance value, specified as Center, Left or Right edge of document (Optional; Default Center)

Click on the boldface headings above to jump to their detailed discussion in the following section.

DLWatermarkAPI_cs Arguments and Options

While DLWatermarkAPI_cs can be run with as few as two command-line arguments (file to

watermark, and text of watermark), you have numerous options and additional command-line

arguments available to you.



Toolkit\Samples\DLWatermarkAPI_cs), so that you can make your own alterations and rebuild as

desired.

Arguments and options are grouped by general function below.


T a r g e t G r o u p

File

The File field specifies the file to be watermarked. This field does not accept the filename directly (i.e. by

typing it in); instead you must select the Browse button, and select your file from the popup Windows

Explorer window that appears.

P a g e R a n g e O p t i o n s

The link to this popup window will not become active until you have selected a target file.

The All Pages radio button is selected by default. You use this popup window to refine your choice of

affected pages in the target file, if you do not want every page of the file to be watermarked.

NOTE: The watermarking process acts on the original input file. It does not create

a new output copy. If you want to save an original (unwatermarked) copy, you

should make a backup before running this utility.


Pages from

The watermarking process by default marks all pages of the target file, starting with the first. You can use

the Pages_from field to skip the indicated number of pages at the beginning of the file, and begin

watermarking at some point other than the beginning of the document. (Optional; Default 1)

[Pages] to

The watermarking process by default marks all pages of the target file, continuing to the end. You can use

the [Pages]_to field to stop at the indicated number of pages into the file, rather than continue to the

end of the document. (Optional; Default Last Page)

Subset

The watermarking process by default marks all pages of the target file, both odd and even (right/left or

recto/verso) pages. You can use the Subset argument to specify that only even-numbered or odd-

numbered pages should be watermarked, rather than all of them (the default setting).

(Optional; Default All pages in range)



you selected Page iii, and that is the fifth page of your file, you would enter a




you selected Page iii, and that is the fifth page of your file, you would enter a


NOTE: Odd or Even values selected here refer to the page’s sequential order in

the file, counting from 1, not whatever folio number it may show on the page.


S o u r c e G r o u p

Text

The Text field accepts a text string to be used as a watermark. Enter the text exactly as it should appear.

Font

The Font field allows you to select an alternate font from the pulldown menu for use in your watermark

Text string. The default font to be used is the first one found in an alphabetical listing of the available

font resources on your machine. (Optional; Default first font in compiled alphabetic list)

Size

The Size argument allows you to specify the desired point size for your text watermark.


File

The File field within the Source group specifies a PDF file (which can be an image) to be used as

watermark on the pages of the target file. Examples include form templates, background images or

boilerplate text.

As with the File field of the Target group, you do not enter a filename by keying it directly into the file,

but by selecting the Browse button instead, which will bring up a Windows Explorer window to allow

you to search for and click on the PDF file containing your watermark image.

NOTE: The size specified by the Size argument will also be affected by the

Scale value, if not set to 100. See “scale” on page 5.11 for more details.


Page Number

When importing a page image from another file, the Page_Number argument allows you to specify a

specific page within that file, as opposed to extracting the first page by default. This can be useful when

selecting a particular page template, header or form template from a template collection, for example.


A p p e a r a n c e G r o u p

Rotation

The watermark is set horizontally by default. You can set it to any angle as desired, measured in degrees of

counterclockwise rotation through a full circle. Rotation is about the midpoint of the watermark, centered

on the page, unless you reposition it elsewhere. (See “Position Group” on page 5.27 for more positioning

options.)

Three radio buttons are provided, for -45°, None or 45°settings, plus a Custom window allowing any

degree value from 0° through 360° in single-degree increments, measured counterclockwise from

horizontal.

The -45° radio button will produce a downward (sloping down to the right) watermark orientation; the

45° button, as well as any value entered in the Custom window, will rotate upwards instead.(Optional;

Default None)

NOTE: The Custom window does not allow negative values for clockwise

rotation, but you can rotate the text counterclockwise to reach the same angle

anyway. To specify a downward angle, subtract that desired value from 360° and

set that result instead. e.g. For a desired downard angle of 25° from horizontal,

enter 335° in the Custom field to get the desired result.


Opacity

The watermark is normally set as 100% opaque by default. You can lighten its opacity, rendering it

translucent enough to allow objects behind it to show through (if setting its Location to be Top of

Page), by setting its Opacity argument to a suitable value between 0 (clear) and 100 (opaque).

Scale (relative to target page)

The Scale setting allows you to scale the watermark either up or down from its nominal size, as desired.

Values above 100 here will enlarge the watermark beyond its original size; values below 100 will reduce

it. (See “Size” on page 5.24 for details on setting the nominal, original size.) The check box must be

checked in order to activate the Scale value you have set. (Default 50)

Location

The Location radio buttons specify whether the watermark is to appear behind the page content or on

top of it. (i.e. If behind it, the default setting, the watermark is applied first, then the page content is set on

top of it.) (Optional; Default Appear behind page)

A p p e a r a n c e O p t i o n s

Click on the Appearance Options... link in the Appearance group tp produce this popup window.


Show when printing

The Show_when_printing checkbox controls whether the watermark will appear when the page is

rendered or printed. (Default Y) (Checked)

Show when displaying on screen

The Show_when_displaying_on_screen checkbox controls whether the watermark will appear

when the page is viewed on-screen (e.g. via Adobe Acrobat or Adobe Reader). (Default Y) (Checked)

Keep position and size constant

The Keep_position_and_size_constant checkbox controls whether the watermark should remain

the same size (if checked) or scale to match changing page sizes within the document (if unchecked) when

the document is rendered or printed. (Optional; Printing Only; Default N) (Unchecked)

P o s i t i o n G r o u p

Positioning arguments allow you to center the watermark on the page (with or without rotation), or move

it towards any edge or corner as desired, such as to align a form template with document text.

This group of fields combines the features shown in the DLWatermarkAPI_cpp command-line sample

for horizontalorigin and verticalorigin, and for horizontalposition and

verticalposition, all of which can be used for various effects in when repositioning the watermark

location from its default center-of-page location.

horizontalorigin and verticalorigin can be used to bring a watermark up to a selected page

boundary (i.e. justified against it), or horizontalposition and verticalposition can be used to

bleed it off the edge (as well as for lesser distances, to move it around as desired for alignment purposes).

See examples under “Position Options” on page 5.12.

Vertical Distance

The Vertical_Distance field allows you to offset the watermark position either up or down as

desired. Positive distance values will shift the watermark up; negative values will shift it down. This


argument accepts values in inches, centimeters or points, whichever units are specified via the

Vertical_Units field to its right. (See “Vertical Units” on page 5.28 following.)

If fine positioning is all you need, the default Points units of measurement will probably suffice, but if a

broader degree of adjustment is needed, use the Vertical_Units field to select Centimeters or Inches

instead.

Vertical Units

The Vertical_Units field specifies the units of measurement for the Vertical_Distance field, used

when making vertical adjustments to watermarket positioning on the page. If fine positioning is all you

need, the default Points units of measurement will probably suffice; click the Down Arrow button to

select Centimeters or Inches from the pulldown list if a broader degree of adjustment is needed instead.

(Default Points)

From (Vertical Origin)

The From field specifies the vertical location of the origin about which the watermark will be positioned

and/or rotated. By default its vertical position will be the center of the page, so that, for example, a text

watermark will be centered upon it and remain equidistant from the page boundaries, even if rotated.

(Default Center)

Horizontal Distance

The Horizontal_Distance field allows you to offset the watermark position either right or left as

desired. Positive distance values will shift the watermark right; negative values will shift it left. This

argument accepts values in inches, centimeters or points, whichever units are specified via the

Horizontal_Units field to its right. (See “Horizontal Units” on page 5.28following.)

If fine positioning is all you need, the default Points units of measurement will probably suffice, but if a

broader degree of adjustment is needed, use the Horizontal_Units field to select Centimeters or

Inches instead.

Horizontal Units

The Horizontal_Units field specifies the units of measurement for the Horizontal_Distance

field, used when making horizontal adjustments to watermarket positioning on the page. If fine

positioning is all you need, the default Points units of measurement will probably suffice; click the

Down Arrow button to select Centimeters or Inches from the pulldown list if a broader degree of

adjustment is needed instead. (Default Points)


From (Horizontal Origin)

The From field specifies the horizontal location of the origin about which the watermark will be

positioned and/or rotated. By default its horizontal position will be the center of the page, so that, for

example, a text watermark will be centered upon it and remain equidistant from the page boundaries,

even if rotated. (Default Center)


A
DL PDF Toolkit Reference Appendix
This appendix defines methods available with DL PDF

Toolkit.

For ease of reference on the following pages, C++ API

calls in the Datalogics namespace appear in red; C# calls

in the DL namespace appear in blue.

NOTE: Some common-named API calls exist in multiple namespaces. (e.g. There

are at least five different occurrences of WriteToLog.) Be sure you are consulting

the right listing for the API you want. In cases of duplicate API names, links to this

appendix from chapters within this guide will jump to the correct instance, but

when you are browsing page by page, be sure you are looking at the right API

instance for your needs.

A.1

A . 2 DL PDF Toolkit User Guide

AbortPrinting (void)DL::PrintAPI::PrintJob::

Return Value: void

Description This call triggers a premature termination of printing. All remaining documents in the queue are destroyed.

Parameters

Return Value void

Header PrintJob.h

Related Interfaces

Availability All DL PrintAPI supported utilities

DL PDF Toolkit R e f e r e n c e A p p e n d i x A . 3

AddAppender (CLogAppender* pAppender)DL::Framework::Log::

Return Value: bool

Description This call adds a logging target to which messages may be appended.

Parameters CLogAppender* pAppender: New logging target to be added to the list.

Return Value bool: true if successful

Header Log.h

Related Interfaces

Availability All DL PDF Toolkit supported utilities


AddDocument (String^ inFileName)Datalogics::PrintAPI::DLPrintAPI::

Return Value: void

Description

Parameters :

Return Value void

Header DLPrintAPI.h

Related Interfaces



AdditionalInfo (void)DL::Framework::PDFLibraryError::

Return Value: wstring

Description This call returns additional information associated with a returned exception.

Parameters

Return Value std::wstring: wstring containing additional information

Header UtilExceptions.h

Related Interfaces



AddPDFDocument (const std::wstring & pdfDocNameDatalogics::Framework::PrintJob::)

Return Value: void

Description This call adds the specified document to the back of the PrintJob queue.

Parameters const std::wstring & pdfDocName: print job to be added to the queue

Return Value void:

Header PrintJob.h

Related Interfaces



AddPDFDocument (const std::wstring & pdfDocNameDL::PrintAPI::PrintJob::)

Return Value: void

Description This call adds the specified document to the back of the PrintJob queue.

Parameters const std::wstring & pdfDocName: print job to be added to the queue

Return Value void:

Header PrintJob.h

Related Interfaces



ApplyToDocument (string^ targetname)Datalogics::WatermarkAPI::DLWatermarkAPI::

Return Value: void

Description

Parameters

Return Value void:

Header DLWatermarkAPI.h

Related Interfaces



ApplyToDocument (PDFDocument doc)DL::WatermarkAPI::Watermark::

Return Value: void

Description

Parameters

Return Value void:


Related Interfaces


A . 1 0 DL PDF Toolkit User Guide

BadInput (const std::string &s="DL PDF Toolkit Error: Bad input")DL::Framework::

Return Value: void

Description This exception is thrown when a bad input parameter is passed to an API func-tion.

Parameters const std::string &s="DL PDF Toolkit Error: Bad input": Error message string to display

Return Value void


Related Interfaces


DL PDF Toolkit R e f e r e n c e A p p e n d i x A . 1 1

BeginPrinting (void)Datalogics::Framework::PrintJob::

Return Value: void

Description This call starts printing the first document. Printing continues until the queue is exhausted.

Parameters

Return Value void:

Header PrintJob.h

Related Interfaces



BeginPrinting (void)DL::PrintAPI::PrintJob::

Return Value: void

Description This call starts printing the first document. Printing continues until the queue is exhausted.

Parameters

Return Value void:

Header PrintJob.h

Related Interfaces



CConsoleAppender (int threshold)DL::Framework::

Return Value: void

Description This is a parametered constructor. Messages will be appended to the Console only if they have a severity greater than or equal to the specified threshold.

Parameters int threshold: the lowest level of severity message that will be output to the log file

Return Value void

Header ConsoleLogAppender.h

Related Interfaces



CEventLogAppender (int threshold, std::wstring format = L"%m")DL::Framework::

Return Value: void

Technical Notes

1 The format string is an OR-bar-separated list of symbols for message content items. The sequence of

the items determines each item's actual position in the output log message.

For example:

L"%d | %T | %s | %e | %m"...where:

• %d => date

• %t (or %T) => time

• %s => source

• %e => severity

• %m => message

Description This is a parametered constructor. Messages will be appended to the system event log only if they have a severity greater than or equal to the specified threshold, and will be formatted as specified in format.

Parameters • int threshold: the lowest severity message that will be output to the log file

• format: the format of all log messages. See Technical Notes below.

Return Value void

Header EventLogAppender.h

Related Interfaces



CFileAppender (int threshold, std::string strFileName, std::wstring strFormat)DL::Framework::CFileAppender::

Return Value: void

Technical Notes



For example:

L"%d | %T | %s | %e | %m"...where:

• %d => date


• %s => source

• %e => severity

• %m => message

Description This is a parametered constructor which opens the named file for appending at the end of the file. Messages will be appended to the file only if they have a sever-ity greater than or equal to the specified threshold, and will be formatted as spec-ified in strFormat.


• std::string strFileName: the name of the log file• std::wstring strFormat: the format of all log messages. See Technical

Notes below.

Return Value void

Header FileLogAppender.h

Related Interfaces



ClogAppender (int threshold, std::wstring strFormat)DL::Framework::CLogAppender::

Return Value: void

Technical Notes



For example:

L"%d | %T | %s | %e | %m"...where:

• %d => date


• %s => source

• %e => severity

• %m => message

Description This is a parametered constructor. Messages will be appended to the log only if they have a severity greater than or equal to the specified threshold, and will be formatted as specified in strFormat.


• std::wstring strFormat: the format of all log messages. See Technical Notes below.

Return Value void

Header LogAppender.h

Related Interfaces



CloseStream (void)DL::Framework::CFileAppender::

Return Value: void

Description

Parameters

Return Value void


Related Interfaces



CreatePageWatermark (string^ sourceFileName, int pageNumber, WatermarkOptions^ watermarkOptions)Datalogics::WatermarkAPI::DLWatermarkAPI::

Return Value: void

Description

Parameters

Return Value void


Related Interfaces



CreatePageWatermark (PPDFPage page, PWatermarkOptions wmOptions)DL::WatermarkAPI::Watermark::

Return Value: void

Description

Parameters

Return Value void


Related Interfaces



CreateTextWatermark (String^ watermarkText, TextOptions^ textOptions, WatermarkOptions^ watermarkOptions)Datalogics::WatermarkAPI::DLWatermarkAPI::

Return Value: void

Description

Parameters

Return Value void


Related Interfaces



CreateTextWatermark (const wstring& text, PTextOptions textOptions, PWatermarkOptions wmOptions)DL::WatermarkAPI::Watermark::

Return Value: void

Description

Parameters

Return Value void


Related Interfaces



DLPrintAPI (void)Datalogics::PrintAPI::DLPrintAPI::

Return Value: void

Description .

Parameters void

Return Value void

Header DLPrintAPI.h

Related Interfaces



DLWatermarkAPI (void)Datalogics::WatermarkAPI::DLWatermarkAPI::

Return Value: void

Description .

Parameters void

Return Value void

Header DLPrintAPI.h

Related Interfaces



Error (void)DL::Framework::PDFLibraryError::

Return Value: int

Description This returns the internal error code number reported by the Adobe PDF Library.

Parameters void

Return Value int: an integer representing an error condition


Related Interfaces



Execute (void)Datalogics::PrintAPI::DLPrintAPI::

Return Value: void

Description .

Parameters void

Return Value void

Header DLPrintAPI.h

Related Interfaces



FindFontWithName (const wstring& fontName)DL::Framework::Font::

Return Value: PFont

Technical Notes

1 If font cannot be found, a BadInput exception will be returned.

Description

Parameters

Return Value PFont

Header Font.h

Related Interfaces



Font (void)Datalogics::WatermarkAPI::Font::

Return Value: void

Description

Parameters

Return Value void

Header DLWaterAPI.h

Related Interfaces



Font (void)DL::Framework::Font::

Return Value: void

Description

Parameters

Return Value void

Header DLWaterAPI.h

Related Interfaces



FormatMsg (int severity, std::wstring message, std::wstring & outstring)DL::Framework::CLogAppender::

Return Value: void

Description

Parameters • int severity: severity of the message to be processed• std::wstring message: text of the message to be processed• std::wstring & outstring: output format of the message to be

processed

Return Value void


Related Interfaces



GetEncoding (void)DL::Framework::Font::

Return Value: virtual wstring

Description This call returns the encoding of the font.

Parameters void

Return Value virtual::wstring: a string containing the font encoding; e.g. WinAnsiEn-coding or MacRomanEncoding

Header Font.h

Related Interfaces



GetFileName (void)DL::Framework::PDFDocument::

Return Value: vstd::wstring

Description This call obtains the file name of this document.

Parameters void

Return Value std::wstring: a string containing the document file name.

Header PDFDocument.h

Related Interfaces



GetFont (void)Datalogics::WatermarkAPI::TextOptions::

Return Value: string

Description This call obtains the current font.

Parameters void

Return Value string: a string containing the font name.


Related Interfaces



GetFontList (void)Datalogics::WatermarkAPI::DLWatermarkAPI::

Return Value: ArrayList

Description This returns a list of available fonts that can be used by DL PDF Toolkit

Parameters void

Return Value ArrayList


Related Interfaces



GetFontList (void)DL::Framework::Font::

Return Value: static FontList

Description This returns a list of available fonts that can be used by DL PDF Toolkit

Parameters void

Return Value static FontList

Header Font.h

Related Interfaces



GetName (void)Datalogics::WatermarkAPI::Font::

Return Value: String

Description This returns the name of the current font.

Parameters void

Return Value String


Related Interfaces GetType



GetName (void)DL::Framework::Font::


Description This returns the name of the current font.

Parameters void

Return Value virtual wstring

Header Font.h

Related Interfaces GetType



GetPage (int pageNumber)Datalogics::Framework::PDFDocument::

Return Value: PDFPage

Description This call obtains the specified page of the document.

Parameters int pageNumber: Sequence number of the page in the document, counting from 1

Return Value PDFPage: retrieved page from the document

Header PDFDocumentDotNet.h

Related Interfaces



GetPage (long pageNumber)DL::Framework::PDFDocument::

Return Value: virtual PPDFPage

Technical Notes

1 If pageNumber is out of range for the specified document, a BadInput exception will be returned.

Description This call obtains a PDFPage object for the specified page of the document.

Parameters long pageNumber: Sequence number of the page in the document, counting from 1

Return Value virtual PPDFPage: retrieved page from the document


Related Interfaces



GetPageCount (void)DL::Framework::PDFDocument::

Return Value: int

Description This call obtains the page count of this document.

Parameters void

Return Value int: an integer number of pages in the document


Related Interfaces



GetSource (void)DL::Framework::CLogAppender::

Return Value: const std::wstring&

Description This call returns the current source location.

Parameters void

Return Value const std::wstring&: a string representing the source location


Related Interfaces



GetSource (void)DL::Framework::Log::

Return Value: const std::wstring&

Description This call returns the current source location.

Parameters void

Return Value const std::wstring&: a string representing the source location

Header Log.h

Related Interfaces



GetString (void)DL::Framework::Ustring::

Return Value: std::string

Technical Notes

1 If you need a const char *, convert to one of these and use c_str().

Description This call converts a Unicode string to the current ANSI code page. See Technical Notes below.

Parameters void

Return Value std::string: the converted string

Header UString.h

Related Interfaces



GetTextSize (void)Datalogics::WatermarkAPI::TextOptions::

Return Value: float

Description This call retrieves the current text size.

Parameters void

Return Value float: the current text size


Related Interfaces



GetType (void)Datalogics::WatermarkAPI::Font::

Return Value: string

Description This call retrieves the current font type.

Parameters void

Return Value string: the current font type


Related Interfaces GetName



GetType (void)DL::Framework::Font::


Description This call retrieves the current font type.

Parameters void

Return Value virtual wstring: the current font type; e.g. Type0, Type1, MMType1 or TrueType

Header Font.h

Related Interfaces GetName



Instance (void)DL::Framework::Log::

Return Value: static Log*

Description This creates a pointer to the Log object. Only one Log object exists at a time. Instance creates the Log object and returns a pointer to it.If a Log already exists, Instance returns a pointer to the existing object.

Parameters

Return Value static Log*: a pointer to the Log ovject

Header Log.h

Related Interfaces



InternalError (const std::string &s="DL PDF Toolkit Error: Internal error")DL::Framework::InternalError::

Return Value: void

Description This is an exception thrown when there is an internal error in the code.

Parameters

Return Value const std::string &s="DL PDF Toolkit Error: Internal error": Thrown exception


Related Interfaces



IsPrintable (string^ inFileName)Datalogics::PrintAPI::DLPrintAPI::

Return Value: bool

Description This call determines if the document is printable. PDF documents may carry a restriction prohibiting printing. If so, this call will return false.

Parameters string^ inFileName

Return Value bool: a Boolean value indicating whether the document allows printing

Header DLPrintAPI.h

Related Interfaces



IsPrintable (void)DL::Framework::PDFDocument::

Return Value: bool

Description This call determines if the document is printable. PDF documents may carry a restriction prohibiting printing. If so, this call will return false.

Parameters void

Return Value bool: a Boolean value indicating whether the document allows printing


Related Interfaces



Log (void)DL::Framework::

Return Value: void

Technical Notes

1 Direct construction is prohibited; use Instance instead.

Description This is a default constructor. See Technical Notes below.

Parameters void

Return Value void

Header Log.h

Related Interfaces Instance



Make (void)DL::Framework::PDFLibrary::

Return Value: static PPDFLibrary

Description This call obtains a PDFLibrary object.Only one PDFLibrary object may exist at a time, on a thread. If you call this func-tion more than once on a thread, you will obtain additional pointers to the same object.

Parameters void

Return Value static PPDFLibrary: A shared pointer to this thread's instance of a PDFLi-brary

Header PDFLibrary.h

Related Interfaces



Make (const std::wstring & pdfFileName)DL::Framework::PDFDocument::

Return Value: static PPDFLibrary

Description This call makes a PDFLibrary object from a filename. It creates a PDF Document Object for an existing PDF File without a password, and returns a shared pointer to the object.Only one PDFLibrary object may exist at a time, on a thread. If you call this func-tion more than once on a thread, you will obtain additional pointers to the same object.

Parameters const std::wstring & pdfFileName: the name of the PDF document file

Return Value static PPDFLibrary: A shared pointer to this PDF document object for this file

Header PDFLDocument.h

Related Interfaces



Make (void)DL::PrintAPI::PrintJob::

Return Value: static PPrintJob

Description This is a simple PrintJob factory, creating a PrintJob object, initializing PrintJob internal structures, and automatically calling Init.

Parameters void

Return Value static PPrintJob: A pointer to a PrintJob object

Header PrintJob.h

Related Interfaces



Make (void)DL::WatermarkAPI::WatermarkOptions::

Return Value: static PWatermarkOptions

Description This call creates a new WatermarkOptions object with default values.

Parameters void

Return Value static PWatermarkOptions: A pointer to a WatermarkOptions object

Header WatermarkOptions.h

Related Interfaces Make (DL::WatermarkAPI::TextOptions)

Availability All DL WatermarkAPI supported utilities


Make (void)DL::WatermarkAPI::TextOptions::

Return Value: static PTextOptions

Description This call creates a new TextOptions object with default values.

Parameters void

Return Value static PTextOptions: A pointer to a TextOptions object

Header TextOptions.h

Related Interfaces Make (DL::WatermarkAPI::WatermarkOptions)



ObjectName (void)DL::Framework::PDFLibraryError::

Return Value: std::wstring

Description This call obtains the name of the object associated with the returned exception. For example, in the case of an exception related to a file, this will be the filename.

Parameters void

Return Value std::wstring: name of the object associated with the thrown exception


Related Interfaces



OpenStream (std::string strFileName)DL::Framework::CFileAppender::

Return Value: bool

Description This call opens a stream to the indicated filename, returning a Boolean flag to indicate success or failure.

Parameters std::string strFileName: Filename to locate and open.

Return Value bool: a Boolean flag indicating success or failure of the attempt


Related Interfaces



operator= (char c)DL::Framework::Ustring::

Return Value: UString&

Description This call assigns the indicated narrow character to a Unicode string. On Windows platforms, the narrow character is assumed to be within the current ANSI code page.

Parameters char c: the narrow character to be assigned

Return Value UString&: the returned Unicode string

Header UString.h

Related Interfaces



PageIndexRangeError (const std::string &s="DL PDF Toolkit Error: Page index out of range")DL::Framework::PageIndexRangeError::

Return Value: void

Description This exception is thrown when a page number is out of range for the document.

Parameters const std::string &s="DL PDF Toolkit Error: Page index out of range": returned exception message

Return Value void


Related Interfaces



PageRange (void)DL::Framework::PageRange::

Return Value: void

Description

Parameters void

Return Value void

Header PageRange.h

Related Interfaces



PDFDocument (System::String^ filename)Datalogics::Framework::PDFDocument::

Return Value: void

Description This call will open the PDF document specified by filename.

Parameters System::String^ filename: Name of the PDF document to be opened.

Return Value void


Related Interfaces



PDFDocument (void)DL::Framework::PDFDocument::

Return Value: void

Technical Notes

1 Direct construction is prohibited; use Make to create a PDFDocument object instead.


Parameters void

Return Value void


Related Interfaces Make (DL::Framework::PDFDocument::)



PDFLibrary (void)DL::Framework::PDFLibrary::

Return Value: void

Technical Notes

1 Direct construction is prohibited; use Make to obtain a PDFLibrary object instead.


Parameters void

Return Value void

Header PDFLibrary.h

Related Interfaces Make (DL::Framework::PDFLibrary::)



PDFLibraryError (int error, const std::wstring & objectName = L"PDF Library Error",const std::wstring & additionalInfo = L"")DL::Framework::PDFLibraryError::

Return Value: void

Description This call creates a PDFLibraryError object.

Parameters • int error: the internal error code number

• const std:wstring & objectName: The name of the object (i.e.

filename for a file) that received the error.

• const std::wstring & additionalInfo : a string containing

additional information about the error

Return Value DLPDF_ErrorCode: an integer representing an error condition


Related Interfaces



PDFPage (DL::Framework::PPDFPage page)Datalogics::Framework::PDFPage::

Return Value: void

Description This represents a single page from a PDF document.

Parameters

Return Value void

Header PDFPageDotNet.h

Related Interfaces



PDFPage (void)DL::Framework::PDFPage::

Return Value: void

Technical Notes

1 Direct construction is prohibited; use GetPage to obtain a PDFPage object instead.

Description This represents a single page from a PDF document. This is a default constructor. See Technical Notes below.

Parameters

Return Value void

Header PDFPageDotNet.h

Related Interfaces GetPage (DL::Framework::PDFDocument::)



PermissionError (const std::string &s="PDF Document Permissions Error: ")DL::Framework::PermissionError::

Return Value: DLPDFTOOLKIT_DECL PermissionError

Description This exception is thrown when there is a problem with the document permissions.

Parameters

Return Value DLPDFTOOLKIT_DECL PermissionError


Related Interfaces



PrintJob (void)Datalogics::Framework::PrintJob::

Return Value: void

Description This call creates a new PrintJob object.

Parameters void

Return Value void

Header PrintJobDotNet.h

Related Interfaces



RegisterEventLog (void)DL::Framework::CEventLogAppender::CEventLogAppender::

Return Value: bool

Description This call registers the event log for the process.

Parameters

Return Value bool:a Boolean value reporting success or failure


Related Interfaces



Save (PDFDocSaveType saveType = Incremental)DL::Framework::PDFDocument::

Return Value: virtual void

Description This call saves the PDF document to its associated file name.The file name associated with the document is the file name used on the last SaveAs, or, if no SaveAs has been done, the file name when the document object was created.

Parameters PDFDocSaveType saveType: Optional type of document save: Incremen-tal (save only those portions of the document that have changed), Full (save the entire document, removing unreferenced document objects), or Linear-ized (save the PDF document in a format that is optimized for page-served remote (network) access) (Default Incremental)

Return Value void


Related Interfaces SaveAs (DL::Framework::PDFDocument::)



SaveAs (String^ filename)Datalogics::Framework::PDFDocument::

Return Value: virtual void

Description This call saves the PDF document to its associated file name.The file name associated with the document is the file name used on the last SaveAs, or, if no SaveAs has been done, the file name when the document object was created.

Parameters PDFDocSaveType saveType: Optional type of document save: Incremen-tal (save only those portions of the document that have changed), Full (save the entire document, removing unreferenced document objects), or Linear-ized (save the PDF document in a format that is optimized for page-served remote (network) access) (Default Incremental)

Return Value void


Related Interfaces SaveAs (DL::Framework::PDFDocument::)



SaveAs (String^ filename)Datalogics::Framework::PDFDocument::

Return Value: void

Description This call saves the document under the specified filename.

Parameters String^ filename: Name of file to be generated

Return Value void


Related Interfaces



SaveAs (const std::wstring& pdfFileName, PDFDocSaveType saveType = Incremental)DL::Framework::PDFDocument::

Return Value: void

Description This call saves the document under the specified filename. The file name associated with this PDF document object is also changed such that future Save method calls will save to pdfFileName as well.

Parameters onst std::wstring& pdfFileName,: Name of file to be generatedPDFDocSaveType saveType: Optional type of document save: Incremen-tal (save only those portions of the document that have changed), Full (save the entire document, removing unreferenced document objects), or Linear-ized (save the PDF document in a format that is optimized for page-served remote (network) access) (Default Incremental)

Return Value void


Related Interfaces



SaveWithPassWords (long permissions, const std::wstring & ownerPassword = L"noPassword", const std::wstring & userPassword = L"noPassword")DL::Framework::PDFDocument::

Return Value: void

Technical Notes

1 The following permissions (continued on next page) are supported as an "OR" construction to set the

desired PDF document access:

Description This call saves the PDF document securely with password(s)If the document has a security handler, it is retained. If the document does not have a security handler, it is assigned the "Standard" security handler with a 16-bit key length.Access permissions as well as owner and user passwords are assigned to the PDF document. If a password consists of the string "noPassword" (as shown), then no new password is assigned and any existing password is removed.Finally, a "Full" save is done. The file name associated with the document is the file name used on the last SaveAs, or, if no SaveAs has been done, the file name when the document object was created.

Parameters • permissions: an "OR" of the types of PDF document access allowed. See Technical Notes below.

• ownerPassword: Optional PDF document owner password• userPassword: Optional PDF document user password

Return Value void


Related Interfaces SaveAs


Permission Grants

AllowAccessAPI Allow use of the accessibility API

AllowComment Allow the addition/modification/deletion of text notes

AllowCopy Allow information to be copied from the docu-ment

AllowDocAssembly Allow page insert/delete/rotate and bookmark/thumbnail creation


AllowEdit Allow changes to the document

AllowEverything Allow all types of access

AllowFillandSign Allow existing form fields to be filled in and signed

AllowFormSubmit Allow the user to submit forms outside the browser

AllowHighResPrint Allow high resolution printing

AllowLowResPrint Allow low quality printing

AllowSecure Allow the user to change the document security settings

AllowSpawnTempl Allow the user to spawn template pages

Permission Grants


SetAlignmentMode (AlignmentMode textAlignment)Datalogics::WatermarkAPI::TextOptions::

Return Value: void

Description This call sets the horizontal positioning of a text watermark.

Parameters AlignmentMode textAlignment: Alignment Mode: Left, Center or Right (Default Center)

Return Value void


Related Interfaces



SetAlignmentMode (AlignmentMode textAlignment)DL::WatermarkAPI::TextOptions::

Return Value: void

Description This call sets the horizontal positioning of a text watermark.

Parameters AlignmentMode textAlignment: Alignment Mode: Left, Center or Right (Default Center)

Return Value void


Related Interfaces



SetCollationMode (int collationMode)Datalogics::Framework::PrintJob::

Return Value: void

Description This call sets the collation mode of a print job. Making a call to SupportsCol-lation first is recommended, so that you can avoid accidentally sending a Col-lation configuration command to a printer that does not support it.

Parameters int collationMode: Collation mode flag: Yes or No (Default N)

Return Value void


Related Interfaces SupportsCollation



SetCollationMode (int nCollateMode)DL::PrintAPI::PrintJob::

Return Value: void

Description This call sets the collation mode of a print job. Making a call to SupportsCol-lation first is recommended, so that you can avoid accidentally sending a Col-lation configuration command to a printer that does not support it.

Parameters int nCollateMode: Collation mode flag: 1 (On) or 0 (Off) (Default 0)

Return Value void

Header PrintJob.h

Related Interfaces SupportsCollation



SetColor (float grey)(float red, float green, float blue)(float cyan, float magenta, float yellow, float black)Datalogics::WatermarkAPI::TextOptions::

Return Value: void

Description This call sets the color value of the text. Depending on the number of arguments, you can specify a greyscale value, RGB value or CMYK value. In each case, argu-ment values range from 0.0 for no color (i.e. black if greyscale) to 1.0 for full saturation (white if greyscale).

Parameters float [color(s)]: Color level(s), as 1, 3 or 4 arguments:• float grey: greyscale level, from 0.0 (black) to 1.0 (white)• float red, float green, float blue: RGB levels, from 0.0 (no

color) to 1.0 (full saturation) for each• float cyan, float magenta, float yellow, float black:

CMYK levels, from 0.0 (no color) to 1.0 (full saturation) for each

Return Value void


Related Interfaces



SetColor (float grey)(float red, float green, float blue)(float cyan, float magenta, float yellow, float black)DL::WatermarkAPI::TextOptions::

Return Value: void

Description This call sets the color value of the text. Depending on the number of arguments, you can specify a greyscale value, RGB value or CMYK value. In each case, argu-ment values range from 0.0 for no color (i.e. black if greyscale) to 1.0 for full saturation (white if greyscale).

Parameters float [color(s)]: Color level(s), as 1, 3 or 4 arguments:• float grey: greyscale level, from 0.0 (black) to 1.0 (white)• float red, float green, float blue: RGB levels, from 0.0 (no

color) to 1.0 (full saturation) for each• float cyan, float magenta, float yellow, float black:

CMYK levels, from 0.0 (no color) to 1.0 (full saturation) for each

Return Value void


Related Interfaces



SetCopies (int copies)Datalogics::Framework::PrintJob::

Return Value: void

Description This call sets the number of copies to be producedby the selected printer.

Parameters int copies: Number of Copies, from 1 to 9999, or the maximum permitted by the printer. (Default 1)

Return Value void


Related Interfaces



SetCopies (int nCopies)DL::PrintAPI::PrintJob::

Return Value: void

Description This call sets the number of copies to be producedby the selected printer.

Parameters int nCopies: Number of Copies, from 1 to 9999, or the maximum permitted by the printer. (Default 1)

Return Value void

Header PrintJob.h

Related Interfaces



SetDuplexMode (int duplexMode)Datalogics::Framework::PrintJob::

Return Value: void

Description This call sets the Duplex Mode for the selected printer. Making a call to Sup-portsDuplex first is recommended, so that you can avoid accidentally sending a Duplex configuration command to a printer that does not support it.

Parameters int duplexMode: Duplex Mode, where 1 = Simplex mode, 2 = Short Edge binding (flip pages on their short edge, such as notepad style) and 3 = Long Edge binding (flip pages on their long edge, book style) (Default 1)

Return Value void


Related Interfaces SupportsDuplex



SetDuplexMode (int nDuplexMode)DL::PrintAPI::PrintJob::

Return Value: void

Description This call sets the Duplex Mode for the selected printer. Making a call to Sup-portsDuplex first is recommended, so that you can avoid accidentally sending a Duplex configuration command to a printer that does not support it.

Parameters int nDuplexMode: Duplex Mode, where 1 = Simplex mode, 2 = Short Edge binding (flip pages on their short edge, such as notepad style) and 3 = Long Edge binding (flip pages on their long edge, book style) (Default 1)

Return Value void

Header PrintJob.h

Related Interfaces SupportsDuplex



SetFont (Font^ font)(String^ fontName)Datalogics::WatermarkAPI::TextOptions::

Return Value: void

Description This call sets the font for the watermark text.

Parameters Either Font^ font or String^ fontName: the selected font for the water-mark text

Return Value void


Related Interfaces



SetFont (PFont font)DL::WatermarkAPI::TextOptions::

Return Value: void

Description This call sets the font for the watermark text.

Parameters PFont font: the selected font for the watermark text

Return Value void


Related Interfaces



SetHorizontalPosition (float distance, HorizontalAlignmentMode alignment)Datalogics::WatermarkAPI::WatermarkOptions::

Return Value: void

Description This call sets the watermark’s horizontal position and alignment.

Parameters • float distance: Distance from the origin, in the selected unts (Default 0.0)

• HorizontalAlignmentMode alignment: Alignment position: L (Left), C (Center) or R (Right) (Default C)

Return Value void


Related Interfaces SetVerticalPosition



SetHorizontalPosition (double distance, HorizontalAlignmentMode alignment)DL::WatermarkAPI::WatermarkOptions::

Return Value: void

Description This call sets the watermark’s horizontal position and alignment.

Parameters • double distance: Distance from the origin, in the selected unts (Default 0.0)

• HorizontalAlignmentMode alignment: Alignment position: L (Left), C (Center) or R (Right) (Default C)

Return Value void


Related Interfaces SetVerticalPosition



SetJobName (String^ jobName)Datalogics::Framework::PrintJob::

Return Value: void

Description This call assigns a name to the print job. That name will appear in the Windows print queue, and on any separator pages that the printer may produce.

Parameters String^ jobName: Job Name to be displayed (No Default)

Return Value void


Related Interfaces



SetJobName (const std::wstring & wstrJobName)DL::PrintAPI::PrintJob::

Return Value: void

Description This call assigns a name to the print job. That name will appear in the Windows print queue, and on any separator pages that the printer may produce.

Parameters const std::wstring & wstrJobName: Job Name to be displayed (No Default)

Return Value void

Header PrintJob.h

Related Interfaces



SetPageScalingMode (PageScaleMode eScaleMode)DL::PrintAPI::PrintJob::

Return Value: void

Description This call sets the Page Scaling Mode via a choice of enumeration values.

Parameters PageScaleMode eScaleMode: Scaling Mode, where ScaleShrinkToFit will reduce an oversize page to the margins of the paper, and ScaleToFit will expand or reduce the page as necessary to fit the margins of the paper. The distin-guishing characteristic here is that ScaleToFit will act on undersized pages to make them larger as needed; ScaleShrinkToFit will leave them alone. (Default ScaleShrinkToFit)

Return Value void

Header PrintJob.h

Related Interfaces



SetKeepPositionConstant (bool cons)Datalogics::WatermarkAPI::WatermarkOptions::

Return Value: void

Description This call sets a flag to indicate that the watermark position should remain con-stant, in documents where page size varies from one page to another.

Parameters bool cons: setting flag, true or false (Default false)

Return Value void


Related Interfaces



SetKeepPositionConstant (bool cons = false)DL::WatermarkAPI::WatermarkOptions::

Return Value: void

Description This call sets a flag to indicate that the watermark position should remain con-stant, in documents where page size varies from one page to another.

Parameters bool cons = false: setting flag, true or false (Default false)

Return Value void


Related Interfaces



SetLocation (WatermarkLocation location)Datalogics::WatermarkAPI::WatermarkOptions::

Return Value: void

Description This call specifies the location of the watermark relative to the page content, either on top of the page content (as an overprint) or below it (underneath the page content, like preprinted stationery).

Parameters WatermarkLocation location: Overprint setting, either AbovePage (on top) or BehindPage (below) Default AbovePage)

Return Value void


Related Interfaces



SetLocation (WatermarkLocation location)DL::WatermarkAPI::WatermarkOptions::

Return Value: void

Description This call specifies the location of the watermark relative to the page content, either on top of the page content (as an overprint) or below it (underneath the page content, like preprinted stationery).

Parameters WatermarkLocation location: Overprint setting, either AbovePage (on top) or BehindPage (below) Default AbovePage)

Return Value void


Related Interfaces



SetOpacity (float opacity)Datalogics::WatermarkAPI::WatermarkOptions::

Return Value: void

Description This call sets the opacity level of the watermark, as a percentage value ranging from 0.0 (invisible) to 100.0 (solid/opaque).

Parameters float opacity: Opacity setting, from 0.0 (invisible) to 100.0 (solid/opaque) Default 100.0)

Return Value void


Related Interfaces



SetOpacity (float opacity)DL::WatermarkAPI::WatermarkOptions::

Return Value: void

Description This call sets the opacity level of the watermark, as a percentage value ranging from 0.0 (invisible) to 100.0 (solid/opaque).

Parameters float opacity: Opacity setting, from 0.0 (invisible) to 100.0 (solid/opaque) Default 100.0)

Return Value void


Related Interfaces



SetPageRange (const DL::Framework::PageRange & range)DL::WatermarkAPI::WatermarkOptions::

Return Value: void

Description This call sets the range of pages in the target file to which the watermark will be applied.

Parameters const DL::Framework::PageRange & range: The Page Range object describing the target range

Return Value void


Related Interfaces


A . 1 0 0 DL PDF Toolkit User Guide

SetPageScalingMode (int pageScaleMode)Datalogics::Framework::PrintJob::

Return Value: void

Description This call specifies the scaling mode for the print job, to determine how oversized or undersized documents should be scaled in relation to the paper size. This set-ting will reduce oversized documents by scaling them uniformly down to the paper size; it may optionally also expand undersized documents to fill the paper.The original aspect ratio of the document will be preserved. Any excess whitespace in either direction will be evenly divided to either side, thus centering the page image on the media.

Parameters int pageScaleMode: The Page Scaling selection, either f to fit the page to the printer margins (regardless of size), or r to reduce oversized pages only (Default r)

Return Value void


Related Interfaces


DL PDF Toolkit R e f e r e n c e A p p e n d i x A . 1 0 1

SetPageScalingMode (PageScaleMode eScaleMode)DL::PrintAPI::PrintJob::

Return Value: void

Description This call specifies the scaling mode for the print job, to determine how oversized or undersized documents should be scaled in relation to the paper size. This set-ting will reduce oversized documents by scaling them uniformly down to the paper size; it may optionally also expand undersized documents to fill the paper.The original aspect ratio of the document will be preserved. Any excess whitespace in either direction will be evenly divided to either side, thus centering the page image on the media.

Parameters PageScaleMode eScaleMode: The Page Scaling selection, either ScaleToFit to fit the page to the printer margins (regardless of size), or ScaleShrinkToFit to reduce oversized pages only (Default ScaleShrink-ToFit)

Return Value void

Header PrintJob.h

Related Interfaces



SetPaperSource (String^ paperSource)Datalogics::Framework::PrintJob::

Return Value: void

Technical Notes

1 Setting a specific paper source via SetPaperSource will override the

SetPaperSourceByPageSize setting.

Description This call specifies the paper source for the print job. This is a named source on the printer, usually corresponding to a particular input tray or printer setting; e.g. "Tray 1," "Automatically Select," etc. See Technical Notes below.

Parameters String^ paperSource: Paper source string value, matching one of the avail-able choices for the selected printer (No Default)

Return Value void


Related Interfaces SetPaperSourceByPageSize



SetPaperSource (const std::wstring & paperSource)DL::PrintAPI::PrintJob::

Return Value: void

Technical Notes



Description This call specifies the paper source for the print job. This is a named source on the printer, usually corresponding to a particular input tray or printer setting; e.g. "Tray 1," "Automatically Select," etc. See Technical Notes below.

Parameters const std::wstring & paperSource: Paper source string value, matching one of the available choices for the selected printer (No Default)

Return Value void

Header PrintJob.h

Related Interfaces SetPaperSourceByPageSize



SetPaperSourceByPageSize (Boolean val)Datalogics::Framework::PrintJob::

Return Value: void

Technical Notes

1 This setting interacts with the SetPageScalingMode method.



Description This call specifies whether to enable or disable the Paper Source By Page Size option, which controls whether the PrintJob will set the printer page size based on the size of each page of the PDF document. If activated, it will select a paper size supported by the printer that is large enough to hold the page. See Technical Notes below.

Parameters Boolean val: Flag controlling the Paper Source By Page Size option, either true or false (Default false)

Return Value void


Related Interfaces SetPageScalingMode,SetPaperSource



SetPaperSourceByPageSize (int nByPageSize)DL::PrintAPI::PrintJob::

Return Value: void

Technical Notes

1 This setting interacts with the SetPageScalingMode method.



Description This call specifies whether to enable or disable the Paper Source By Page Size option, which controls whether the PrintJob will set the printer page size based on the size of each page of the PDF document. If activated, it will select a paper size supported by the printer that is large enough to hold the page. See Technical Notes below.

Parameters int nByPageSize: Flag controlling the Paper Source By Page Size option, either 1 (on) or 0 (off) (Default 0)

Return Value void

Header PrintJob.h

Related Interfaces SetPageScalingMode,SetPaperSource



SetRotation (float angle)Datalogics::WatermarkAPI::WatermarkOptions::

Return Value: void

Description This call sets the rotation of the watermark, measuring counterclockwise in degrees from hoizontal. A negative degree value will rotate the watermark clock-wise instead. Full range of valid values is from -360° to 360° (degree symbol is not required).. The watermark will be rotated about its centerpoint by default.

Parameters float angle: Desired rotation of watermark, measured counterclockwise in degrees from horizontal. (Default 0)

Return Value void


Related Interfaces



SetRotation (float angle)DL::WatermarkAPI::WatermarkOptions::

Return Value: void

Description This call sets the rotation of the watermark, measuring counterclockwise in degrees from hoizontal. A negative degree value will rotate the watermark clock-wise instead. Full range of valid values is from -360° to 360° (degree symbol is not required).. The watermark will be rotated about its centerpoint by default.

Parameters float angle: Desired rotation of watermark, measured counterclockwise in degrees from horizontal. (Default 0)

Return Value void


Related Interfaces



SetScale (float scale)Datalogics::WatermarkAPI::WatermarkOptions::

Return Value: void

Description This call sets the absolute scale of the watermark, as a percentage value between 1.0% and 6400.0%.

Parameters float scale: Desired scaling percentage of watermark, where 100.0% is original size. (Percent sign is not required.) (Default 100.0)

Return Value void


Related Interfaces



SetScale (float scale)DL::WatermarkAPI::WatermarkOptions::

Return Value: void

Description This call sets the absolute scale of the watermark, as a percentage value between 1.0% and 6400.0%.

Parameters float scale: Desired scaling percentage of watermark, where 100.0% is original size. (Percent sign is not required.) (Default 100.0)

Return Value void


Related Interfaces



SetShowWhenDisplaying (bool show)Datalogics::WatermarkAPI::WatermarkOptions::

Return Value: void

Description This call sets a flag to indicate whether the watermark should be shown when the document is being viewed (i.e. as opposed to when it is being printed). Controls for viewing and printing watermarks are separate and independent.

Parameters bool show: Watermark view setting, either true or false (Default true)

Return Value void


Related Interfaces SetShowWhenPrinting



SetShowWhenDisplaying (bool show)DL::WatermarkAPI::WatermarkOptions::

Return Value: void

Description This call sets a flag to indicate whether the watermark should be shown when the document is being viewed (i.e. as opposed to when it is being printed). Controls for viewing and printing watermarks are separate and independent.

Parameters bool show: Watermark view setting, either true or false (Default true)

Return Value void


Related Interfaces SetShowWhenPrinting



SetShowWhenPrinting (bool show)Datalogics::WatermarkAPI::WatermarkOptions::

Return Value: void

Description This call sets a flag to indicate whether the watermark should be shown when the document is being printed (i.e. as opposed to when it is being viewed). Controls for viewing and printing watermarks are separate and independent.

Parameters bool show: Watermark print setting, either true or false (Default true)

Return Value void


Related Interfaces SetShowWhenDisplaying



SetShowWhenPrinting (bool show)DL::WatermarkAPI::WatermarkOptions::

Return Value: void

Description This call sets a flag to indicate whether the watermark should be shown when the document is being printed (i.e. as opposed to when it is being viewed). Controls for viewing and printing watermarks are separate and independent.

Parameters bool show: Watermark print setting, either true or false (Default true)

Return Value void


Related Interfaces SetShowWhenDisplaying



SetSource (const std::wstring & newval)DL::Framework::CLogAppender::

Return Value: void

Description This call sets the source for this log entry.

Parameters const std::wstring &newval: New value to be set. (No Default)

Return Value void


Related Interfaces



SetSource (const std::wstring & source)DL::Framework::Log::

Return Value: void

Description This call sets the message source name for this log entry, the name that will appear in log entries.

Parameters const std::wstring &source: New value to be set. (No Default)

Return Value void

Header Log.h

Related Interfaces



SetTextSize (float size)Datalogics::WatermarkAPI::TextOptions::

Return Value: void

Description This call sets the point size of a text watermark.

Parameters float size: Point size of watermark text to be set. (Default 24)

Return Value void


Related Interfaces



SetTextSize (float size)DL::WatermarkAPI::TextOptions::

Return Value: void

Description This call sets the point size of a text watermark.

Parameters float size: Point size of watermark text to be set. (Default 24)

Return Value void


Related Interfaces



SetVerticalPosition (float distance, VerticalAlignmentMode alignment)Datalogics::WatermarkAPI::WatermarkOptions::

Return Value: void

Description This call sets the watermark’s vertical position and alignment.

Parameters • float distance: Distance from the origin, in the selected unts (Default 0.0)

• VerticalAlignmentMode alignment: Alignment position: T Top), C (Center) or B (Bottom) (Default C)

Return Value void


Related Interfaces SetHorizontalPosition



SetVerticalPosition (double distance, VerticalAlignmentMode alignment)DL::WatermarkAPI::WatermarkOptions::

Return Value: void

Description This call sets the watermark’s vertical position and alignment.

Parameters • double distance: Distance from the origin, in the selected unts (Default 0.0)

• VerticalAlignmentMode alignment: Alignment position: T Top), C (Center) or B (Bottom) (Default C)

Return Value void


Related Interfaces SetHorizontalPosition



SupportsCollation (void)Datalogics::Framework::PrintJob::

Return Value: bool

Description This call returns a Boolean value, indicating true if the selected printer supports collation. Making this call is recommended before attempting a SetColla-tionMode call.

Parameters void

Return Value bool: true if the selected printer supports collation; false if it does not.


Related Interfaces SetCollationMode



SupportsCollation (void)DL::PrintAPI::PrintJob::

Return Value: bool

Description This call returns a Boolean value, indicating true if the selected printer supports collation. Making this call is recommended before attempting a SetColla-tionMode call.

Parameters void

Return Value bool: true if the selected printer supports collation; false if it does not.

Header PrintJob.h

Related Interfaces SetCollationMode



SupportsDuplex (void)Datalogics::Framework::PrintJob::

Return Value: bool

Description This call returns a Boolean value, indicating true if the selected printer supports duplex (two-sided) printing. Making this call is recommended before attempting a SetDuplexMode call.

Parameters void

Return Value bool: true if the selected printer supports duplex printing; false if it does not.


Related Interfaces SetDuplexMode



SupportsDuplex (void)DL::PrintAPI::PrintJob::

Return Value: bool

Description This call returns a Boolean value, indicating true if the selected printer supports duplex (two-sided) printing. Making this call is recommended before attempting a SetDuplexMode call.

Parameters void

Return Value bool: true if the selected printer supports duplex printing; false if it does not.

Header PrintJob.h

Related Interfaces SetDuplexMode



Term (void)DL::PrintAPI::PrintJob::

Return Value: void

Description This call performs an orderly termination of the print job.

Parameters void

Return Value void

Header PrintJob.h

Related Interfaces



UnregisterEventLog (void)DL::Framework::CEventLogAppender::CEventLogAppender::

Return Value: bool

Description This call unregisters the event log for the process.

Parameters

Return Value bool:a Boolean value reporting success or failure


Related Interfaces



UString (const std::string & s)DL::Framework::UString::

Return Value: void

Description This call constructs a Unicode string from a narrow string. On Windows, the nar-row string is assumed to be in the current ANSI code page.

Parameters onst std::string & s: The narrow string to be converted

Return Value void

Header UString.h

Related Interfaces



WindowsError (const std::string &s="Windows Error: ")DL::Framework::WindowsError::

Return Value: void

Description This exception is thrown when there is an error returned from Windows.

Parameters const std::string &s="Windows Error: ": Error string

Return Value void


Related Interfaces



WriteToLog (int severity, std::wstring message)DL::Framework::CLogAppender::

Return Value: void

Description This call writes the indicated log message to the log, at the indicated Severity level.

Parameters • int severity: severity of the message to be processed• std::wstring message: text of the message to be processed

Return Value void


Related Interfaces



WriteToLog (int severity, std::wstring message)DL::Framework::Log::

Return Value: void



Return Value void

Header Log.h

Related Interfaces



WriteToLog (int severity, std::wstring message)DL::Framework::CFileAppender::

Return Value: void



Return Value void


Related Interfaces



WriteToLog (int severity, std::wstring message)DL::Framework::CEventLogAppender::

Return Value: void



Return Value void


Related Interfaces



WriteToLog (int severity, std::wstring message)DL::Framework::CConsoleAppender::

Return Value: void



Return Value void


Related Interfaces


Index

A

AbortPrinting A.2AddAppender A.3AddDocument A.4AdditionalInfo A.5AddPDFDocument A.6, A.7Adobe Acrobat 1.4Adobe PDF Library

Use within DL PDF Toolkit 1.2Adobe Reader 1.4ApplyToDocument A.8, A.9Arguments and Options (DLPrintAPI_cpp) 4.4

binlist 4.4collate 4.4copies 4.5duplex 4.5filelist 4.5folder 4.5paperbin 4.6printer 4.6scale 4.7source 4.7

Arguments and Options (DLWatermarkAPI_cpp) 5.5color 5.8constantsize 5.12file 5.6font 5.7fontlist 5.6horizontalorigin 5.14horizontalposition 5.13horizontalunits 5.14opacity 5.10pagefile 5.8pagefrom 5.16pagenumber 5.8pagesubset 5.16pageto 5.16rotation 5.9scale 5.11showwhendisplaying 5.11showwhenprinting 5.11size 5.7text 5.7verticalorigin 5.15verticalposition 5.14verticalunits 5.15zlocation 5.11

Arguments and Options (DLWatermarkAPI_cs) 5.21File 5.22File (Watermark Image Source) 5.24Font 5.24From (Vertical Origin) 5.28

From Horizontal Origin) 5.29Horizontal Distance 5.28Horizontal Units 5.28Keep position and size constant 5.27Location 5.26Opacity 5.26Page Number 5.25Pages from 5.23Pages to 5.23Rotation 5.25Scale relative to target page 5.26Show when displaying on screen 5.27Show when printing 5.27Size 5.24Subset 5.23Text 5.24Vertical Distance 5.27Vertical Units 5.28

B

BadInput A.10BeginPrinting A.11, A.12binlist (argument) 4.4

C

CautionsDo not abbreviate the color argument value. 5.8

CConsoleAppender A.13CEventLogAppender A.14CFileAppender A.15CLogAppender A.16CloseStream A.17collate (argument) 4.4color (DLWatermarkAPI_cpp argument) 5.4, 5.8Constant Size (DLWatermarkAPI_cs argument) 5.20constantsize (DLWatermarkAPI_cpp argument) 5.4,

5.12Conventions, Document 1.4copies (argument) 4.5CreatePageWatermark A.18, A.19CreateTextWatermark A.20, A.21

D

Datalogics Interface (DLI)Use within DL PDF Toolkit 1.2

DL PDF ToolkitHow to Use this Book 1.3

I . i i D L P D F T o o l k i t U s e r G u i d e

InstallationOverview 2.2Unpacking the SDK 2.2

Intended Audience 1.2Introduction 1.2Organization 3.2Overview 3.2What You Should Know 1.2What’s New in Previous Releases 1.5What’s New in This Release 1.4

DL PrintAPIOverview 3.2, 4.2Running the Sample Applications

DLPrintAPI_cppArguments and Options 4.4Location of Source Code 4.4Overview 4.2Usage 4.3

DLPrintAPI_csDefault Document Name 4.12File Printing 4.12

Job Queue Display 4.12Overview 4.8Sample Usage 4.8

PrintAPI_cppQuick-Reference Argument Summary 4.3

PrintAPI_csFile Removal 4.11File Selection 4.10Printer Selection 4.9

DL WatermarkAPIOverview 3.3, 5.2Running the Sample Applications

DLWatermarkAPI_cppArguments and Options 5.5Location of Source Code 5.5, 5.21Quick-Reference Argument Summary 5.4

DLWatermarkAPI_csArguments and Options 5.21

DLPrintAPI A.22dlprintapi_cpp (command) 4.3

Empty command for Usage message 4.4DLWatermarkAPI A.23

Running the Sample ApplicationsDLWatermarkAPI_cpp

Usage 5.3DLWatermarkAPI_cpp (command) 5.3dlwatermarkapi_cpp (command)

Empty command for Usage message 5.5Document Conventions 1.4duplex (argument) 4.5

E

Error (Function) A.24Execute (Function) A.25

F

file (DLWatermarkAPI_cpp argument) 5.4, 5.6File (DLWatermarkAPI_cps argument) (Watermark Im-

age Source) 5.24File (DLWatermarkAPI_cs argument) 5.22file (DLWatermarkAPI_cs argument) 5.19filelist (argument) 4.5filename(s) (argument) 4.5FindFontWithName A.26folder (argument) 4.5font (DLWatermarkAPI_cpp argument) 5.4, 5.7Font (DLWatermarkAPI_cs argument) 5.20, 5.24Font (function) A.27, A.28fontlist (DLWatermarkAPI_cpp argument) 5.4, 5.6FormatMsg A.29From (Horizontal Origin) (DLWatermarkAPI_cs

argument) 5.29From (Vertical Origin) (DLWatermarkAPI_cs

argument) 5.28

G

GetEncoding A.30GetFileName A.31GetFont A.32GetFontList A.33, A.34GetName A.35, A.36GetPage A.37, A.38GetPageCount A.39GetSource

DL::Framework::CLogAppender A.40DL::Framework::Log A.41

GetString A.42GetTextSize A.43GetType A.44, A.45

H

Horizontal Distance (DLWatermarkAPI_cs argument) 5.21, 5.28

Horizontal from (DLWatermarkAPI_cs argument) 5.21

Horizontal Units (DLWatermarkAPI_cs argument) 5.21

Horizontal Units (DLWatermarkAPI_cs field) 5.28horizontalorigin (DLWatermarkAPI_cpp

argument) 5.4, 5.14horizontalposition (DLWatermarkAPI_cpp

argument) 5.4, 5.13horizontalunits (DLWatermarkAPI_cpp

argument) 5.4, 5.14

I n d e x I . i i i

I

Instance A.46InternalError A.47IsPrintable A.48, A.49

K

Keep position and size constant (DLWatermarkAPI_cs argument) 5.27

L

Location (DLWatermarkAPI_cs argument) 5.20, 5.26Log (call) A.50

M

MakeDL::Framework::PDFDocument A.52DL::Framework::PDFLibrary A.51DL::PrintAPI::PrintJob A.53DL::WatermarkAPI::TextOptions A.55DL::WatermarkAPI::WatermarkOptions A.54

N

NotesActual contents of DL PDF Toolkit releases may

vary 2.2Argument page values are their document se-

quence numbers, not their folios 5.16, 5.23

binlist obtains a list of valid bins for selected printer 4.3

Both opacity and zlocation arguments can affect visiblity of page content through watermarks 5.10, 5.11

C++ and C# samples are not intended to be comprehensive 4.2, 4.8, 5.3, 5.18

Custom Rotation window does not allow nega-tive values 5.25

Except where specified, only first letters of com-mand-line values should be given 5.4

Generate Usage message via empty dlprintapi_cpp command 4.4

Generate Usage message via empty dlwatermarkapi_cpp command 5.5

horizontalposition and verticalposition argu-ments do not observe page boundaries 5.13

Odd/Even page values refer to their document se-quence numbers, not their folios 5.17, 5.23

Pathnames containing spaces must be contained

within double quotes 4.6, 5.6, 5.8Server name must be specified for remote

printing 4.6size argument is affected by scale argument, if

present 5.7, 5.24Some common-named API calls exist in multiple

namespaces A.1Watermark text containing spaces must be con-

tained within double quotes 5.7Watermarking process acts on the original input

file 5.6, 5.22

O

ObjectName A.56opacity (DLWatermarkAPI_cpp argument) 5.4, 5.10Opacity (DLWatermarkAPI_cs argument) 5.20, 5.26OpenStream A.57operator= A.58Options, and Arguments (DLPrintAPI_cpp) 4.4Options, and Arguments (DLWatermarkAPI_cpp) 5.5Options, and Arguments (DLWatermarkAPI_cs) 5.21

P

Page Number (DLWatermarkAPI_cs argument) 5.20, 5.25

pagefile (DLWatermarkAPI_cpp argument) 5.4, 5.8Pagefile (DLWatermarkAPI_cs argument) 5.20pagefrom (DLWatermarkAPI_cpp argument) 5.4,

5.16pagefrom (DLWatermarkAPI_cs argument) 5.20PageIndexRangeError A.59pagenumber (DLWatermarkAPI_cpp argument) 5.4,

5.8PageRange A.60Pages from (DLWatermarkAPI_cs argument) 5.23Pages To (DLWatermarkAPI_cs argument) 5.23Pages to (DLWatermarkAPI_cs argument) 5.20pagesubset (DLWatermarkAPI_cpp argument) 5.4,

5.16pageto (DLWatermarkAPI_cpp argument) 5.4, 5.16paperbin (argument) 4.6PDFDocument A.61, A.62PDFLibrary A.63PDFLibraryError A.64PDFPage A.65, A.66PermissionError A.67printer (argument) 4.6PrintJob A.68

R

readme.txt 1.4RegisterEventLog A.69rotation (DLWatermarkAPI_cpp argument) 5.4, 5.9

I . i v D L P D F T o o l k i t U s e r G u i d e

Rotation (DLWatermarkAPI_cs argument) 5.20, 5.25

S

Save A.70SaveAs A.71, A.72, A.73SaveWithPassWords A.74scale (argument) 4.7scale (DLWatermarkAPI_cpp argument) 5.4, 5.11Scale (DLWatermarkAPI_cs argument) 5.20Scale relative to target page (DLWatermarkAPI_cs

argument) 5.26SetAlignmentMode A.76, A.77SetCollationMode A.78, A.79SetColor A.80, A.81SetCopies A.82, A.83SetDuplexMode A.84, A.85SetFont A.86, A.87SetHorizontalPosition A.88, A.89SetJobName A.90, A.91SetKeepPositionConstant A.93, A.94SetLocation A.95, A.96SetOpacity A.97, A.98SetPageRange A.99SetPageScalingMode A.92, A.100, A.101SetPaperSource A.102, A.103SetPaperSourceByPageSize A.104, A.105SetRotation A.106, A.107SetScale A.108, A.109SetShowWhenDisplaying A.110, A.111SetShowWhenPrinting A.112, A.113SetSource

DL::Framework::CLogAppender A.114DL::Framework::Log A.115

SetTextSize A.116, A.117SetVerticalPosition A.118, A.119Show When Displaying (DLWatermarkAPI_cs

argument) 5.20Show when displaying on screen

(DLWatermarkAPI_cs checkbox) 5.27Show When Printing (DLWatermarkAPI_cs

argument) 5.20Show when printing (DLWatermarkAPI_cs

checkbox) 5.27showwhendisplaying (DLWatermarkAPI_cpp

argument) 5.5, 5.11showwhenprinting (DLWatermarkAPI_cpp

argument) 5.5, 5.11size (DLWatermarkAPI_cpp argument) 5.5, 5.7Size (DLWatermarkAPI_cs argument) 5.20, 5.24source (argument) 4.7Subset (DLWatermarkAPI_cs argument) 5.20, 5.23SupportsCollation A.120, A.121SupportsDuplex A.122, A.123

T

Term A.124text (DLWatermarkAPI_cpp argument) 5.5, 5.7Text (DLWatermarkAPI_cs argument) 5.20, 5.24

U

UnregisterEventLog A.125UString A.126

V

Vertical Distance (DLWatermarkAPI_cs argument) 5.21, 5.27

Vertical from (DLWatermarkAPI_cpp argument) 5.21Vertical Units (DLWatermarkAPI_cs argument) 5.21Vertical Units (DLWatermarkAPI_cs field) 5.28verticalorigin (DLWatermarkAPI_cpp argument) 5.5,

5.15verticalposition (DLWatermarkAPI_cpp

argument) 5.5, 5.14verticalunits (DLWatermarkAPI_cpp argument) 5.5,

5.15

W

What’s New in Previous Releases 1.5Initial Release of DL PDF Toolkit 1.5Overview 1.5

What’s New in This Release 1.4Overview 1.4Release of DL PDF Toolkit v1.0 1.4

Windows Explorer 5.22Windows Installer 2.3WindowsError A.127WriteToLog

DL::Framework::CConsoleAppender A.132DL::Framework::CEventLogAppender A.131DL::Framework::CFileAppender A.130DL::Framework::CLogAppender A.128DL::Framework::Log A.129

Z

zlocation (DLWatermarkAPI_cpp argument) 5.5, 5.11

Documents

DL PDF Toolkit User Guide - Datalogics · 2019-12-02 · 1.2 DL PDF Toolkit User Guide An Introduction to DL PDF Toolkit Datalogics DL PDF Toolkit is a framework of basic common Application