Document Object Model - ImageFrame

A frame containing an asset (jpg, tif, pdf, ...)

Fields

Name	Type	Triggers	Description
metaData	ImageFrameMetaDataValues		Placed image metadata
clippingPath	Paths		Image's clipping path
boxes	ImageFrameBoxes		Possible image boxes
pageNum	int	SelectionContentChanged	Placed page numer
numPages	int		Pages available in placed asset
variable	Variable	ImageFrameVariableDefinitionChanged	Bound image variable
hasClippingPath	bool		Returns true if the image has a clipping path applied
box	ImageFrameBox	FrameMoved	Applied image box
boxLeft	bool	FrameMoved	Box left
boxRight	bool	FrameMoved	Box right
boxTop	bool	FrameMoved	Box Top
boxBottom	bool	FrameMoved	Box bottom
hasContent	bool		Returns true if an image is loaded
path	string		Asset path
previewURL	string		Preview URL (set by editor for debugging/reporting. Modifying this property has no effect)
realWidthPixels	int		Real width of the placed asset (regardless of scaling in frame), in pixels
realHeightPixels	int		Real height of the placed asset (regardless of scaling in frame), in pixels
realResolution	number		Real resolution of the placed asset (regardless of scaling in frame)
realWidth	number		Real width of the placed asset (regardless of scaling in frame)
realHeight	number		Real height of the placed asset (regardless of scaling in frame)
fitMode	ImageFitMode	SelectionContentChanged	Fit mode
fitPoint	ImageFitPoint	SelectionContentChanged	Fit point, when applicable for the fit mode
imgX	unit	SelectionContentChanged	Place image X position
imgY	unit	SelectionContentChanged	Placed image Y position
imgWidth	unit	SelectionContentChanged	Placed image width
imgHeight	unit	SelectionContentChanged	Place image height
imgRotation	number	SelectionContentChanged	Place image rotation
clipX	unit		Clip X
clipY	unit		Clip Y
clipWidth	unit		Clip width
clipHeight	unit		Clip height
minOutputResolution	number	FrameConstraintsChanged	If set to -1, the document's settings are used
minResizePercentage	number	FrameConstraintsChanged	If set to -1, the document's settings are used
maxResizePercentage	number	FrameConstraintsChanged	If set to -1, the document's settings are used
displayQuality	ImageDisplayQuality	FrameDisplayQualityChanged	Image display quality (all "session_XXX" values are only stored for the current editing session)
externalID	string		Placed asset ID
dynamicAssetProviderID	string
dynamicAssetProviderData	string
externalDirID	string		External Directory ID (informational only)
externalName	string		Placed asset name
outputResolution	number		Calculated output resolution (for placedAssetType = "bitmap")
hasFrameClippingPath	bool		Returns true if a frame clipping path is applied
frameClippingPath	Paths		Frame clipping path
imageFlip	ImageFlipType	SelectionContentChanged	Applied image flip type
placedAssetType	AssetType		Placed asset type ("bitmap", "vector" or "unknown")
transformationID	string		Applied image transformation ID
manualFitConstraint	ImageManualFitConstraint	FrameConstraintsChanged	Applied manual fit constraint
requestWithCredentials	bool

Functions

Called from JavaScript using editor.ExecuteFunction("object_descriptor", "FUNCTION_NAME", args...)

Name	Arguments	Returns	Description
ClearContent			Removes the currently applied asset from the Image Frame
LoadContentFromXmlString	assetXML (string)		Applies the selected asset to the Image Frame, by supplying the asset's definition XML

Inherits from

> DocumentBase
> DocumentListItemBase
> Frame