Adobe InCopy CS5.5 (7.5) Object Model JS: FrameFittingOption

InCopy CS5.5

Class

FrameFittingOption

 Options for fitting placed or pasted content in a frame. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document | Oval | Polygon | Rectangle
Preference
FrameFittingOption
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
autoFitbool r/wIf true, the last saved fitting options will be applied to the contents of a frame when it is resized.
bottomCropMeasurement Unit (Number or String) r/wThe amount in measurement units to crop the bottom edge of a graphic.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
fittingAlignmentAnchorPoint:
AnchorPoint.TOP_LEFT_ANCHOR
AnchorPoint.TOP_CENTER_ANCHOR
AnchorPoint.TOP_RIGHT_ANCHOR
AnchorPoint.LEFT_CENTER_ANCHOR
AnchorPoint.CENTER_ANCHOR
AnchorPoint.RIGHT_CENTER_ANCHOR
AnchorPoint.BOTTOM_LEFT_ANCHOR
AnchorPoint.BOTTOM_CENTER_ANCHOR
AnchorPoint.BOTTOM_RIGHT_ANCHOR
r/wThe point with which to align the image empty when fitting in a frame. For information, see frame fitting options.
fittingOnEmptyFrameEmptyFrameFittingOptions:
EmptyFrameFittingOptions.NONE
EmptyFrameFittingOptions.CONTENT_TO_FRAME
EmptyFrameFittingOptions.PROPORTIONALLY
EmptyFrameFittingOptions.FILL_PROPORTIONALLY
r/wThe frame fitting option to apply to placed or pasted content if the frame is empty. Can be applied to a frame, object style, or document or to the application.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
leftCropMeasurement Unit (Number or String) r/wThe amount in measurement units to crop the left edge of a graphic.
parentApplication
Document
Oval
Polygon
Rectangle
readonlyThe parent of the FrameFittingOption (a Oval, Rectangle, Polygon, Application or Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
rightCropMeasurement Unit (Number or String) r/wThe amount in measurement units to crop the right edge of a graphic.
topCropMeasurement Unit (Number or String) r/wThe amount in measurement units to crop the top edge of a graphic.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Array of FrameFittingOption getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the FrameFittingOption.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.frameFittingOptions

Document.frameFittingOptions

Oval.frameFittingOptions

Polygon.frameFittingOptions

Rectangle.frameFittingOptions

Return

Array of FrameFittingOption FrameFittingOption.getElements ()

Jongware, 29-Apr-2012 v3.0.3iContents :: Index