Package | com.adobe.incopy |
Class | public class PDFLayoutExportPreference |
Inheritance | PDFLayoutExportPreference ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
acrobatCompatibility : AcrobatCompatibility
The exported PDF document's Acrobat compatibility. | PDFLayoutExportPreference | ||
changeSecurityPassword : String
Changes the open document password to the specified string. | PDFLayoutExportPreference | ||
disallowChanging : Boolean
If true, users cannot fill in forms, sign, extract pages, or add comments in the PDF document. | PDFLayoutExportPreference | ||
disallowCopying : Boolean
If true, users cannot copy and paste text, images, or other content from the PDF document. | PDFLayoutExportPreference | ||
disallowDocumentAssembly : Boolean
If true, users cannot insert, delete, or rotate pages in the PDF document. | PDFLayoutExportPreference | ||
disallowExtractionForAccessibility : Boolean
If true, users cannot extract content from the PDF document using software tools for the visually impaired. | PDFLayoutExportPreference | ||
disallowFormFillIn : Boolean
If true, users cannot change form fields in the PDF document. | PDFLayoutExportPreference | ||
disallowHiResPrinting : Boolean
If true, users cannot print high-resolution copies of the PDF document. | PDFLayoutExportPreference | ||
disallowNotes : Boolean
If true, users cannot add or change notes, edit text, or fill in form fields in the PDF document. | PDFLayoutExportPreference | ||
disallowPlaintextMetadata : Boolean
If true and acrobat compatibility is Acrobat 6 or higher, storage systems and search engines cannot access metadata stored in the PDF document. | PDFLayoutExportPreference | ||
disallowPrinting : Boolean
If true, users cannot print the PDF document. | PDFLayoutExportPreference | ||
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | PDFLayoutExportPreference | ||
events : Events [override] [read-only]
A collection of events. | PDFLayoutExportPreference | ||
exportReaderSpreads : Boolean
If true, each spread in the exported document is combined into a single page that has spread's original width. | PDFLayoutExportPreference | ||
generateThumbnails : Boolean
If true, generates thumbnail images for each page or spread. | PDFLayoutExportPreference | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
includeNotes : Boolean
If true, includes inline notes in the exported PDF document. | PDFLayoutExportPreference | ||
interactiveElementsOption : InteractiveElementsOptions
How to draw interactive elements. | PDFLayoutExportPreference | ||
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | PDFLayoutExportPreference | ||
openDocumentPassword : String
The password to enter when opening the PDF document. | PDFLayoutExportPreference | ||
optimizePDF : Boolean
If true, optimizes the exported PDF document for faster viewing in a web browser. | PDFLayoutExportPreference | ||
pageInformationMarks : Boolean
If true, adds crop marks, bleed marks, and other printer's marks to the exported PDF document. | PDFLayoutExportPreference | ||
pageRange : Object
The pages to print, specified either as an enumeration or a string. | PDFLayoutExportPreference | ||
parent : Object [override] [read-only]
The parent of the PDFLayoutExportPreference (a Application). | PDFLayoutExportPreference | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | PDFLayoutExportPreference | ||
subsetFontsBelow : Number
Sets the threshold for embedding complete fonts based on how many of the fonts' characters are used in the document. | PDFLayoutExportPreference | ||
useSecurity : Boolean
If true, activates security controls for the PDF document. | PDFLayoutExportPreference | ||
viewPDF : Boolean
If true, automatically opens the PDF file after exporting. | PDFLayoutExportPreference |
Method | Defined By | ||
---|---|---|---|
addEventListenerPDFLayoutExportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | PDFLayoutExportPreference | ||
![]() | addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Preference | |
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | getClassObjectForName(className:String):HostObject [static] This returns a "Class" object, meaning, a HostObject that can be used
to make static function calls or get static properties
| CSHostObject | |
getElements():Object [override]
Resolves the object specifier, creating an array of object references. | PDFLayoutExportPreference | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):* [static]
Implements a safe get of a static property on the host
Used by for instance, all the enum implementations. | CSHostObject | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
![]() | isDescendedFrom(clz:Class, ancClass:Class):Boolean [static] Efficiently determines whether or not one class descends from
another in inheritance hierarchy- class relationships are cached
by the ClassUtils implementation-
(uses org.as3commons lib to quickly discover class hierarchy. | CSHostObject | |
removeEventListenerPDFLayoutExportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | PDFLayoutExportPreference | ||
![]() | removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Preference | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | PDFLayoutExportPreference | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
acrobatCompatibility | property |
acrobatCompatibility:AcrobatCompatibility
Since : | CS5 |
The exported PDF document's Acrobat compatibility.
public function get acrobatCompatibility():AcrobatCompatibility
public function set acrobatCompatibility(value:AcrobatCompatibility):void
changeSecurityPassword | property |
changeSecurityPassword:String
Since : | CS5 |
Changes the open document password to the specified string. Valid only when use security is true. Note: A script can set but not get this value.
public function get changeSecurityPassword():String
public function set changeSecurityPassword(value:String):void
disallowChanging | property |
disallowChanging:Boolean
Since : | CS5 |
If true, users cannot fill in forms, sign, extract pages, or add comments in the PDF document. Valid only when use security is true.
public function get disallowChanging():Boolean
public function set disallowChanging(value:Boolean):void
disallowCopying | property |
disallowCopying:Boolean
Since : | CS5 |
If true, users cannot copy and paste text, images, or other content from the PDF document. Valid only when use security is true.
public function get disallowCopying():Boolean
public function set disallowCopying(value:Boolean):void
disallowDocumentAssembly | property |
disallowDocumentAssembly:Boolean
Since : | CS5 |
If true, users cannot insert, delete, or rotate pages in the PDF document. Valid only when use security is true.
public function get disallowDocumentAssembly():Boolean
public function set disallowDocumentAssembly(value:Boolean):void
disallowExtractionForAccessibility | property |
disallowExtractionForAccessibility:Boolean
Since : | CS5 |
If true, users cannot extract content from the PDF document using software tools for the visually impaired. Valid only when use security is true.
public function get disallowExtractionForAccessibility():Boolean
public function set disallowExtractionForAccessibility(value:Boolean):void
disallowFormFillIn | property |
disallowFormFillIn:Boolean
Since : | CS5 |
If true, users cannot change form fields in the PDF document. Valid only when use security is true.
public function get disallowFormFillIn():Boolean
public function set disallowFormFillIn(value:Boolean):void
disallowHiResPrinting | property |
disallowHiResPrinting:Boolean
Since : | CS5 |
If true, users cannot print high-resolution copies of the PDF document. Valid only when use security is true.
public function get disallowHiResPrinting():Boolean
public function set disallowHiResPrinting(value:Boolean):void
disallowNotes | property |
disallowNotes:Boolean
Since : | CS5 |
If true, users cannot add or change notes, edit text, or fill in form fields in the PDF document. Valid only when use security is true.
public function get disallowNotes():Boolean
public function set disallowNotes(value:Boolean):void
disallowPlaintextMetadata | property |
disallowPlaintextMetadata:Boolean
Since : | CS5 |
If true and acrobat compatibility is Acrobat 6 or higher, storage systems and search engines cannot access metadata stored in the PDF document. If true and acrobat compatibility is acrobat 5 or higher, users cannot copy and extract content from the document. Valid only when use security is true.
public function get disallowPlaintextMetadata():Boolean
public function set disallowPlaintextMetadata(value:Boolean):void
disallowPrinting | property |
disallowPrinting:Boolean
Since : | CS5 |
If true, users cannot print the PDF document. Valid only when use security is true.
public function get disallowPrinting():Boolean
public function set disallowPrinting(value:Boolean):void
eventListeners | property |
eventListeners:EventListeners
[read-only] [override] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] [override] Since : | CS5 |
A collection of events.
public function get events():Events
exportReaderSpreads | property |
exportReaderSpreads:Boolean
Since : | CS5 |
If true, each spread in the exported document is combined into a single page that has spread's original width.
public function get exportReaderSpreads():Boolean
public function set exportReaderSpreads(value:Boolean):void
generateThumbnails | property |
generateThumbnails:Boolean
Since : | CS5 |
If true, generates thumbnail images for each page or spread.
public function get generateThumbnails():Boolean
public function set generateThumbnails(value:Boolean):void
includeNotes | property |
includeNotes:Boolean
Since : | CS5 |
If true, includes inline notes in the exported PDF document.
public function get includeNotes():Boolean
public function set includeNotes(value:Boolean):void
interactiveElementsOption | property |
interactiveElementsOption:InteractiveElementsOptions
Since : | CS5 |
How to draw interactive elements.
public function get interactiveElementsOption():InteractiveElementsOptions
public function set interactiveElementsOption(value:InteractiveElementsOptions):void
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
openDocumentPassword | property |
openDocumentPassword:String
Since : | CS5 |
The password to enter when opening the PDF document. Valid only when use security is true. Note: A script can set but not get this value.
public function get openDocumentPassword():String
public function set openDocumentPassword(value:String):void
optimizePDF | property |
optimizePDF:Boolean
Since : | CS5 |
If true, optimizes the exported PDF document for faster viewing in a web browser. Note: Compresses text and line art, regardless of specified compression settings.
public function get optimizePDF():Boolean
public function set optimizePDF(value:Boolean):void
pageInformationMarks | property |
pageInformationMarks:Boolean
Since : | CS5 |
If true, adds crop marks, bleed marks, and other printer's marks to the exported PDF document.
public function get pageInformationMarks():Boolean
public function set pageInformationMarks(value:Boolean):void
pageRange | property |
pageRange:Object
Since : | CS5 |
The pages to print, specified either as an enumeration or a string. To specify a range, separate page numbers in the string with a hyphen (-). To specify separate pages, separate page numbers in the string with a comma (,). Can return: PageRange enumerator or String.
public function get pageRange():Object
public function set pageRange(value:Object):void
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the PDFLayoutExportPreference (a Application).
public function get parent():Object
properties | property |
properties:Object
[override] Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
subsetFontsBelow | property |
subsetFontsBelow:Number
Since : | CS5 |
Sets the threshold for embedding complete fonts based on how many of the fonts' characters are used in the document. If the percentage of characters used in the document for any given font exceeds the specified value, the font is completely embedded; otherwise, the font is subsetted. (Range: 0 to 100) Notes: Embedding complete fonts increases file size. To completely embed all fonts, use 0 (zero).
public function get subsetFontsBelow():Number
public function set subsetFontsBelow(value:Number):void
useSecurity | property |
useSecurity:Boolean
Since : | CS5 |
If true, activates security controls for the PDF document.
public function get useSecurity():Boolean
public function set useSecurity(value:Boolean):void
viewPDF | property |
viewPDF:Boolean
Since : | CS5 |
If true, automatically opens the PDF file after exporting.
public function get viewPDF():Boolean
public function set viewPDF(value:Boolean):void
addEventListenerPDFLayoutExportPreference | () | method |
public function addEventListenerPDFLayoutExportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
Adds an event listener.
Parameters
eventTypeParam:String (default = null ) — (String) The event type.
| |
handlerParam:Object (default = null ) — (Object) The event handler. Can accept: File or JavaScript Function.
| |
capturesParam:Boolean (default = false ) — (Boolean) This parameter is obsolete. (Optional)
|
EventListener |
getElements | () | method |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
removeEventListenerPDFLayoutExportPreference | () | method |
public function removeEventListenerPDFLayoutExportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
Removes the event listener.
Parameters
eventTypeParam:String (default = null ) — (String) The registered event type.
| |
handlerParam:Object (default = null ) — (Object) The registered event handler. Can accept: File or JavaScript Function.
| |
capturesParam:Boolean (default = false ) — (Boolean) This parameter is obsolete. (Optional)
|
Boolean |
toSpecifier | () | method |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |