Foxit PDF SDK
|
Public Types | |
enum | Type { Type.e_Unknown = -1, Type.e_None = 0, Type.e_BMP = 1, Type.e_JPG = 2, Type.e_PNG = 3, Type.e_GIF = 4, Type.e_TIF = 5, Type.e_JPX = 6, Type.e_JBIG2 = 8 } |
Enumeration for image type. More... | |
Public Member Functions | |
Image () | |
Constructor. More... | |
Image (string path) | |
Constructor, from an existing image file path. More... | |
Image (global::System.IntPtr buffer, uint length) | |
Constructor, from a memory buffer. More... | |
Image (FileReaderCallback file_read) | |
Constructor, with a file read callback object. More... | |
Image (Image other) | |
Constructor, with another image object. More... | |
bool | AddFrame (System.Drawing.Bitmap bitmap) |
Add a bitmap as a frame. (Unsupported DIB formats: foxit.common.Bitmap.DIBFormat.e_DIBRgb565 and foxit.common.Bitmap.DIBFormat.e_DIB8bppMask). More... | |
bool | AddFrame (Bitmap bitmap) |
Add a bitmap as a frame. (Unsupported DIB formats: foxit.common.Bitmap.DIBFormat.e_DIBRgb565 and foxit.common.Bitmap.DIBFormat.e_DIB8bppMask ) More... | |
Bitmap | GetFrameBitmap (int index) |
Get a frame bitmap, specified by index. More... | |
int | GetFrameCount () |
Get frame count. More... | |
System.Drawing.Bitmap | GetFrameSystemBitmap (int index) |
Get a frame system bitmap, specified by index. More... | |
int | GetHeight () |
Get image height. More... | |
Image.Type | GetType () |
Get image type. More... | |
int | GetWidth () |
Get image width. More... | |
int | GetXDPI () |
Get DPI for X-axis. More... | |
int | GetYDPI () |
Get DPI for Y-axis. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
bool | SaveAs (string file_path) |
Save current image as an image file. More... | |
bool | SaveAs (StreamCallback file, string file_extension) |
Save current image as an image file. More... | |
void | SetDPIs (int x_dpi, int y_dpi) |
Set DPI for X-axis and Y-axis. More... | |
Foxit PDF SDK offers following image types:
BMP: bitmap image format. It only support single frame. Foxit PDF SDK supports to load image from a BMP image file, get some basic information, get its bitmap, change its bitmap and save it as an image file.
JPG: joint photographic experts group image format. It only support single frame. Foxit PDF SDK supports to load image from a JPG image file, get some basic information, get its bitmap, change its bitmap and save it as an image file.
PNG: portable network graphics image format. It only support single frame. Foxit PDF SDK supports to load image from a PNG image file, get some basic information, get its bitmap, change its bitmap and save it as an image file.
GIF: graphics interchange format. It supports multiple frames. Foxit PDF SDK supports to load image from a GIF image file, get its size, get its bitmap, change its bitmap and save it as an image file.
TIF: tagged image file format. It supports multiple frames. Foxit PDF SDK supports to load image from a TIF image file, get some basic information, get its bitmap, change its bitmap and save it as an image file.
JPX: JPEG-2000 image format. It only support single frame. Foxit PDF SDK supports to load image from a JPX image file, get its size, get its bitmap, change its bitmap and save it as an image file.
JBIG2: JBIG2 image format. It only support single frame. Foxit PDF SDK supports to load image from a JBIG2 image file, get its size, and save it as an image file. Foxit PDF SDK does not support to get its frame bitmap yet.
|
strong |
Enumeration for image type.
Values of this enumeration should be used alone.
Enumerator | |
---|---|
e_Unknown | Unknown image type. |
e_None | Not have image type yet.
|
e_BMP | Image type is BMP. |
e_JPG | Image type is JPG or JPEG. |
e_PNG | Image type is PNG. |
e_GIF | Image type is GIF. |
e_TIF | Image type is TIF or TIFF. |
e_JPX | Image type is JPX or JPEG-2000. |
e_JBIG2 | Image type is JBIG2.
|
|
inline |
Constructor.
This constructor is to construct a new image object (without any data). The image type of this constructed image object would be foxit.common.Image.Type.e_None .
|
inline |
Constructor, from an existing image file path.
[in] | path | A full path of an existing image file. It should not be an empty string. |
|
inline |
Constructor, from a memory buffer.
[in] | buffer | A memory buffer. The image file data should be fully loaded in this memory buffer. It should not be null. |
[in] | length | The size of memory buffer. It should be above 0. |
|
inline |
Constructor, with a file read callback object.
[in] | file_read | A foxit.common.fxcrt.FileReaderCallback object which is implemented by user to load an image file. It should not be null. |
|
inline |
Constructor, with another image object.
[in] | other | Another image object. |
|
inline |
Add a bitmap as a frame. (Unsupported DIB formats: foxit.common.Bitmap.DIBFormat.e_DIBRgb565 and foxit.common.Bitmap.DIBFormat.e_DIB8bppMask).
Currently, this function does not support an image with type Image.Type.e_JBIG2, or Image.Type.e_Unknown .
For supporting image types:
[in] | bitmap | A valid bitmap as a frame to be added or set. |
|
inline |
Add a bitmap as a frame. (Unsupported DIB formats: foxit.common.Bitmap.DIBFormat.e_DIBRgb565 and foxit.common.Bitmap.DIBFormat.e_DIB8bppMask )
Currently, this function does not support an image with type foxit.common.Image.Type.e_JBIG2 , or foxit.common.Image.Type.e_Unknown .
For supporting image types:
If current image's type is foxit.common.Image.Type.e_TIF , foxit.common.Image.Type.e_GIF , or foxit.common.Image.Type.e_None , this function will add the new bitmap to be the new last frame.
If current image's type is one of other types, which only contains single frame, this function will use the new bitmap to replace the first frame.
[in] | bitmap | A valid bitmap as a frame to be added or set. |
|
inline |
Get a frame bitmap, specified by index.
Currently, this function does not support an image with type foxit.common.Image.Type.e_JBIG2 . This function can only support to get a frame bitmap which is in following formats:
foxit.common.Bitmap.DIBFormat.e_DIB8bppMask , foxit.common.Bitmap.DIBFormat.e_DIB8bpp , foxit.common.Bitmap.DIBFormat.e_DIBRgb , foxit.common.Bitmap.DIBFormat.e_DIBRgb32 , foxit.common.Bitmap.DIBFormat.e_DIBArgb .
For other unsupported DIB format, this function will return a bitmap object which's function Bitmap.IsEmpty returns true.
[in] | index | Index of the frame. Valid range: from 0 to (count-1). count is returned by function Image.GetFrameCount . |
|
inline |
Get frame count.
Currently, this function does not support an image with type foxit.common.Image.Type.e_JBIG2 .
|
inline |
Get a frame system bitmap, specified by index.
Currently, this function does not support an image with type Image.Type.e_JBIG2.This function can only support to get a frame bitmap which is in following formats:
foxit.common.Bitmap.DIBFormat.e_DIB8bppMask, foxit.common.Bitmap.DIBFormat.e_DIB8bpp, foxit.common.Bitmap.DIBFormat.e_DIBRgb, foxit.common.Bitmap.DIBFormat.e_DIBRgb32, foxit.common.Bitmap.DIBFormat.e_DIBArgb.
For other unsupported DIB format, this function will return a bitmap object which's function Bitmap.IsEmpty returns true.
[in] | index |
Index of the frame. Valid range: from 0 to (count-1). count is returned by function Image.GetFrameCount.
|
inline |
Get image height.
If the image has multiple frames, usually the first frame's size will be treated as the image size.
|
inline |
Get image type.
If current image is a new image (not constructed from any image file), its type would be foxit.common.Image.Type.e_None .
|
inline |
Get image width.
If the image has multiple frames, usually the first frame's size will be treated as the image size.
|
inline |
Get DPI for X-axis.
Currently, this function does not support an image with type foxit.common.Image.Type.e_JPX , foxit.common.Image.Type.e_GIF or foxit.common.Image.Type.e_JBIG2 .
For a new image (not constructed from any image file), the default DPI for X-axis is 96.
|
inline |
Get DPI for Y-axis.
Currently, this function does not support an image with type foxit.common.Image.Type.e_JPX , foxit.common.Image.Type.e_GIF or foxit.common.Image.Type.e_JBIG2 .
For a new image (not constructed from any image file), the default DPI for Y-axis is 96.
|
inline |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
|
inline |
Save current image as an image file.
If the type of current image is foxit.common.Image.Type.e_TIF , foxit.common.Image.Type.e_GIF or foxit.common.Image.Type.e_None , and the saved image file type does not support multiply frames, only the first frame of current image will be saved to the image file.
For an image object (not constructed from any image file), please ensure to add at least one valid frame bitmap to the image object before using this function; otherwise this function will fail.
[in] | file_path | A full path of the saved image file. It should not be an empty string. Currently, this function supports following extension names: .bmp, .jpg, .jpeg, .png, .tif, .tiff, .jpx, .jp2. |
Use current function to save current image object to an temporary file. Here, this temporary file is named as "temp.tmp".
Ensure that current image object has destructed.
Remove "org.bmp" and rename "temp.tmp" to "org.bmp".
|
inline |
Save current image as an image file.
If the type of current image is foxit.common.Image.Type.e_TIF , foxit.common.Image.Type.e_GIF or foxit.common.Image.Type.e_None , and the saved image file type does not support multiply frames, only the first frame of current image will be saved to the image file.
For an image object (not constructed from any image file), please ensure to add at least one valid frame bitmap to the image object before using this function; otherwise this function will fail.
[in] | file | A foxit.common.fxcrt.StreamCallback object which is implemented by user to save image file. |
[in] | file_extension | A full path of the saved image file. It should not be an empty string. Currently, this function supports following extension names: .bmp, .jpg, .jpeg, .png, .tif, .tiff, .jpx, .jp2. |
Use current function to save current image object to an temporary file. Here, this temporary file is named as "temp.tmp".
Ensure that current image object has destructed.
Remove "org.bmp" and rename "temp.tmp" to "org.bmp".
|
inline |
Set DPI for X-axis and Y-axis.
Currently, this function does not support an image with type foxit.common.Image.Type.e_JPX , foxit.common.Image.Type.e_GIF , or foxit.common.Image.Type.e_JBIG2 .
[in] | x_dpi | DPI for X-axis. It should be above 0. |
[in] | y_dpi | DPI for Y-axis. It should be above 0. |