Scripts

Scripts can be created and executed within Revu to easily manipulate PDFs and automate multi-step tasks. To learn how to create and run scripts in Revu, see Create or run scripts.

This feature is only available with a Complete or Max plan.

Use the Script Editor in Revu to create new scripts and edit existing ones. It is reached through the Script Manager, as demonstrated above.

Whether editing an existing script or creating a new one, the following components are available:

  • Name: The name of the script. Names do not need to be unique.

  • Icon: The icon used to identify a script in a Toolbar. Select Import to import your own icons, or use one of the standard icons available.

  • Commit Changes After Running Script: When enabled, the active PDF will apply the changes upon invoking the script.

    It is sometimes useful to not commit changes to the currently active PDF. For example, a script could be created that applies headers/footers, adds a cover page, flattens, and then sends an email. By not setting this property, the email will have all the script's modifications, but the active PDF will not. Therefore, you can continue working uninterrupted and your email was sent with all the necessary modifications.

  • Script: Enter the commands to be executed with this script. Multiple script commands are supported; enter one script command per line. Each script command may include a series of required and optional parameters for controlling the function.

The Script field utilizes two features to simplify entering scripts: auto-complete and tooltips.

  • Auto-complete: Press Ctrl+Space or start typing in the Script field and the auto-complete feature will pull up the list of accepted script commands. The light will highlight the function that matches the text as your type. Press Enter or double-click a command to insert it into the editor.

  • Tooltips: Hover the mouse over a command to view tooltips, including parameters and examples. The top line contains the syntax for the function with the parameter where the cursor is located highlighted in red. The paramere will also display on a line below with a description of that parameter. The tooltip will also automatically appear after you type the opening bracket of the function, or press Ctrl+Shift+Space to bring up the tooltip relevant to the cursor's current location.

While entering script parameters, pressing the TAB key will automatically insert the default parameter.

Bluebeam scripts are a series of commands that are single word identifiers followed by a comma delimited list of parameters enclosed in parentheses. For example:

SetPDFSecurity("abacadabra", 193)

