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

InCopy CS5.5

Class

WMF

 A placed WMF graphic. Base Class: Graphic

QuickLinks

addEventListener, autoTag, changeObject, clearTransformations, convertShape, exportForWeb, extractLabel, findObject, fit, getElements, insertLabel, place, placeXML, redefineScaling, reframe, removeEventListener, resize, resolve, toSource, toSpecifier, transform, transformValuesOf

Hierarchy

GraphicLine | Oval | PlaceGun | Polygon | Rectangle | SplineItem | State | XMLElement
Graphic
WMF
ClippingPathSettings | Event | EventListener | MutationEvent | Preference | TextWrapPreference

Properties

PropertyTypeAccessDescription
absoluteFlipFlip:
Flip.NONE
Flip.HORIZONTAL
Flip.VERTICAL
Flip.HORIZONTAL_AND_VERTICAL
Flip.BOTH
r/wIndicates whether the WMF has been flipped independently of its parent object and, if yes, the direction in which the WMF was flipped.
absoluteHorizontalScalenumber readonlyThe horizontal scale of the WMF relative to its containing object.
absoluteRotationAnglenumber readonlyThe rotation angle of the WMF relative to its containing object. (Range: -360 to 360)
absoluteShearAnglenumber readonlyThe skewing angle of the WMF relative to its containing object. (Range: -360 to 360)
absoluteVerticalScalenumber readonlyThe vertical scale of the WMF relative to its containing object.
allGraphics Array of Graphic readonlyLists all graphics contained by the WMF.
allPageItems Array of PageItem readonlyLists all page items contained by the WMF.
allowOverridesbool r/wIf true, the master page item can be overridden.
associatedXMLElementXMLItem readonlyThe XML element associated with the WMF.
bottomLeftCornerOptionCornerOptions:
CornerOptions.NONE
CornerOptions.ROUNDED_CORNER
CornerOptions.INVERSE_ROUNDED_CORNER
CornerOptions.INSET_CORNER
CornerOptions.BEVEL_CORNER
CornerOptions.FANCY_CORNER
readonlyThe shape to apply to the bottom left corner of rectangular shapes.
bottomLeftCornerRadiusMeasurement Unit (Number or String) readonlyThe radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
bottomRightCornerOptionCornerOptions:
CornerOptions.NONE
CornerOptions.ROUNDED_CORNER
CornerOptions.INVERSE_ROUNDED_CORNER
CornerOptions.INSET_CORNER
CornerOptions.BEVEL_CORNER
CornerOptions.FANCY_CORNER
readonlyThe shape to apply to the bottom right corner of rectangular shapes.
bottomRightCornerRadiusMeasurement Unit (Number or String) readonlyThe radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
clippingPathClippingPathSettings readonlyClipping path settings.
endCapEndCap:
EndCap.BUTT_END_CAP
EndCap.ROUND_END_CAP
EndCap.PROJECTING_END_CAP
readonlyThe end shape of an open path.
endJoinEndJoin:
EndJoin.MITER_END_JOIN
EndJoin.ROUND_END_JOIN
EndJoin.BEVEL_END_JOIN
readonlyThe corner join applied to the WMF.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
fillColorString
Swatch
readonlyThe swatch (color, gradient, tint, or mixed ink) applied to the fill of the WMF. . Can also accept: String.
fillTintnumber readonlyThe percent of tint to use in the WMF's fill color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
flipFlip:
Flip.NONE
Flip.HORIZONTAL
Flip.VERTICAL
Flip.HORIZONTAL_AND_VERTICAL
Flip.BOTH
r/wThe direction in which to flip the printed image.
gapColorSwatch readonlyThe swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type.
gapTintnumber readonlyThe tint as a percentage of the gap color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
geometricBounds Array of Measurement Unit (Number or String) readonlyThe bounds of the WMF 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.
gradientFillAnglenumber readonlyThe angle of a linear gradient applied to the fill of the WMF. (Range: -180 to 180)
gradientFillLengthMeasurement Unit (Number or String) readonlyThe length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the WMF.
gradientFillStart Array of Measurement Unit (Number or String) readonlyThe starting point (in page coordinates) of a gradient applied to the fill of the WMF, in the format [x, y].
gradientStrokeAnglenumber readonlyThe angle of a linear gradient applied to the stroke of the WMF. (Range: -180 to 180)
gradientStrokeLengthMeasurement Unit (Number or String) readonlyThe length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the WMF.
gradientStrokeStart Array of Measurement Unit (Number or String) readonlyThe starting point (in page coordinates) of a gradient applied to the stroke of the WMF, in the format [x, y].
horizontalScalenumber readonlyThe horizontal scaling applied to the WMF.
idnumber readonlyThe unique ID of the WMF.
indexnumber readonlyThe index of the WMF within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
itemLayerLayer readonlyThe layer that the WMF is on.
itemLinkLink readonlyThe source file of the link.
labelstring r/wA property that can be set to any string.
leftLineEndArrowHead:
ArrowHead.NONE
ArrowHead.SIMPLE_ARROW_HEAD
ArrowHead.SIMPLE_WIDE_ARROW_HEAD
ArrowHead.TRIANGLE_ARROW_HEAD
ArrowHead.TRIANGLE_WIDE_ARROW_HEAD
ArrowHead.BARBED_ARROW_HEAD
ArrowHead.CURVED_ARROW_HEAD
ArrowHead.CIRCLE_ARROW_HEAD
ArrowHead.CIRCLE_SOLID_ARROW_HEAD
ArrowHead.SQUARE_ARROW_HEAD
ArrowHead.SQUARE_SOLID_ARROW_HEAD
ArrowHead.BAR_ARROW_HEAD
readonlyThe arrowhead applied to the start of the path.
localDisplaySettingDisplaySettingOptions:
DisplaySettingOptions.HIGH_QUALITY
DisplaySettingOptions.TYPICAL
DisplaySettingOptions.OPTIMIZED
DisplaySettingOptions.DEFAULT_VALUE
readonlyDisplay performance options for the WMF.
lockedbool readonlyIf true, the WMF is locked.
miterLimitnumber (range: 1 - 500) readonlyThe limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. (default: 4)
namestring r/wThe name of the WMF.
nonprintingbool readonlyIf true, the WMF does not print.
overprintFillbool readonlyIf true, the WMF's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.
overprintGapbool readonlyIf true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.
overprintStrokebool readonlyIf true, the WMF's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.
overriddenbool readonlyIf 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.
overriddenMasterPageItemGraphic
Guide
Movie
PageItem
Sound
readonlyAn object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.
parentGraphicLine
Oval
PlaceGun
Polygon
Rectangle
SplineItem
State
XMLElement
readonlyThe parent of the WMF (a XMLElement, PlaceGun, SplineItem, Polygon, GraphicLine, Rectangle, Oval or State).
parentPagePage readonlyThe page on which this page item appears.
preferencesPreferences Preference readonlyA collection of preferences objects.
propertiesObject r/wA property that allows setting of several properties at the same time.
rightLineEndArrowHead:
ArrowHead.NONE
ArrowHead.SIMPLE_ARROW_HEAD
ArrowHead.SIMPLE_WIDE_ARROW_HEAD
ArrowHead.TRIANGLE_ARROW_HEAD
ArrowHead.TRIANGLE_WIDE_ARROW_HEAD
ArrowHead.BARBED_ARROW_HEAD
ArrowHead.CURVED_ARROW_HEAD
ArrowHead.CIRCLE_ARROW_HEAD
ArrowHead.CIRCLE_SOLID_ARROW_HEAD
ArrowHead.SQUARE_ARROW_HEAD
ArrowHead.SQUARE_SOLID_ARROW_HEAD
ArrowHead.BAR_ARROW_HEAD
readonlyThe arrowhead applied to the end of the path.
rotationAnglenumber readonlyThe rotatation angle of the WMF. (Range: -360 to 360)
shearAnglenumber readonlyThe skewing angle applied to the WMF. (Range: -360 to 360)
strokeAlignmentStrokeAlignment:
StrokeAlignment.CENTER_ALIGNMENT
StrokeAlignment.INSIDE_ALIGNMENT
StrokeAlignment.OUTSIDE_ALIGNMENT
readonlyThe stroke alignment applied to the WMF.
strokeColorString
Swatch
readonlyThe swatch (color, gradient, tint, or mixed ink) applied to the stroke of the WMF. Can also accept: String.
strokeCornerAdjustmentStrokeCornerAdjustment:
StrokeCornerAdjustment.NONE
StrokeCornerAdjustment.DASHES
StrokeCornerAdjustment.GAPS
StrokeCornerAdjustment.DASHES_AND_GAPS
readonlyThe corner adjustment applied to the WMF.
strokeDashAndGap Array of Measurement Unit (Number or String) readonlyThe dash and gap measurements that define the pattern of a custom dashed line. Define up to six values (in points) in the format [dash1, gap1, dash2, gap2, dash3, gap3].
strokeTintnumber readonlyThe percent of tint to use in object's stroke color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
strokeTypeString
StrokeStyle
readonlyThe name of the stroke style to apply. Can also accept: String.
strokeWeightMeasurement Unit (Number or String) readonlyThe weight (in points) to apply to the WMF's stroke.
textWrapPreferencesTextWrapPreference readonlyThe text wrap preference properties that define the default formatting for wrapping text around objects.
topLeftCornerOptionCornerOptions:
CornerOptions.NONE
CornerOptions.ROUNDED_CORNER
CornerOptions.INVERSE_ROUNDED_CORNER
CornerOptions.INSET_CORNER
CornerOptions.BEVEL_CORNER
CornerOptions.FANCY_CORNER
readonlyThe shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight.
topLeftCornerRadiusMeasurement Unit (Number or String) readonlyThe radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes
topRightCornerOptionCornerOptions:
CornerOptions.NONE
CornerOptions.ROUNDED_CORNER
CornerOptions.INVERSE_ROUNDED_CORNER
CornerOptions.INSET_CORNER
CornerOptions.BEVEL_CORNER
CornerOptions.FANCY_CORNER
readonlyThe shape to apply to the top right corner of rectangular shapes
topRightCornerRadiusMeasurement Unit (Number or String) readonlyThe radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
verticalScalenumber readonlyThe vertical scaling applied to the WMF.
visiblebool r/wIf true, the WMF is visible.
visibleBounds Array of Measurement Unit (Number or String) readonlyThe bounds of the WMF 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.

Class

PropertyTypeAccessDescription
AFTER_PLACEstring readonlyDispatched after a WMF is placed. This event bubbles. This event is not cancelable. (default: afterPlace)
BEFORE_PLACEstring readonlyDispatched before a WMF is placed. This event bubbles. This event is cancelable. (default: beforePlace)

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)

void autoTag ()
Tag the object or the parent story using default tags defined in XML preference.

Array of PageItem changeObject ([reverseOrder: bool])
Finds objects that match the find what value and replace the objects with the change to value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

void clearTransformations ()
Clears transformations from the WMF. Transformations include rotation, scaling, flipping, fitting, and shearing.

void convertShape (given: ConvertShapeOptions[, numberOfSides: number][, insetPercentage: number][, cornerRadius: Measurement Unit (Number or String)])
Converts the WMF to a different shape.

ParameterTypeDescription
givenConvertShapeOptions:
ConvertShapeOptions.CONVERT_TO_RECTANGLE
ConvertShapeOptions.CONVERT_TO_ROUNDED_RECTANGLE
ConvertShapeOptions.CONVERT_TO_BEVELED_RECTANGLE
ConvertShapeOptions.CONVERT_TO_INVERSE_ROUNDED_RECTANGLE
ConvertShapeOptions.CONVERT_TO_OVAL
ConvertShapeOptions.CONVERT_TO_TRIANGLE
ConvertShapeOptions.CONVERT_TO_POLYGON
ConvertShapeOptions.CONVERT_TO_LINE
ConvertShapeOptions.CONVERT_TO_STRAIGHT_LINE
ConvertShapeOptions.CONVERT_TO_OPEN_PATH
ConvertShapeOptions.CONVERT_TO_CLOSED_PATH
The WMF's new shape.
numberOfSidesnumber (range: 3 - 100)The number of sides for the resulting polygon. (Range: 3 to 100) (Optional)
insetPercentagenumber (range: 0 - 100)The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional)
cornerRadiusMeasurement Unit (Number or String) (range: 0 - 800)The corner radius of the resulting rectangle. (Optional)

