Bluebeam Revu eXtreme Script Reference

[Pages:35]Bluebeam Revu eXtreme Script Reference Version 1.0.6

Bluebeam Revu eXtreme Script Reference Version 1.0.6

Bluebeam Software, Inc. Published December 29, 2014 Applies to Bluebeam Revu? eXtreme?

This document is for informational purposes only and is provided by Bluebeam Software, Inc. The accuracy of the information is not guaranteed as Bluebeam products and corresponding reference documents continually evolve to adapt to market conditions. Bluebeam makes no warranties, express or implied, as to the information in this document. No portion of this document can be reproduced, distributed, archived or transmitted in any form, by any means (electronic, mechanical, photocopying, recording, or otherwise), for any purpose, without the express written permission of Bluebeam Software, Inc. Further, Bluebeam may have patents, patent applications, copyrights, trademarks, or other intellectual property covering the subject matter included in this document. Furnishing this document does not provide any license to these patents, trademarks, copyrights or other intellectual property. Any rights must be expressly provided in a written and authorized license agreement.

? 2014 Bluebeam Software, Inc. All rights reserved. Bluebeam, Revu, Bluebeam Q, Bluebeam Pushbutton Plus, Bluebeam Lite, and Bluebeam Pushbutton PDF are either registered trademarks or trademarks of Bluebeam Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.

Introduction

3

Syntax

3

Commands

3

BalancePages

4

ColorProcess

4

ColumnsExport

4

ColumnsImport

5

DeleteFile

5

Email

5

EmbedJavaScript

6

Export

6

FilePropertySet

6

Flatten

6

FormExport

7

FormImport

7

HeaderAndFooter

7

Import

9

InsertBlankPages

9

InsertPages

9

PageDelete

10

PageExtract

10

PageRotate

10

Print

11

PrintToFile

11

ReduceFileSize

12

Repair

12

ReplacePages

13

ReversePages

13

SaveAs

13

? Bluebeam Software, Inc. All rights reserved.

Page 1

Bluebeam Revu eXtreme Script Reference Version 1.0.6

SetOpenPassword

13

SetPDFSecurity

14

SplitPages

14

Stamp

14

Thumbnail

15

Unflatten

16

? Bluebeam Software, Inc. All rights reserved.

Page 2

Bluebeam Revu eXtreme Script Reference Version 1.0.6

Introduction

Scripting is integrated into Bluebeam Revu eXtreme. Revu manages the files that the scripts will act on. Scripts can be run on the active document, or in batch mode. Revu will automatically open, save, and close the PDF files depending on the mode, and whether or not the script is set to commit changes.

A major advantage of scripting within Revu is that a script can be assigned to a toolbar button. When pushed the script is run on the active document. Some commands are only available when running Scripts from within Revu; E-mail is such a command. For example a script could be written that stamps, flattens, and launches an e-mail with the PDF attached.

Syntax

Bluebeam Scripts are a series of commands that are single word identifiers followed by a comma delimited list of parameters enclosed in paranthesis.

For example:

SetPDFSecurity("abacadabra", 193)

In this example the PDF file being processed would have PDF Security applied such that only printing and copying are allowed.

There are seveal different types in Bluebeam Script:

Bool: Boolean values (true or false) Number: Either an Integer or Real (1, 3.5, 0.2 ...) String: Quoted list of characters ("document.pdf" ...) (the escape character is |) Name: Unquoted list of characters containing lettings and numbers only. (Print, View, Flatten ...) Color: A special string that represents a Color that is either a Color name such as "Black" or "Red", or a hex string such as "#FF0000" which indicates Red, or an integer that contains the RGB values as packed bytes where B is the lowest byte.

Additionally comments may be added by using the '%' character. Any characters following the command character will be ignored until a new line character is encountered.

Commands

? Bluebeam Software, Inc. All rights reserved.

Page 3

Bluebeam Revu eXtreme Script Reference Version 1.0.6

BalancePages

Description

Inserts blank pages into 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)

ColorProcess

Description

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")

ColumnsExport

? Bluebeam Software, Inc. All rights reserved.

Page 4

Bluebeam Revu eXtreme Script Reference Version 1.0.6

Description

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')

ColumnsImport

Description

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")

DeleteFile

Description

Deletes a file from specified location.

Parameters

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

Example

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

Email

Description

Launches an E-mail window with the active document attached.

Parameters

pTo [String, Optional]: E-mail address of recipient, use ';' to delimit multiple addresses pSubject [String, Optional]: E-mail subject pBody [String, Optional]: E-mail body

Example

Email() Email("support@")

? Bluebeam Software, Inc. All rights reserved.

Page 5

Bluebeam Revu eXtreme Script Reference Version 1.0.6

EmbedJavaScript

Description

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")

Export

Description

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")

FilePropertySet

Description

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")

Flatten

Description

Takes the active document and flattens all markups 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

? Bluebeam Software, Inc. All rights reserved.

Page 6

Bluebeam Revu eXtreme Script Reference Version 1.0.6

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)

FormExport

Description

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")

FormImport

Description

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")

HeaderAndFooter

? Bluebeam Software, Inc. All rights reserved.

Page 7

Bluebeam Revu eXtreme Script Reference Version 1.0.6

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 , , , ,

Date Codes , , , , , , , , , , , , , ,

Bates Numbering

Examples: ,

File Properties Headers and Footers also support pulling file property data from the PDF, any file property key can be used such as: , , ...

These are additional special codes: , ,

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("", "","","","","", 108, 28.8, 108, 48, "Blackadder ITC", 10.0, false, false, false, "Red"

? Bluebeam Software, Inc. All rights reserved.

Page 8

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download