PDF

A placed PDF file.

Go to Property Listing | Method Listing

Preferences:

Hierarchy:

Superclass: Graphic

Class: PDF

Property Listing

Property	Type	Access	Description
absoluteFlip	Flip Flip.BOTH Flip.HORIZONTAL Flip.HORIZONTAL_AND_VERTICAL Flip.NONE Flip.VERTICAL	read/write	Indicates whether the PDF has been flipped independently of its parent object and, if yes, the direction in which the PDF was flipped.
absoluteHorizontalScale	Number	read/write	The horizontal scale of the PDF relative to its containing object.
absoluteRotationAngle	Number	read/write	The rotation angle of the PDF relative to its containing object. (Range: -360 to 360)
absoluteShearAngle	Number	read/write	The skewing angle of the PDF relative to its containing object. (Range: -360 to 360)
absoluteVerticalScale	Number	read/write	The vertical scale of the PDF relative to its containing object.
allowOverrides	Boolean	read/write	If true, the master page item can be overridden.
appliedObjectStyle	ObjectStyle	read/write	The object style applied to the PDF.
associatedXMLElement	XMLItem	readonly	The XML element associated with the PDF.
clippingPath	ClippingPathSettings	readonly	Clipping path settings.
cmykVectorPolicy	PlacedVectorProfilePolicy PlacedVectorProfilePolicy.HONOR_ALL_PROFILES PlacedVectorProfilePolicy.IGNORE_ALL PlacedVectorProfilePolicy.IGNORE_OUTPUT_INTENT	read/write	The color profile policy for CMYK content in a placed vector.
contentTransparencySettings	ContentTransparencySetting	readonly	Transparency settings for the content of the PDF.
fillTransparencySettings	FillTransparencySetting	readonly	Transparency settings for the fill applied to the PDF.
flip	Flip Flip.BOTH Flip.HORIZONTAL Flip.HORIZONTAL_AND_VERTICAL Flip.NONE Flip.VERTICAL	read/write	The direction in which to flip the printed image.
geometricBounds	Array of Number Array of String	read/write	The bounds of the PDF excluding the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.
graphicLayerOptions	GraphicLayerOption	readonly	Graphic layer option settings.
grayVectorPolicy	PlacedVectorProfilePolicy PlacedVectorProfilePolicy.HONOR_ALL_PROFILES PlacedVectorProfilePolicy.IGNORE_ALL PlacedVectorProfilePolicy.IGNORE_OUTPUT_INTENT	read/write	The color profile policy for grayscale content in a placed vector.
horizontalScale	Number	read/write	The horizontal scaling applied to the PDF.
id	Number	readonly	The unique ID of the PDF.
imageTypeName	String	readonly	The type of the image.
index	Number	readonly	The index of the PDF within its containing object.
itemLink	Link	readonly	The source file of the link.
label	String	read/write	A property that can be set to any string.
localDisplaySetting	DisplaySettingOptions DisplaySettingOptions.DEFAULT_VALUE DisplaySettingOptions.HIGH_QUALITY DisplaySettingOptions.OPTIMIZED DisplaySettingOptions.TYPICAL	read/write	Display performance options for the PDF.
nonprinting	Boolean	read/write	If true, the PDF does not print.
overridden	Boolean	readonly	If true, the object originated on a master spread and was overridden. If false, the object either originated on a master spread and was not overridden, or the object did not originate on a master page.
overriddenMasterPageItem	Graphic Guide Movie PageItem Sound	readonly	An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.
parent	Button GraphicLine Group Oval Polygon Rectangle State PageItem XMLElement	readonly	The parent of the PDF (a PageItem, Oval, Rectangle, Polygon, GraphicLine, State, Group, Button or XMLElement).
pdfAttributes	PDFAttribute	readonly	PDF attribute settings.
properties	Object	read/write	A property that allows setting of several properties at the same time.
rgbVectorPolicy	PlacedVectorProfilePolicy PlacedVectorProfilePolicy.HONOR_ALL_PROFILES PlacedVectorProfilePolicy.IGNORE_ALL PlacedVectorProfilePolicy.IGNORE_OUTPUT_INTENT	read/write	The color profile policy for RGB content in a placed vector.
rotationAngle	Number	read/write	The rotatation angle of the PDF. (Range: -360 to 360)
shearAngle	Number	read/write	The skewing angle applied to the PDF. (Range: -360 to 360)
strokeTransparencySettings	StrokeTransparencySetting	readonly	Transparency settings for the stroke.
textWrapPreferences	TextWrapPreference	readonly	The text wrap preference properties that define the default formatting for wrapping text around objects.
transparencySettings	TransparencySetting	readonly	Transparency settings.
verticalScale	Number	read/write	The vertical scaling applied to the PDF.
visibleBounds	Array of Number Array of String	read/write	The bounds of the PDF including the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.