There are several different types of parameters allowed in a script:

  • Bool: Boolean values (true or false)

  • Number: Either an integer or real number (1, 3.5, 0.2, etc.)

  • String: Quoted list of characters ("document.pdf"). The escape character is | .

  • Name: Unquotes list of characters containing letters and numbers only (print, view, flatten, etc.)

  • Color: A special string that represents a color that is either a color name ("black" or "red") or a hex string ("#FF0000), or an integer that contains RGB values as packed bytes where B is the lower byte.

Comments may also be added by using the "%" character. Any characters following the comment character will be ignored until a new line character is encountered.

There are commands that return and accept string dictionaries containing key/value pairs of markup properties. ClosedView the keys that are supported by those commands.

  • type: The type of markup, such as rectangle or polygon

  • page: The page index that the markup occurs on

  • author: The author of the markup

  • subject: The subject of the markup

  • comment: The comment on the markup

  • color: The color of the markup

  • colorfill: The fill color of the markup

  • colortext: The text color of the markup

  • opacity: The opacity of the markup from 0 to 1

  • opacityfill: The fill opacity of the markup from 0 to 1

  • rotation: The rotation of the markup in degrees from 0 to 360

  • parent: The markup ID of the markup's parent (needed to understand the parent/child relationship of grouped markups)

  • grouped: Boolean value indicating if the markup is grouped

  • status: The status of the markup, valid states are "Accepted", "Rejected", "Cancelled", "Completed", and "None"

  • checked: Boolean value indicating that the markup is checked or unchecked

  • locked: Boolean value indicating that the markup is locked or unlocked

  • datecreated: The creation date of the markup

  • datemodified: The modified date of the markup

  • linewidth: The width of the line in points where 72 points equals 1 inch; for most markups, the range is 0 to 12

  • linestyle: The style of the line; valid styles are "solid", "dashed1", "dashed2", "dashed3", "dashed4", "dashed5", "dashed6", "cloudy1", and "cloudy2"

  • x: The x coordinate of the markup in points where 72 points equals 1 inch

  • y: The y coordinate of the markup in points where 72 points equals 1 inch

  • width: The width of the markup in points where 72 points equals 1 inch

  • height: The height of the markup in points where 72 points equals 1 inch

  • space: The space defined in the PDF that the markup resides in (read-only)

  • layer: The layer that the markup is assigned to (read-only)

  • captureCount: The number of capture images and video attached to the markup (read-only)

Inserts blank pages into the active document to balance the total number of pages to an odd, even, specific count, or specific page division.

Parameters

  • pType [String]: Specifies how blank pages will be inserted at the end of the pdf file as follows:

    • even = Inserts one page if needed to make count even

    • odd = Inserts one page if needed to make count odd

    • n = Inserts pages to make page count divisible by n, n is a number

    • -n = Inserts pages to make page count at least n pages, n is a number

  • pWidth [String, Optional]: Width of page in inches, last means width of last page

  • pHeight [String, Optional]: Height of page in inches, last means height of last page

  • pStyle [Number, Optional]: Page Style as follows:

    • 0 = Blank

    • 1 = Notebook

    • 2 = 1/8" Grid

    • 3 = ¼" Grid

    • 4 = Engineering Grid

    • 5 = 0.5 cm Grid

    • 6 = 1 cm Grid

    • 7 = ½" Isometric Grid

    • 8 = 0.5 cm Isometric Grid

Example

BalancePages("even")
BalancePages(4, 8.5, 11, 1)

Converts page content colors to a color or gray scale.

Parameters

  • pStartColor [Color]: Start color to convert source colors to, usually darker color

  • pEndColor [Color]: End color to convert source colors to, usually lighter color

  • pScale [Bool, Optional]: Indicates that colors should be scaled from start to end

  • pProcessImages [Bool, Optional]: Images should be converted to new colors

  • pPageRange [String, Optional]: List or range of pages to be processed, -1 will process all pages, exp: 1,2,10-20

Example

ColorProcess("black", "white") % Convert to grayscale
ColorProcess("Red", "white", true, true, "10-20")

Exports the Custom Column definition of the active document to an .xml file.

Parameters

  • pFileName [String]: Filename to export the columns into

Example

ColumnsExport('columns.xml')

Imports a Custom Column definition .xml file into the active document overwriting any existing Custom Columns. An .xml file can be generated by either the command ColumnsExport or from within Bluebeam Revu.

Parameters

  • pFileName [String]: Filename of the Custom Column definition .xml file to import into the active document

Example

ColumnsImport("columns.xml")

Deletes a file from specified location.

Parameters

  • pFileName [String]: Filename to delete from the file system

Example

DeleteFile("c:\Directory\Filename.pdf")

Launches an Email window with the active document attached.

Parameters

  • pTo [String, Optional]: Email address of recipient, use ';' to delimit multiple addresses

  • pSubject [String, Optional]: Email subject

  • pBody [String, Optional]: Email body

Example

Email()
Email("support@bluebeam.com")

Embeds the sepecified JavaScript file as a document level script in the active document.

Parameters

  • pName [String]: Name of JavaScript Code

  • pFile [String]: JavaScript file to embed

Example

EmbedJavaScript("File.js")

Exports the markups in the active document to the specified output file optionally using a User ID to filter on.

Parameters

  • pOuputBAX [String, Optional]: Filename to export the markups into

  • pUserID [String, Optional]: User ID as used in bFX File Exchange to filter on when exporting markups

Example

Export("output.bax")
Export("output.bax", "12345")

Sets a file property in the active document based on the specified key and value.

Parameters

  • pKey [String]: Key of file property to set

  • pValue [String]: Desired value of file property

Example

FilePropertySet("Author", "Homer J. Simpson")

Flattens all markups on the active document to be part of the page content.

Parameters

  • pRecoverable [Bool, Optional]: Specifies whether or not the flatten process is reversible

  • pFlags [Number, Optional]: Specifies what type of markups to flatten

    • Default = 8191

    • Image = 1

    • Ellipse = 2

    • Stamp = 4

    • Snapshot = 8

    • Text and Callout = 16

    • Ink and Highlighter = 32

    • Line and Dimension = 64

    • Measure Area = 128

    • Polyline = 256

    • Polygon and Cloud = 512

    • Rectangle = 1024

    • Text Markups = 2048

    • Group = 4096

    • File Attachment = 8192

    • Flags = 16384

    • Notes = 32768

    • Form Fields = 65536

    Add together all values that should be flattened

  • pPageRange [String, Optional]: List or range of pages to be flattened, -1 will flatten all pages, exp: 1,2,10-20

  • pLayerName [String, Optional]: Layer Name to flatten markups to

Example

Flatten()
Flatten(true)
Flatten(true, 9) % Flattens Images (1) and Snapshots (8)

Exports the form data in the active document to a .xml, .csv, or .fdf file.

Parameters

  • pFileName [String]: Filename (.xml, .csv, or .fdf) to export the form data into

Example

FormExport("formdata.fdf")

Imports an FDF file containing form data into the active document.

Parameters

pFileName [String]: Filename of FDF file to import into the active document

Example

FormImport("formdata.fdf")

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]: Color of font

  • pFitToContent [Bool, Optional]: Makes content of page fit inside margins

  • pBatesOffset [Number, Optional]: Offset of the bates numbering

  • pBatesKey [String, Optional]: 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",false, 93, "1,3,5,10-20")