Array of string exportForWeb (to: File)
Exports the WMF for the web.

ParameterTypeDescription
toFileThe full path name of the exported file.

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

Array of PageItem findObject ([reverseOrder: bool])
Finds objects that match the find what value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

void fit (given: FitOptions)
Applies the specified fit option to content in a frame.

ParameterTypeDescription
givenFitOptions:
FitOptions.CONTENT_TO_FRAME
FitOptions.CENTER_CONTENT
FitOptions.PROPORTIONALLY
FitOptions.FILL_PROPORTIONALLY
FitOptions.APPLY_FRAME_FITTING_OPTIONS
The fit option to use.

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

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

Array of any place (fileName: File[, showingOptions: bool=false][, withProperties: Object])
Places the file.

ParameterTypeDescription
fileNameFileThe file to place
showingOptionsboolWhether to display the import options dialog (Optional) (default: false)
withPropertiesObjectInitial values for properties of the placed object(s) (Optional)

void placeXML (using: XMLElement)
Places XML content into the specified object. Note: Replaces any existing content.

ParameterTypeDescription
usingXMLElementThe XML element whose content you want to place.

void redefineScaling ([to: Array of number])
Apply an item's scaling to its content if possible.

ParameterTypeDescription
to Array of numberThe scale factors to be left on the item. The default is {1.0, 1.0}. (Optional)

