Document Object Model - SnippetFrame

A frame containing another CHILI document / snippet.

Fields

Name	Type	Triggers	Description
clippingPath	Paths		Applied clipping path
pageNum	int	SelectionContentChanged	Placed page number
numPages	int		amount of pages in the placed snippet document
hasClippingPath	bool		Is a clipping path applied?
hasContent	bool		If true, the frame contains a snippet
path	string		snippet path
previewURL	string		Preview URL for snippet (filled by editor, purely for display/reporting. Setting this property has no effect)
realWidthPixels	int		Real snippet document width (regardless of scaling), in pixels
realHeightPixels	int		Real snippet document height (regardless of scaling), in pixels
realResolution	number		Not applicable for snippet frames
realWidth	number		Real snippet document width (regardless of scaling)
realHeight	number		Real snippet document height (regardless of scaling)
fitMode	SnippetFitMode	SelectionContentChanged	Fit mode
fitPoint	ImageFitPoint	SelectionContentChanged	Fit point, when applicable for fit mode
imgX	unit	SelectionContentChanged	Placed X coordinate
imgY	unit	SelectionContentChanged	Placed Y coordinate
imgWidth	unit	SelectionContentChanged	Placed width
imgHeight	unit	SelectionContentChanged	Placed height
imgRotation	number	SelectionContentChanged	Placed rotation
clipX	unit		Clip X
clipY	unit		Clip Y
clipWidth	unit		Clip width
clipHeight	unit		Clip height
externalID	string		Placed document ID
externalDirID	string		Directory ID (display only, not filled for CHILI Resources)
externalName	string		Placed document name
layoutID	string		Placed AlternateLayout ID
layoutName	string		Placed Alternate Layout name
snippetDocXML	string		Placed (and potentially modified, in case of inline save) snippet document XML
snippetDocID	string		Places snippet document ID
placeAsFrames	bool		Convert the snippet frame to frames after place
boxes	ImageFrameBoxes		Available boxes
box	ImageFrameBox		Applied box
boxLeft	bool		Box left
boxRight	bool		Box right
boxTop	bool		Box top
boxBottom	bool		Box bottom
saveInline	bool		Snippet is saved inline?
fitSnippetPercentValue	number	SelectionContentChanged	Fit percentage
useClosestAlternateLayout	bool	FrameMoved	If true, CHILI will attempt to find the closest alternate layout in the snippet document after user's resize actions

Inherits from

> DocumentBase
> DocumentListItemBase
> Frame