Imports the markups from list of files specified as parameters into the active document.

Parameters

  • pBAXorPDF [String, ...]: Filename of a bax or pdf file to import into the active document

Example

Import("markups1.bax", "markups2.bax" ...) Import("revA.pdf" ...) Import("markups1.bax", "revB.pdf" ...)

Inserts new blank pages into the active document using the specified parameters for width, height, count and style. The default count is 1 and the default style is blank.

Parameters

  • pIndex [Number]: Page Index in the active document to insert pages after, 0 is before first page.

  • pWidth [Number]: Width of page in inches

  • pHeight [Number]: Height of page in inches

  • pCount [Number, Optional]: Number of pages to insert

  • pStyle [Number, Optional]: Page Style as follows:

    • 0 = Blank

    • 1 = Notebook

    • 2 = 1/8" Grid

    • 3 = ¼" Grid

    • 4 = Engineering Grid

    • 5 = 0.5 cm Grid

    • 6 = 1 cm Grid

    • 7 = ½" Isometric Grid

    • 8 = 0.5 cm Isometric Grid

Example

InsertBlankPages(0, 8.5, 11) InsertBlankPages(2, 8.5, 11, 10, 3)

Inserts a PDF file into the active document using the specified parameters to control what additional data to be additionally imported such as bookmarks, file attachments, and file properties.

Parameters

  • pIndex [Number]: Page Index in the active document to insert pages after, 0 is before the first page

  • pFileName [String]: Filename of document to insert

  • pBookmarks [Bool, Optional]: Insert bookmarks from inserted file, default is false

  • pAttachments [Bool, Optional]: Insert file attachments from inserted file, default is false

  • pProperties [Bool, Optional]: Merge document properties from inserted file, default is false

  • pLayers [Bool, Optional]: Merge document layers from inserted file, default is false

  • pUseFileName [Bool, Optional]: User file name as Page Label, default is false

Example

InsertPages(0, "Document.pdf") InsertPages(0, "Document.pdf", true, true, true, true)

Deletes pages from the current document.

Parameters

  • pPageRange [String]: List or range of pages to delete. Cannot delete all pages. exp: 1,2,10-20

Example

PageDelete("1,2,10-20")

Extracts pages from the currently active pdf document.

Parameters

  • pPageRange [String]: List or range of pages to Extract, -1 will extract all pages, exp: 1,2,10-20

  • pFileNameOrDirectory [String]: Filename or directory to save the extracted pages to

  • pPrefix [String, Optional]: A prefix that can be appended to the filename

  • pSuffix [String, Optional]: A suffix that can be appended to the filename

Example

PageExtract("1-3", "c:\Directory\file.pdf")
PageExtract("1,5,10-20", "c:\Directory")
PageExtract("1,5,10-20", "filename.pdf")
PageExtract("1,5,10-20", "", "prefix_", "_suffix")

Sets the page labels for a range of pages.

Parameters

  • pStyle [String, Optional]: Page label style

    • Blank = None

    • D = Decimal

    • R = Roman numerals

    • A = Alphanumeric

  • pPrefix [String, Optional]: Prefix to prepend the label with

  • pStart [String, Optional]: Number to start numbering with

  • pPageRange [Number, Optional]: Page range to set page labels on

Example

PageLabelsSet("", "A101", "0", 1)

Rotates the active document pages by 90 degree increments.

Parameters

  • pRotations [Number]: Degrees to rotate pages by, must be multiple of 90

  • pPortrait [Bool, Optional]: Include portrait pages, default is true

  • pLandscape [Bool, Optional]: Include landscape pages, default is true

  • pPageRange [String, Optional]: List or range of pages to be Rotated, -1 will rotate all pages, exp: 1,2,10-20

Example

PageRotate(90)
PageRotate(-90, false, true, "10-20")

Prints the active document to a physical printer. There are only 3 syntaxes available for this function; see examples below. If advanced printing options are required, all 9 parameters must be specified.

