StampPDF Batch Creating the Stamp File Options Block
Introduction
The options block specifies properties for the entire file. It consists of three sections: Label, Positioning, and Viewer Options.
Options block
| Type | Parameter | Required | Default | Content |
|---|---|---|---|---|
| Begin | Begin_Options | Beginning of option block | ||
| Label | Version | Version of stamp file: 2 | ||
| Positioning | TopMargin | 12 | Top margin of page in points | |
| BottomMargin | 12 | Bottom margin of page in points | ||
| LeftMargin | 8 | Left margin of page in points | ||
| RightMargin | 8 | Right margin of page in points | ||
| Viewer Options | ViewMode | Unchanged | Zoom level the file should open in | |
| OpenMode | Unchanged | Navigation mode the file should open in | ||
| End | End_Options | End of option block |
Options block parameters — detailed description
The options block begins with the Begin_Options and ends with the End_Options keywords. Each stamp file has only one options block. For example, the options block in letterstamp.txt looks like this:
| Begin_Options | Begin Options block |
| Version (2) | Stamp file format version 2 |
| TopMargin (36) | Top margin 36 points (1/2 inch) |
| BottomMargin (36) | Bottom margin 36 points (1/2 inch) |
| LeftMargin (36) | Left margin 36 points (1/2 inch) |
| RightMargin (36) | Right margin 36 points (1/2 inch) |
| ViewMode (FitPage) | Open Document to see entire page |
| OpenMode (ShowNone) | Do not show navigation pane |
| End_Options | End Options block |
Label parameter
Provides labeling information for the stamp file.
Version (required)
The stamp file format version. The Version parameter must be in the options block for the software to work. This version of StampPDF Batch uses version 2.
Positioning parameters
Specifies the default page boundary margins of the file, the area where stamping can occur. See Page boundary margins vs. stamp margins below for more information on how these margins affect stamp placement.
TopMargin (optional)
The amount of space, in points, from the top of the document to the stamping area.
Default value: 12 points.
BottomMargin (optional)
The amount of space, in points, from the bottom of the document to the stamping area.
Default value: 12 points.
LeftMargin (optional)
The amount of space, in points, from the left side of the document to the stamping area.
Default value: 8 points
RightMargin (optional)
The amount of space in points from the right side of the document to the stamping area.
Default value: 8 points.
Page boundary margins vs. stamp margins
When you specify the positioning parameters for a stamp item, you will override the page boundary margins defined in the options block for that stamp item.
In the figure below, the margins are 36 points, one half inch. The centered, diagonal stamp is centered between all four margins. The top stamp begins at the left margin and the bottom stamp ends at the right margin. Margins in the options block differ from rectangle margins for a stamp item. See Positioning parameters above for more information.
Converting inches to points
Margins are specified in points. One inch is equivalent to 72 points. The table below can help with conversions:
| Inches | Points |
|---|---|
| 0.11 | 8 |
| 0.167 | 12 |
| 0.5 | 36 |
| 0.75 | 54 |
| 1.0 | 72 |
| 1.5 | 108 |
| 2.0 | 144 |
An 8 1/2 x 11 inch page is 612 x 792 points.
Viewer option parameters
Specifies the default view and navigation modes for the file.
ViewMode (optional)
The default document zoom level. Possible values are:
- ActualSize
- FitHeight, full page height fits into the document window
- FitPage, full page fits into the document window
- FitVisible, visible page area fits into the document window
- FitWidth, full page width fits into the document window
If the ViewMode is not specified, the document retains its original setting.
OpenMode (optional)
The default navigation mode. Possible values are:
- ShowBookMarks, file bookmarks are displayed in the navigation pane
- ShowThumbNails, page thumbnails are displayed in the navigation pane
- ShowNone, the navigation pane is not displayed
If OpenMode is not specified, the document retains its original setting.