Packagecom.adobe.incopy
Classpublic class PDFGalleyExportPreference
InheritancePDFGalleyExportPreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5

Preference



Public Properties
 PropertyDefined By
  acrobatCompatibility : AcrobatCompatibility
The exported PDF document's Acrobat compatibility.
PDFGalleyExportPreference
  appliedFont : String
The name of the font.
PDFGalleyExportPreference
  changeSecurityPassword : String
Changes the open document password to the specified string.
PDFGalleyExportPreference
  disallowChanging : Boolean
If true, users cannot fill in forms, sign, extract pages, or add comments in the PDF document.
PDFGalleyExportPreference
  disallowCopying : Boolean
If true, users cannot copy and paste text, images, or other content from the PDF document.
PDFGalleyExportPreference
  disallowDocumentAssembly : Boolean
If true, users cannot insert, delete, or rotate pages in the PDF document.
PDFGalleyExportPreference
  disallowExtractionForAccessibility : Boolean
If true, users cannot extract content from the PDF document using software tools for the visually impaired.
PDFGalleyExportPreference
  disallowFormFillIn : Boolean
If true, users cannot change form fields in the PDF document.
PDFGalleyExportPreference
  disallowHiResPrinting : Boolean
If true, users cannot print high-resolution copies of the PDF document.
PDFGalleyExportPreference
  disallowNotes : Boolean
If true, users cannot add or change notes, edit text, or fill in form fields in the PDF document.
PDFGalleyExportPreference
  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.
PDFGalleyExportPreference
  disallowPrinting : Boolean
If true, users cannot print the PDF document.
PDFGalleyExportPreference
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
PDFGalleyExportPreference
  events : Events
[override] [read-only] A collection of events.
PDFGalleyExportPreference
  fontStyle : String
The name of the font style.
PDFGalleyExportPreference
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  includeAccurateLineEndings : Boolean
If true, exports line endings as they appear in the story.
PDFGalleyExportPreference
  includeAllChanges : Boolean
If true, exports all tracked changes.
PDFGalleyExportPreference
  includeAllNotes : Boolean
If true, exports both invisible and visible notes.
PDFGalleyExportPreference
  includeAllStories : Boolean
If true, exports all stories.
PDFGalleyExportPreference
  includeLineNumbers : Boolean
If true, includes the line numbers column in the exported PDF document.
PDFGalleyExportPreference
  includeNotes : Boolean
If true, includes inline notes in the exported PDF document.
PDFGalleyExportPreference
  includePageInfo : Boolean
If true, includes page information in the exported PDF document.
PDFGalleyExportPreference
  includeParagraphStyles : Boolean
If true, includes paragraph style information in the exported PDF document.
PDFGalleyExportPreference
  includeStoryInfo : Boolean
If true, includes story information including document title, author, and description in the exported PDF document.
PDFGalleyExportPreference
  includeTrackedChanges : Boolean
If true, includes tracked changes in the exported PDF document.
PDFGalleyExportPreference
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
PDFGalleyExportPreference
  leading : Number
The default amount of space as a percentage to include between two lines of text.
PDFGalleyExportPreference
  lineRange : Object
The lines to export.
PDFGalleyExportPreference
  openDocumentPassword : String
The password to enter when opening the PDF document.
PDFGalleyExportPreference
  parent : Object
[override] [read-only] The parent of the PDFGalleyExportPreference (a Application).
PDFGalleyExportPreference
  pointSize : Object
The default text size (in points).
PDFGalleyExportPreference
  properties : Object
[override] A property that allows setting of several properties at the same time.
PDFGalleyExportPreference
  showNotesBackgroundsInColor : Boolean
If true, exports inline notes in the color assigned to individuals on the project.
PDFGalleyExportPreference
  showTrackedChangesBackgroundsInColor : Boolean
If true, displays tracked changes in the colors assigned to each person who made changes.
PDFGalleyExportPreference
  storyColumns : Number
The width of columns to export.
PDFGalleyExportPreference
  subsetFontsBelow : Number
Sets the threshold for embedding complete fonts based on how many of the fonts' characters are used in the document.
PDFGalleyExportPreference
  useSecurity : Boolean
If true, activates security controls for the PDF document.
PDFGalleyExportPreference
  viewPDF : Boolean
If true, automatically opens the PDF file after exporting.
PDFGalleyExportPreference
Public Methods
 MethodDefined By
  
addEventListenerPDFGalleyExportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
PDFGalleyExportPreference
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
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.
PDFGalleyExportPreference
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
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
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
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
  
removeEventListenerPDFGalleyExportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
PDFGalleyExportPreference
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
PDFGalleyExportPreference
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
acrobatCompatibilityproperty
acrobatCompatibility:AcrobatCompatibility

Since : CS5

The exported PDF document's Acrobat compatibility.


Implementation
    public function get acrobatCompatibility():AcrobatCompatibility
    public function set acrobatCompatibility(value:AcrobatCompatibility):void
appliedFontproperty 
appliedFont:String

Since : CS5

The name of the font.


Implementation
    public function get appliedFont():String
    public function set appliedFont(value:String):void
changeSecurityPasswordproperty 
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.


Implementation
    public function get changeSecurityPassword():String
    public function set changeSecurityPassword(value:String):void
disallowChangingproperty 
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.


Implementation
    public function get disallowChanging():Boolean
    public function set disallowChanging(value:Boolean):void
disallowCopyingproperty 
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.


Implementation
    public function get disallowCopying():Boolean
    public function set disallowCopying(value:Boolean):void
disallowDocumentAssemblyproperty 
disallowDocumentAssembly:Boolean

Since : CS5

If true, users cannot insert, delete, or rotate pages in the PDF document. Valid only when use security is true.


Implementation
    public function get disallowDocumentAssembly():Boolean
    public function set disallowDocumentAssembly(value:Boolean):void
disallowExtractionForAccessibilityproperty 
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.


Implementation
    public function get disallowExtractionForAccessibility():Boolean
    public function set disallowExtractionForAccessibility(value:Boolean):void
disallowFormFillInproperty 
disallowFormFillIn:Boolean

Since : CS5

If true, users cannot change form fields in the PDF document. Valid only when use security is true.


Implementation
    public function get disallowFormFillIn():Boolean
    public function set disallowFormFillIn(value:Boolean):void
disallowHiResPrintingproperty 
disallowHiResPrinting:Boolean

Since : CS5

If true, users cannot print high-resolution copies of the PDF document. Valid only when use security is true.


Implementation
    public function get disallowHiResPrinting():Boolean
    public function set disallowHiResPrinting(value:Boolean):void
disallowNotesproperty 
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.


Implementation
    public function get disallowNotes():Boolean
    public function set disallowNotes(value:Boolean):void
disallowPlaintextMetadataproperty 
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.


Implementation
    public function get disallowPlaintextMetadata():Boolean
    public function set disallowPlaintextMetadata(value:Boolean):void
disallowPrintingproperty 
disallowPrinting:Boolean

Since : CS5

If true, users cannot print the PDF document. Valid only when use security is true.


Implementation
    public function get disallowPrinting():Boolean
    public function set disallowPrinting(value:Boolean):void
eventListenersproperty 
eventListeners:EventListeners  [read-only] [override]

Since : CS5

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only] [override]

Since : CS5

A collection of events.


Implementation
    public function get events():Events
fontStyleproperty 
fontStyle:String

Since : CS5

The name of the font style.


Implementation
    public function get fontStyle():String
    public function set fontStyle(value:String):void
includeAccurateLineEndingsproperty 
includeAccurateLineEndings:Boolean

Since : CS5

If true, exports line endings as they appear in the story.


Implementation
    public function get includeAccurateLineEndings():Boolean
    public function set includeAccurateLineEndings(value:Boolean):void
includeAllChangesproperty 
includeAllChanges:Boolean

Since : CS5

If true, exports all tracked changes. If false, exports only visible tracked changes.


Implementation
    public function get includeAllChanges():Boolean
    public function set includeAllChanges(value:Boolean):void
includeAllNotesproperty 
includeAllNotes:Boolean

Since : CS5

If true, exports both invisible and visible notes. If false, exports only visible notes.


Implementation
    public function get includeAllNotes():Boolean
    public function set includeAllNotes(value:Boolean):void
includeAllStoriesproperty 
includeAllStories:Boolean

Since : CS5

If true, exports all stories. If false, exports only the current story.


Implementation
    public function get includeAllStories():Boolean
    public function set includeAllStories(value:Boolean):void
includeLineNumbersproperty 
includeLineNumbers:Boolean

Since : CS5

If true, includes the line numbers column in the exported PDF document. Valid only when include accurate line endings is true.