Parameters

  • pPrinter [String, Optional]: Name of Printer

  • pPageSize [String, Optional]: Page size as it appears on Printer

  • pLandscape [Bool, Optional]: Whether to print landscape(true) or portrait(false)

  • pPageRange [String, Optional]: List or range of pages to be printed, -1 will print all pages, exp: 1,2,10-20

  • pAutoRotateAndCenter [Number, Optional]: Automatically rotated and center page content on paper.

    • -1 : Autorotate and center -90

    • 0 : No autorotate and center

    • 1 : Autorotate and center 90

  • pScaleType [Number, Optional]: Specifies how to scale when printing according to the following:

    • 0 = None

    • 1 = Fit to Paper

    • 2 = Shrink large Images

    • 3 = Custom

  • pCustomScale [Number, Optional]: If scale type is set to custom, this is the custom scale value (e.g. 0.5 would be 50%)

  • pDim [Bool, Optional]: Specifies whether to dim the content when printing

  • pCopies [Number, Optional]: Number of copies to print

Example

Print()
Print("HP Laserjet")
Print("HP Laserjet", "letter", false, "1-3", true, 1, 1, false, 1)

Prints the active document to a file. There are only 3 syntaxes available for this function, see examples below. If advanced printing options are required, all 10 parameters must be specified.

Parameters

  • pFileName [String]: File to print output to

  • pPrinter [String, Optional]: Name of Printer

  • pPageSize [String, Optional]: Page size as it appears on Printer

  • pLandscape [Bool, Optional]: Whether to print landscape(true) or portrait(false)

  • pPageRange [String, Optional]: List or range of pages to be printed, -1 will print all pages, exp: 1,2,10-20

  • pAutoRotateAndCenter [Number, Optional]: Automatically rotated and center page content on paper.

    • -1 : Autorotate and center -90

    • 0 : No autorotate and center

    • 1 : Autorotate and center 90

  • pScaleType [Number, Optional]: Specifies how to scale when printing according to the following:

    • 0 = None

    • 1 = Fit to Paper

    • 2 = Shrink large Images

    • 3 = Custom

  • pCustomScale [Number, Optional]: If scale type is set to custom, this is the custom scale value (e.g. 0.5 would be 50%)

  • pDim [Bool, Optional]: Specifies whether to dim the content when printing

  • pCopies [Number, Optional]: Number of copies to print

Example

PrintToFile("out.prn")
PrintToFile("out.prn", "HP Laserjet")
PrintToFile("out.prn", "HP Laserjet", "letter", false, "1-3", true, 1, 1, false, 1)

Takes the active document and reduces file size.

Parameters

  • pReduceImageLevel [String, Optional]: Specifies the compression ratio. Possible values are Low, Medium and High, the default is Low.

  • pImageDPI [Number, Optional]: Specifies the Image's maximum DPI, the default is 150.

  • pDropFonts [Bool, Optional]: Specifies if Fonts will be dropped or not, the default is true.

  • pDropMiscellaneous [Bool, Optional]: Specifies if Metadata, Thumbnails, Private Data, Unused Resources will be dropped or not, the default is true.

  • pCompressAllStreams [Bool, Optional]: Compress All Streams, the default is true.

Example

ReduceFileSize()
ReduceFileSize("High", 150, true, true, true)

Runs a repair process on the active document using the specified options.

Parameters

  • pFixStripedImages [Bool]: Groups neighboring image stripes into a single image

  • pCombineStripedImages [Bool]: Attemps to merge groups of thin adjacent images into one image

  • pOptimizeSolidColorImages [Bool]: Converts single color images into vector rectangles

  • pProcessMasks [Bool]: Fixes AutoCAD files with Blend Modes and Masks

  • pRemoveTextClipping [Bool]: Fixes AutoCAD files with text clipping problems

  • pSimplifyClippingPaths [Bool]: Fixes Revit files with text clipping problems

  • pRepairFontIssues [Bool]: Fixes issues with fonts

  • pRepairPageContent [Bool]: Removes invalid and empty page content objects - fixes issues flattening some files

Example

Repair(true, true, true, true, true, true, true, true)

Replaces pages in the current document with pages from the source document.

Parameters

  • pSourceFileName [String]: PDF document to get pages from

  • pSourcePages [String]: List or range of all source pages to use, -1 will use all pages, exp: 1,2,10-20

  • pPagesToReplace [String]: List or range of pages to replace, -1 will replace all pages, exp: 1,2,10-20

  • pContentOnly [Bool, Optional]: If true only the page content witll be replaced leaving markups and hyperlinks

Example

ReplacePages("c:\Directory\test.pdf", "1", "1")
ReplacePages("c:\Directory\test.pdf", "3,6", "4,7", true)

Reverses all pages in the document.

Parameters

None

Launches the Save As window