Method Listing

undefined applyObjectStyle (using:ObjectStyle, [clearingOverrides:Boolean=Boolean], [clearingOverridesThroughRootObjectStyle:Boolean=Boolean])

Applies the specified object style.

Parameter	Type	Description
using	ObjectStyle	The object style to apply.
clearingOverrides	Boolean	If true, clears the PDF's existing attributes before applying the style. (Optional) (default: true)
clearingOverridesThroughRootObjectStyle	Boolean	If true, clears attributes and formatting applied to the PDF that are not defined in the object style. (Optional) (default: false)

Parameter

Type

Description

using

ObjectStyle

The object style to apply.

clearingOverrides

Boolean

If true, clears the PDF's existing attributes before applying the style. (Optional)

(default: true)

clearingOverridesThroughRootObjectStyle

Boolean

If true, clears attributes and formatting applied to the PDF that are not defined in the object style. (Optional)

(default: false)

undefined autoTag ()

Tag the object or the parent story using default tags defined in XML preference.

PageItem changeObject (reverseOrder:Boolean)

Finds objects that match the find what value and replace the objects with the change to value.

Parameter	Type	Description
reverseOrder	Boolean	If true, returns the results in reverse order. (Optional)

undefined clearObjectStyleOverrides ()

Clear overrides for object style

undefined detach ()

Detaches an overridden master page item from the master page.

PageItem duplicate (to:Array of Varies 2 Units Page Spread Layer, by:Array of Number String)

Duplicates the PDF at the specified location or offset.

Parameter	Type	Description
to	Array of 2 Units Page Spread Layer	The location of the new PDF, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
by	Array of Number Array of String	Amount by which to offset the new PDF from the original PDF's position. (Optional)

Parameter

Type

Description

Array of 2 Units

Page

Spread

Layer

The location of the new PDF, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)

Array of Number

Array of String

Amount by which to offset the new PDF from the original PDF's position. (Optional)

undefined exportFile (format:Varies ExportFormat String, to:File, [showingOptions:Boolean=Boolean], using:PDFExportPreset, versionComments:String, [forceSave:Boolean=Boolean])

Exports the object(s) to a file.

Parameter	Type	Description
format	ExportFormat ExportFormat.EPS_TYPE ExportFormat.INCOPY_CS_DOCUMENT ExportFormat.INCOPY_DOCUMENT ExportFormat.INDESIGN_INTERCHANGE ExportFormat.INDESIGN_SNIPPET ExportFormat.JPG ExportFormat.PDF_TYPE ExportFormat.RTF ExportFormat.SVG ExportFormat.SVG_COMPRESSED ExportFormat.TAGGED_TEXT ExportFormat.TEXT_TYPE ExportFormat.XML String	The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String.
to	File	The path to the export file.
showingOptions	Boolean	If true, displays the export options dialog. (Optional) (default: false)
using	PDFExportPreset	The export style. (Optional)
versionComments	String	The comment for this version. (Optional)
forceSave	Boolean	If true, forcibly saves a version. (Optional) (default: false)

String exportForWeb (to:File)

Exports the PDF for the web.

Parameter	Type	Description
to	File	The full path name of the exported file.

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

PageItem findObject (reverseOrder:Boolean)

Finds objects that match the find what value.

Parameter	Type	Description
reverseOrder	Boolean	If true, returns the results in reverse order. (Optional)

undefined fit (given:FitOptions)

Applies the specified fit option to content in a frame.

Parameter	Type	Description
given	FitOptions FitOptions.CENTER_CONTENT FitOptions.CONTENT_TO_FRAME FitOptions.FILL_PROPORTIONALLY FitOptions.FRAME_TO_CONTENT FitOptions.PROPORTIONALLY	The fit option to use.

