ImgFrame_GetProperties¶
Return the properties of an image frame.
ImgFrame_GetProperties(imgDocRef{; frameIdx}) ➔ frameProps
| imgDocRef | Text | The image document reference. |
| frameIdx | Longint | The index of the image frame. |
| frameProps | Object | The image frame properties. |
Return the frame-level properties of an image frame.
Parameter imgDocRef is the image document reference. This method works with both raster
images and PDF documents.
Parameter frameIdx is the index of the image frame. Passing 0 or omitting this
parameter is the same as passing 1.
The image frame properties are returned in the frameProps 4D object.
The contents of frameProps may very depending on the image format and on the
specific image. Some common properties are listed in the following tables:
| Property name | Type | Description |
|---|---|---|
BitsPerChannel |
Longint |
The number of bits used to represent each color channel of the raster frame. |
HasAlpha |
Boolean |
Set to True if the raster frame pixels contain an alpha channel, False otherwise. |
IsIndexed |
Boolean |
Set to True if the raster frame pixels are index-based, False otherwise. |
ProfileName |
String |
The name of the color profile of the raster frame. |
ColorModel |
String |
The name of the color moder of the raster frame. Can be one of:
Gray, RGB, CMYK, and Lab. |
| Property name | Type | Description |
|---|---|---|
MediaBox |
RectObj |
The MadiaBox of the PDF page. |
CropBox |
RectObj |
The CropBox of the PDF page. |
Note
This method is a convenience wrapper for the ImgFrame_GetProperties_JSN
plug-in method.