Parameters

  • pExt [String, Optional]: File extension ("pdf", "txt", "jpeg", "gif", "bmp", "png", "tiff", "docx", "doc", "rtf", "html", "xlsx", "xls", or "pptx")

Example

SaveAs("tiff")

Applies security permissions to the active document.

Parameters

  • pPermissionPassword [String]: Password to lock pdf permissions

  • pFlags [Number]: Specifies what permission are allowed

    • Print = 1

    • PrintLowOnly = 2

    • FillForms = 4

    • .EditMarkups = 8

    • EditDocument = 16

    • PageManipulation = 32

    • CopyContent = 64

    • Accessibility = 128

    Add together values to set permissions

  • pOpenPassword [String, Optional]: Password used to open the pdf file

  • pEncryptionLevel [String, Optional]: Encryption Level to use. Values can be RC4, AES128 or AES256.

Example

SetPDFSecurity("master", 1)
SetPDFSecurity("master", 13, "open")

Extracts all pages in page range to individual files.

Parameters

  • pPageRange [String]: List or range of pages to Extract, -1 will extract all pages, exp: 1,2,10-20

  • pDirectory [String]: Directory to save the extracted pages to

  • pUsePageLabels [Bool, Optional]: Use page labels to name extracted pages as pdf files.

  • pPageFormat [String, Optional]: Format to number files names for multiple pages, if pUsePageLables is true then this parameter will be ignored

Example

SplitPages("-1", "c:\Directory")
SplitPages("1,5,10", "c:\Directory", true )
SplitPages("1,5,10-20", "c:\Directory", false, " Page 001")

Places a stamp on the active document using the specified parameters.

Parameters

  • pFileName [String]: Filename of Stamp pOrigin [String]: Origin of where to place the stamp as follows:

    • "upperleft"

    • "upperright"

    • "lowerleft"

    • "lowerright"

    • "center"

    • "uppercenter"

    • "lowercenter"

  • pXOffset [Number]: X Offset from origin in inches

  • pYOffset [Number]: Y Offset from origin in inches

  • pRotation [Number, Optional]: Rotation in Degrees

  • pScale [Number, Optional]: Scale (e.g. 0.5 would be 50%)

  • pOpacity [Number, Optional]: Opacity (0.4 would be 40% opacity)

  • pBlendMode [String, Optional]: Blend Mode as follows:

    • "normal"

    • "multiply"

    • "screen"

    • "overlay"

    • "darken"

    • "lighten"

    • "colordodge"

    • "colorburn"

    • "hardlight"

    • "softlight"

    • "difference"

    • "exclusion"

    • "luminosity"

    • "hue"

    • "saturation"

    • "color"

  • pPageRange [String, Optional]: List or range of pages to be stamped, -1 will stamp all pages, exp: 1,2,10-20

  • pLocked [Bool, Optional]: Specifies whether or not the stamp should be locked

Example

Stamp("mystamp.brx", "lowerright", 0.5, 1.0, 0, 1, 1, "normal")

Exports the State Models definition of the active document to an .xml file.

Parameters

  • pFileName [String]: Filename to export the state models into

Example

StateModelsExport('states.xml')

Imports a State Model definition .xml file overwriting any existing State Models. An .xml file can be generated by the command StateModelsExport.

Parameters

  • pFileName [String]: Filename of the State Model definition .xml file to import into the active document

Example

StateModelsImport("states.xml")

Creates a thumbnail of given width and height and saves it to the specified filename. Can have an extension of most common image formats including (.bmp, .png, .jpg ...)

Parameters

  • pWidth [Number]: Desired width in pixels of output thumbnail image

  • pHeight [Number]: Desired height in pixels of output thumbnail image

  • pFileName [String]: Filename of desired output thumbnail image.

  • pPageFormat [String, Optional]: Suffix used when generatating thumbnails for multiple pages. " Page 001" would cause the resulting files to be named "File Page 001.png", "File Page 002.png" ...

  • pPageRange [String, Optional]: List or range of pages to have thumbnails generated for, -1 will generate thumbnails for all pages, exp: 1,2,10-20

  • pShowPopups [Bool, Optional]: Indicates that popups should be included

Example

thumbnail(320, 200, "thumbnail.png")

Reverses the flattening process on the active document.

Parameters

  • pPageRange [String, Optional]: List or range of pages to unflatten, -1 will unflatten all pages, exp: 1,2,10-20

Example

Unflatten()

Unlocks the current PDF/A-1b document for editing.

Parameters

None

Example

UnlockPDFA()

Related topics

Document menu