Parameter

Type

Description

given

FitOptions

FitOptions.CENTER_CONTENT

FitOptions.CONTENT_TO_FRAME

FitOptions.FILL_PROPORTIONALLY

FitOptions.FRAME_TO_CONTENT

FitOptions.PROPORTIONALLY

The fit option to use.

undefined flipItem (given:Flip, around:Array of Varies 2 Units AnchorPoint)

Flips the PDF.

Parameter	Type	Description
given	Flip Flip.BOTH Flip.HORIZONTAL Flip.HORIZONTAL_AND_VERTICAL Flip.NONE Flip.VERTICAL	The axis around which to flip the PDF.
around	Array of 2 Units AnchorPoint AnchorPoint.BOTTOM_CENTER_ANCHOR AnchorPoint.BOTTOM_LEFT_ANCHOR AnchorPoint.BOTTOM_RIGHT_ANCHOR AnchorPoint.CENTER_ANCHOR AnchorPoint.LEFT_CENTER_ANCHOR AnchorPoint.RIGHT_CENTER_ANCHOR AnchorPoint.TOP_CENTER_ANCHOR AnchorPoint.TOP_LEFT_ANCHOR AnchorPoint.TOP_RIGHT_ANCHOR	The point around which to flip the PDF. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)

Parameter

Type

Description

given

Flip

Flip.BOTH

Flip.HORIZONTAL

Flip.HORIZONTAL_AND_VERTICAL

Flip.NONE

Flip.VERTICAL

The axis around which to flip the PDF.

around

Array of 2 Units

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

The point around which to flip the PDF. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)

PDF getElements ()

Resolves the object specifier, creating an array of object references.

undefined insertLabel (key:String, value:String)

Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	String	The key.
value	String	The value.

undefined markup (using:XMLElement)

Associates the page item with the specified XML element while preserving existing content.

Parameter	Type	Description
using	XMLElement	The XML element.

undefined move (to:Array of Varies 2 Units Page Spread Layer, by:Array of Number String)

Moves the PDF to a new location. Note: Either the 'to' or 'by' parameter is required; if both parameters are defined, only the to value is used.

Parameter	Type	Description
to	Array of 2 Units Page Spread Layer	The new location of the PDF,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
by	Array of Number Array of String	The amount (in measurement units) to move the PDF relative to its current position, in the format (x, y). (Optional)

Parameter

Type

Description

Array of 2 Units

Page

Spread

Layer

The new location of the PDF,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)

Array of Number

Array of String

The amount (in measurement units) to move the PDF relative to its current position, in the format (x, y). (Optional)

Varies override (destinationPage:Page)

Overrides a master page item and places the item on the document page as a new object.

Parameter	Type	Description
destinationPage	Page	The document page that contains the master page item to override.

Varies place (fileName:File, [showingOptions:Boolean=Boolean], withProperties:Object)

Places the file.

Parameter	Type	Description
fileName	File	The file to place
showingOptions	Boolean	Whether to display the import options dialog (Optional) (default: false)
withProperties	Object	Initial values for properties of the placed object(s) (Optional)

Parameter

Type

Description

fileName

File

The file to place

showingOptions

Boolean

Whether to display the import options dialog (Optional)

(default: false)

withProperties

Object

Initial values for properties of the placed object(s) (Optional)

undefined placeXML (using:XMLElement)

Places XML content into the specified object. Note: Replaces any existing content.

Parameter	Type	Description
using	XMLElement	The XML element whose content you want to place.

undefined redefineScaling (to:Array of Number)

Apply an item's scaling to its content if possible.

Parameter	Type	Description
to	Array of Number	The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional)

undefined remove ()

Deletes the PDF.

undefined removeOverride ()

Removes the override from a previously overridden master page item.

Varies resolve (location:Array of Varies AnchorPoint AnchorPoints 2 Reals BoundingBoxLimitss CoordinateSpacess Arrays of 2 Reals LongIntegers, in:CoordinateSpaces, [consideringRulerUnits:Boolean=Boolean])

Get the coordinates of the given location in the specified coordinate system.

