Description
Applies headers and footers to the active document.There are many codes that can be passed in as
part of the header or footer text that will be dynamically substituted when the text is applied to the
document.
Page Index Codes
<<1>>, <<1 of n>>, <<1/n>>, <<Page 1>>, <<Page 1 of n>>
Date Codes
<<M/d>>, <<M/d/yy>>, <<M/d/yyyy>>, <<MM/dd/yy>>, <<MM/dd/yyyy>>, <<d/M/yy>>,
<<d/M/yyyy>>, <<dd/MM/yy>>, <<dd/MM/yyyy>>, <<MM/yy>>, <<MM/yyyy>>, <<ddd MMM d, yyyy>>,
<<dddd MMMM d, yyyy>>, <<MM/dd/yyyy h:mm tt>>, <<dd/MM/yyyy HH:mm>>
Bates Numbering
<<Bates Number#Digits#Start#Prefix#Suffix>>
Examples:
<<Bates Number#6#1#_Prefix#_Suffix>>, <<Bates Number#6#1>>
File Properties
Headers and Footers also support pulling file property data from the PDF, any file property key can be
used such as:
<<Title>>, <<Author>>, <<Client>> ...
These are additional special codes:
<<FileName>>, <<Path>>, <<PageLabel>>
Parameters
pTopLeft [String]: Header text for top left of page
pTopCenter [String]: Header text for top center of page
pTopRight [String]: Header text for top right of page
pBottomLeft [String]: Footer text for bottom left of page
pBottomCenter [String]: Footer text for bottom center of page
pBottomRight [String]: Footer text for bottom right of page.
pMarginLeft [Number, Optional]: Left margin in points (72 points per inch)
pMarginTop [Number, Optional]: Top margin in points (72 points per inch)
pMarginRight [Number, Optional]: Right margin in points (72 points per inch)
pMarginBottom [Number, Optional]: Bottom margin in points (72 points per inch)
pFont [String, Optional]: Name of font to use with header and footer
pSize [Number, Optional]: Size of font
pBold [Bool, Optional]: Emboldens font
pItalic [Bool, Optional]: Italicizes font
pUnderline [Bool, Optional]: Underlines text
pColor [Color, Optional]: Font color
pFitToContent [Bool, Optional]: Make content of page fit inside margins
pBatesOffset [Number, Optional]: The offset of the bates numbering
pBatesKey [String, Optional]: The unique key used to persistantly store the last used Bates offset. Use this
key to ensure that
every bates number will be uniqiue across documents.
pPageRange [String, Optional]: List or range of pages to apply the header and footer to, -1 will apply to
all pages, exp: 1,2,10-20
Example
HeaderAndFooter("", "<<dddd MMMM d, yyyy>>","<<h:mm ss tt>>","<<Author>>","","<<Page 1 of n>>",
108, 28.8, 108, 48, "Blackadder ITC", 10.0, false, false, false, "Red"
Bluebeam Script Reference Version 2.0.9
© Bluebeam, Inc. All rights reserved.