12-8 -setImageWatermark: Inserting Image Watermark

Processing

Inserts an image file as a watermark into the input PDF.

Example of commands

[Executing example commands]

Inserts mark.bmp into test.pdf as an image watermark and outputs it as out.pdf.

  • The image watermark to be inserted is specified as follows:
    • Pages to insert a watermark: Page 1, Page 4, Pages 11-13
    • Transparency: 0.8
    • Tiling status: On

[Windows]

AHPDFToolCmd80.exe -setImageWatermark -imagePath C:\test\mark.bmp -pageRange 5 -pageRangeCustom "0,3,10-12" -opacity 0.8 -tiling -d C:\test\test.pdf -o C:\sav\out.pdf

[Linux]

AHPDFToolCmd80 -setImageWatermark -imagePath /home/antenna/test/mark.bmp -pageRange 5 -pageRangeCustom "0,3,10-12" -opacity 0.8 -tiling -d /home/antenna/test/test.pdf -o /home/antenna/sav/out.pdf

Folder settings: applied

You can perform batch processing by specifying the input folder to the -d parameter and the output folder to the -o parameter.

If a folder is specified, the image file will be inserted as a watermark to the PDF files in the input folder. Note that the output file will be output to the output folder with the same name as the input file name.

Parameters

Parameter

Content

-imagePath

[Required]

Specifies the image file path to be watermarked.

Supported formats: bitmap, jpeg, png, tiff and gif

-scale <Val>

The magnification of the watermark to insert (range: 0.0 to 50.0). Can be omitted.
If you specify 0.0, it will fit into the drawing rectangle specified by -rect or -margin.
If not specified it is considered 0.0,

-rect <left> <bottom> <right> <top> [*1]

Specifies the rectangle in which the watermark will be placed (in mm). Can be omitted. Each element is specified by a distance with the bottom left as (0, 0). If not specified, it is considered the page size rectangle.

Note:
You cannot specify a value larger than right for left. You cannot specify a value greater than top for bottom. If either of these is violated, an error will occur.

[* Cannot be used with "-acrobat".]

-margin <top> <left> <bottom> <right> [*1]

Sets the margin (in mm) when placing the watermark. Can be omitted.

Each element is specified by a distance with the bottom left as (0, 0).

Note:
You cannot specify a value larger than right for left. You cannot specify a value greater than top for bottom. If either of these is violated, an error will occur.

[* Cannot be used with "-acrobat".]

-align {1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9}

Sets the watermark placement location. If not specified, place at "5: Center."

1: Top left 2: Top center 3: Top right
4: Center left 5: Center 6: Center right
7: Bottom left 8: Bottom center 9: Bottom right

If a value other than 1 to 9 is specified, an error will occur.

-zorder {1 | 2}

Sets the watermark Z-order. Can be omitted.

1: Front 2: Background

If not specified, places it in "1: Front." If a value other than 1 or 2 is specified, an error will occur.

-pageRange {0 | 1 | 2 | 3 | 4 | 5}

Sets the page range where the watermark will be inserted. Can be omitted.

0: All pages
1: First page only 2: Last page only
3: Odd numbered pages 4: Even numbered pages
5: Specified page

If not specified, inserts it into "0: All pages"
If a value other than 1 to 5 is specified, an error will occur.
If you specify 1 and -notInFirst, 2 and -notInLast, an error will occur.
If you specify -pageRange 5, -pageRangeCustom must be specified.

-pageRangeCustom <Val> [*2]

[If -pageRange 5 is specified: Setting required]

Specifies the page number or page range where you want to insert the watermark. Page number is 0 origin. Therefore, the first page is counted from "0."

If specifying multiple names, separate them with commas.
Example) -pageRangeCustom "0,2-4"
Inserted on page 1 and pages 3 to 5.

[* Cannot be used with "-acrobat" when specifying multiple ranges.]

-notInFirst

If specified, no watermark will be inserted on the first page.
If not specified, a watermark can be inserted on the first page.

If specified at the same time as -pageRange 1, an error will occur.

-notInLast

If specified, no watermark will be inserted on the last page.
If not specified, a watermark can be inserted on the last page.

If specified at the same time as -pageRange 2, an error will occur.

-notDisplay

If specified, a watermark will not be displayed.
If not specified, a watermark will be displayed.

-notPrint

If specified, the watermark will not be printed.
If not specified, the watermark will be printed.

-opacity <rate>

Sets the watermark transparency. Can be omitted.

Setting value range: 0.0 to 1.0.
0.0 is transparent, 1.0 is opaque.

If not specified, it is considered 1.0 (opaque).

-tiling [*1]

If specified, a tiling watermark will be inserted. When -rect is specified, tiling is performed within rect.
If not specified, the watermark will not be inserted by tiling.

[* Cannot be used with "-acrobat".]

-acrobat

Can be omitted.
If specified, the watermark will be added as an Acrobat-compatible watermark.
If not specified, the watermark will be addted as a unique watermark of "Antenna House PDF API."

An error occurs if this is specified simultaneously with a parameter marked [*1], or if it matches the condition [*2].

Please enter alt text.

[*1]:
An error occurs if this is specified simultaneously with "-acrobat". PDF API's unique watermark parameters.

[*2]:
An error occurs if specifying multiple ranges separated by commas with "-pageRangeCustom", and specifying it simultaneously with "-acrobat".