Parameter	Type	Description
location	AnchorPoint AnchorPoint.BOTTOM_CENTER_ANCHOR AnchorPoint.BOTTOM_LEFT_ANCHOR AnchorPoint.BOTTOM_RIGHT_ANCHOR AnchorPoint.CENTER_ANCHOR AnchorPoint.LEFT_CENTER_ANCHOR AnchorPoint.RIGHT_CENTER_ANCHOR AnchorPoint.TOP_CENTER_ANCHOR AnchorPoint.TOP_LEFT_ANCHOR AnchorPoint.TOP_RIGHT_ANCHOR AnchorPoints AnchorPoint Array of 2 Reals BoundingBoxLimitss BoundingBoxLimits CoordinateSpacess CoordinateSpaces Array of Arrays of 2 Reals LongIntegers	The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
in	CoordinateSpaces CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.PASTEBOARD_COORDINATES	The coordinate space to use.
consideringRulerUnits	Boolean	If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false)

Parameter

Type

Description

location

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

AnchorPoints AnchorPoint

Array of 2 Reals

BoundingBoxLimitss BoundingBoxLimits

CoordinateSpacess CoordinateSpaces

Array of Arrays of 2 Reals

LongIntegers

The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.

CoordinateSpaces

CoordinateSpaces.INNER_COORDINATES

CoordinateSpaces.PARENT_COORDINATES

CoordinateSpaces.PASTEBOARD_COORDINATES

The coordinate space to use.

consideringRulerUnits

Boolean

If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional)

(default: false)

Asset store (using:Library, withProperties:Object)

Stores the object in the specified library.

Parameter	Type	Description
using	Library	The library in which to store the object.
withProperties	Object	Initial values for properties of the new PDF (Optional)

String toSource ()

Generates a string which, if executed, will return the PDF.

String toSpecifier ()

Retrieves the object specifier.

undefined transform (in:CoordinateSpaces, from:Array of Varies AnchorPoint AnchorPoints 2 Reals BoundingBoxLimitss CoordinateSpacess Arrays of 2 Reals LongIntegers, withMatrix:Array of Varies 6 Reals TransformationMatrix, replacingCurrent:Array of Varies MatrixContent enumerators MatrixContent LongInteger, [consideringRulerUnits:Boolean=Boolean])

Transform the page item.

Parameter	Type	Description
in	CoordinateSpaces CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.PASTEBOARD_COORDINATES	The coordinate space to use
from	AnchorPoint AnchorPoint.BOTTOM_CENTER_ANCHOR AnchorPoint.BOTTOM_LEFT_ANCHOR AnchorPoint.BOTTOM_RIGHT_ANCHOR AnchorPoint.CENTER_ANCHOR AnchorPoint.LEFT_CENTER_ANCHOR AnchorPoint.RIGHT_CENTER_ANCHOR AnchorPoint.TOP_CENTER_ANCHOR AnchorPoint.TOP_LEFT_ANCHOR AnchorPoint.TOP_RIGHT_ANCHOR AnchorPoints AnchorPoint Array of 2 Reals BoundingBoxLimitss BoundingBoxLimits CoordinateSpacess CoordinateSpaces Array of Arrays of 2 Reals LongIntegers	The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
withMatrix	Array of 6 Reals TransformationMatrix	Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.
replacingCurrent	Array of MatrixContent enumerators MatrixContent MatrixContent.ROTATION_VALUE MatrixContent.SCALE_VALUES MatrixContent.SHEAR_VALUE MatrixContent.TRANSLATION_VALUES LongInteger	Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional)
consideringRulerUnits	Boolean	If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false)

String transformAgain ()

Transforms the PDF using the last transformation performed on any object. Transformations include moving, rotating, shearing, scaling, and flipping.

String transformAgainIndividually ()

Transforms the PDF using the last transformation performed on any PDF. Transformations include moving, rotating, shearing, scaling, and flipping.

String transformSequenceAgain ()

Transforms the PDF using the last sequence of transform operations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.

String transformSequenceAgainIndividually ()

Transforms the PDF using the last sequence of transformations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.

TransformationMatrix transformValuesOf (in:CoordinateSpaces)

Get the transformation values of the page item.

Parameter

Type

Description

CoordinateSpaces

CoordinateSpaces.INNER_COORDINATES

CoordinateSpaces.PARENT_COORDINATES

CoordinateSpaces.PASTEBOARD_COORDINATES

The coordinate space to use