Implementation
    public function get includeLineNumbers():Boolean
    public function set includeLineNumbers(value:Boolean):void
includeNotesproperty 
includeNotes:Boolean

Since : CS5

If true, includes inline notes in the exported PDF document.


Implementation
    public function get includeNotes():Boolean
    public function set includeNotes(value:Boolean):void
includePageInfoproperty 
includePageInfo:Boolean

Since : CS5

If true, includes page information in the exported PDF document.


Implementation
    public function get includePageInfo():Boolean
    public function set includePageInfo(value:Boolean):void
includeParagraphStylesproperty 
includeParagraphStyles:Boolean

Since : CS5

If true, includes paragraph style information in the exported PDF document.


Implementation
    public function get includeParagraphStyles():Boolean
    public function set includeParagraphStyles(value:Boolean):void
includeStoryInfoproperty 
includeStoryInfo:Boolean

Since : CS5

If true, includes story information including document title, author, and description in the exported PDF document.


Implementation
    public function get includeStoryInfo():Boolean
    public function set includeStoryInfo(value:Boolean):void
includeTrackedChangesproperty 
includeTrackedChanges:Boolean

Since : CS5

If true, includes tracked changes in the exported PDF document.


Implementation
    public function get includeTrackedChanges():Boolean
    public function set includeTrackedChanges(value:Boolean):void
isValidproperty 
isValid:Boolean  [read-only] [override]

Since : CS5

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
leadingproperty 
leading:Number

Since : CS5

The default amount of space as a percentage to include between two lines of text. (Range: 100 to 300)


Implementation
    public function get leading():Number
    public function set leading(value:Number):void
lineRangeproperty 
lineRange:Object

Since : CS5

The lines to export. . Can return: LineRange enumerator or String.


Implementation
    public function get lineRange():Object
    public function set lineRange(value:Object):void
openDocumentPasswordproperty 
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.


Implementation
    public function get openDocumentPassword():String
    public function set openDocumentPassword(value:String):void
parentproperty 
parent:Object  [read-only] [override]

Since : CS5

The parent of the PDFGalleyExportPreference (a Application).


Implementation
    public function get parent():Object
pointSizeproperty 
pointSize:Object

Since : CS5

The default text size (in points). (Range: 4 to 72).


Implementation
    public function get pointSize():Object
    public function set pointSize(value:Object):void
propertiesproperty 
properties:Object[override]

Since : CS5

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
showNotesBackgroundsInColorproperty 
showNotesBackgroundsInColor:Boolean

Since : CS5

If true, exports inline notes in the color assigned to individuals on the project. Valid only when include notes is true.


Implementation
    public function get showNotesBackgroundsInColor():Boolean
    public function set showNotesBackgroundsInColor(value:Boolean):void
showTrackedChangesBackgroundsInColorproperty 
showTrackedChangesBackgroundsInColor:Boolean

Since : CS5

If true, displays tracked changes in the colors assigned to each person who made changes. Valid only when include tracked changes is true.


Implementation
    public function get showTrackedChangesBackgroundsInColor():Boolean
    public function set showTrackedChangesBackgroundsInColor(value:Boolean):void
storyColumnsproperty 
storyColumns:Number

Since : CS5

The width of columns to export. Valid only when include accurate line endings is true.


Implementation
    public function get storyColumns():Number
    public function set storyColumns(value:Number):void
subsetFontsBelowproperty 
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).


Implementation
    public function get subsetFontsBelow():Number
    public function set subsetFontsBelow(value:Number):void
useSecurityproperty 
useSecurity:Boolean

Since : CS5

If true, activates security controls for the PDF document.


Implementation
    public function get useSecurity():Boolean
    public function set useSecurity(value:Boolean):void
viewPDFproperty 
viewPDF:Boolean

Since : CS5

If true, automatically opens the PDF file after exporting.


Implementation
    public function get viewPDF():Boolean
    public function set viewPDF(value:Boolean):void
Method Detail
addEventListenerPDFGalleyExportPreference()method
public function addEventListenerPDFGalleyExportPreference(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)

Returns
EventListener
getElements()method 
override public function getElements():Object

Since : CS5

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

Returns
Object
removeEventListenerPDFGalleyExportPreference()method 
public function removeEventListenerPDFGalleyExportPreference(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)

Returns
Boolean
toSpecifier()method 
override public function toSpecifier():String

Since : CS5

Retrieves the object specifier.

Returns
String