void reframe (in: varies, opposingCorners: Array of varies)
Move the bounding box of the page item

ParameterTypeDescription
inboundsKind:BoundingBoxLimits
CoordinateSpaces
Ordered array containing coordinateSpace:CoordinateSpaces
The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.
opposingCorners Array of any Opposing corners of new bounding box in the given coordinate space

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)

void resize (in: varies, from: varies, by: ResizeMethods, values: Array of varies[, resizeIndividually: bool=true][, consideringRulerUnits: bool=false])
Resize the page item.

ParameterTypeDescription
inBoundingBoxLimits
boundsKind:BoundingBoxLimits
CoordinateSpaces
Ordered array containing coordinateSpace:CoordinateSpaces
The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.
fromAnchorPoint
AnchorPoint
Array of 2 Reals
Array of Arrays of 2 Reals
BoundingBoxLimits
CoordinateSpaces
Long Integers
The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
byResizeMethods:
ResizeMethods.ADDING_CURRENT_DIMENSIONS_TO
ResizeMethods.MULTIPLYING_CURRENT_DIMENSIONS_BY
ResizeMethods.REPLACING_CURRENT_DIMENSIONS_WITH
How the current dimensions are affected by the given values
values Array of :
Array of Reals
CoordinateSpaces
ResizeConstraints
The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators.
resizeIndividuallyboolIf false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) (default: true)
consideringRulerUnitsboolIf 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)

any resolve (location: varies, in: CoordinateSpaces[, consideringRulerUnits: bool=false])
Get the coordinates of the given location in the specified coordinate system.

ParameterTypeDescription
locationAnchorPoint
AnchorPoint
Array of 2 Reals
Array of Arrays of 2 Reals
BoundingBoxLimits
CoordinateSpaces
Long Integers
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.
inCoordinateSpaces:
CoordinateSpaces.PASTEBOARD_COORDINATES
CoordinateSpaces.PARENT_COORDINATES
CoordinateSpaces.INNER_COORDINATES
CoordinateSpaces.SPREAD_COORDINATES
The coordinate space to use.
consideringRulerUnitsboolIf 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)

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

string toSpecifier ()
Retrieves the object specifier.

void transform (in: CoordinateSpaces, from: varies, withMatrix: varies[, replacingCurrent: varies][, consideringRulerUnits: bool=false])
Transform the page item.

ParameterTypeDescription
inCoordinateSpaces:
CoordinateSpaces.PASTEBOARD_COORDINATES
CoordinateSpaces.PARENT_COORDINATES
CoordinateSpaces.INNER_COORDINATES
CoordinateSpaces.SPREAD_COORDINATES
The coordinate space to use
fromAnchorPoint
AnchorPoint
Array of 2 Reals
Array of Arrays of 2 Reals
BoundingBoxLimits
CoordinateSpaces
Long Integers
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
Long Integer
MatrixContent
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)
consideringRulerUnitsboolIf 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)

Array of TransformationMatrix transformValuesOf (in: CoordinateSpaces)
Get the transformation values of the page item.

ParameterTypeDescription
inCoordinateSpaces:
CoordinateSpaces.PASTEBOARD_COORDINATES
CoordinateSpaces.PARENT_COORDINATES
CoordinateSpaces.INNER_COORDINATES
CoordinateSpaces.SPREAD_COORDINATES
The coordinate space to use

Used in:

WMF WMFs.nextItem (obj: WMF)

WMF WMFs.previousItem (obj: WMF)

Return

Array of WMF WMF.getElements ()

WMF WMFs.[] (index: number)

WMF WMFs.anyItem ()

Array of WMF WMFs.everyItem ()

WMF WMFs.firstItem ()

WMF WMFs.item (index: varies)

WMF WMFs.itemByID (id: number)

WMF WMFs.itemByName (name: string)

Array of WMF WMFs.itemByRange (from: varies, to: varies)

WMF WMFs.lastItem ()

WMF WMFs.middleItem ()

WMF WMFs.nextItem (obj: WMF)

WMF WMFs.previousItem (obj: WMF)

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