ImageFrame
This table lists the use, (default) values, and description of the attributes of the image frame element.
| Attribute | Use | Values (default value in bold) | Description |
|---|---|---|---|
| Width | Required | The width of the graphic frame in the specified units. | |
| Height | Required | The height of the graphic frame in the specified units. | |
| X | Required | The horizontal position of the center point of the graphic frame with reference to the left corner point of the page in the specified units. | |
| Y | Required | The vertical position center point of the graphic frame with reference to the left corner point of the page in the specified units. | |
| Stroke | Implied | The stroke color in swatch or #rrggbb or CMYK: c=0;m=100;y=100;k=0;Value of "None" means no stroke. If a swatch is used and the swatch does not exist in the master document, it will be created using default color values. | |
| StrokeThickness | Implied | [0,282.222] | The stroke weight in mm. |
| StrokeType | Implied | SolidThickThickThickThinThickThinThickThinThickThinThickThinThinThinTriple_StrokeCanned Dashed 3x2Canned Dashed 4x4Left Slant HashRight Slant HashStraight HashCanned DottedWavyWhite DiamondJapanese Dots| Dashed | The stroke type. |
| Z-Index | Required | Stacking order of the graphic frame, value is a positive number.The value type is a positive integer. | |
| Background | Implied | Background color in swatch or "#rrggbb" or cmyk "c=0;m=100;y=100;k=0;". Value of "None" mean no stroke. If a swatch is used and the swatch does not exist in the master document, it will be created using default color values. | |
| LayerName | Required | The name of the layer where the graphic frame is put on. If the layer does not exist, it is created using defaults. | |
| Rotation | Implied | The rotation angle around the center, number, in degrees. | |
| Opacity | Implied | [0,100] | The percentage of the graphic frame opacity. If the value is 0 the content and the stroke fill color of the frame become invisible. |
| Transparency | Implied | NormalMultiplyScreenOverlaySoft LightHard LightColor DodgeColor BurnDarkenLightenDifferenceExclusionHueSaturationColorLuminosityNon Zero OverprintNum Blending Modes | The transparency of the graphic frame. Sets the basic blending mode. If no value is set, the standard InDesign value is used. |
| Name | Implied | Frame label (not used for now). Only used internally by the InDesign Connector. | |
| CornerRadius | Implied | top left|top right|bottom left|bottom right[0, 282.222] | Pipeline separated list of corner radius values in the specified units in the following order left | top right | bottom left | bottom right |
| CornerType | Implied | NoneRoundedInverse RoundedInsetBevelFancy | Pipeline separated list of corner type values in the following order left | top right | bottom left | bottom right |
| SitecoreID | Required | The SitecoreID attribute is used to identify each page object (TextFrame, ImageFrame, etc) with a corresponding Sitecore item. The SitecoreID attribute contains the ID value of that specific item. Each page object item created with the InDesign Connector is related to a Sitecore item.NoteWhen using a script to create a page object (TextFrame, ImageFrame, etc), you should add the SitecoreID attribute and use a default value (e.g. ânullâ) so the InDesign Connector can identify this item. | |
| SitecoreFieldname | Implied | Only used internally.Used for dynamic image frames in IDC, the value comes from text frame field "Item Field". | |
| GroupID | Implied | Only used internally. Used for grouping page objects. | |
| RenderingID | Implied | Only used internally.ID of Xml Renderer that is used to render the image frame. | |
| SitecoreMediaID | Implied | Used internally in IDC, for static images frames. The value is the ID of the media item referenced in the "MediaLibrary Reference" field. | |
| ItemReferenceID | Implied | Only used internally.Used for dynamic image frames in IDC, the value comes from the image frame field "Item Reference". | |
| ItemReferenceDisplayName | Implied | Only used internally.Used for dynamic image frames in IDC, shows the display name of the referenced content item. | |
| CropAmount | Implied | [-3048, 3048] | ImageFrame Fitting crop amount values. Pipeline separated list of values in the following order | Top | Right | Bottom|Value in mm. |
| ReferencePoint | Implied | Top leftTop centerTop rightLeft centerCenterRight centerBottom leftBottom centerBottom right | The reference point used for alignment and fitting. |
| Scaling | Implied | NoneAsIsFit Content to FrameFit Frame to ContentCenter Content (obsolete)Fit Content ProportionallyFill Frame ProportionallyFill Frame Proportionally and Center (obsolete)Fit Content Proportionally and Center (obsolete) | Sets how images are scaled automatically. |
| HorizontalScale | Implied | Value - / +. Value of 0.8 means scale to 80%. Value of 2 means 200%. HorizontalScale and VerticalScale always need to be set both in order to use scaling. | |
| VerticalScale | Implied | Value - / +. Value of 0.8 means scale to 80%. Value of 2 means 200%. HorizontalScale and VerticalScale always need to be set both in order to use scaling. | |
| Skew | Implied | Skew angle.Value in number, in degrees. | |
| ObjectStyle | Implied | An InDesign object style can be used for formatting (effects). If the name of the Object Style used in the master is used as value of this attribute it will be applied. If the object style does not exist, it is NOT created automatically. | |
| RunScript | Implied | The full file(s) path. 3 Parameters are sent to the script.par1:documentnamepar2: XML iDpar3: InDesign GUID | |
| FillTint | Implied | [-1,100] | Percentage value for the fill color. |
| StrokeTint | Implied | [-1,100] | Percentage value for the stroke color. |
| WrapAndStrokeAttributes | Implied | See Common wrap and stroke attributes. | |
| InteractiveAttributes | See Common interactive attributes. |
If you have suggestions for improving this article, let us know!