|
Foxit PDF SDK
|
Public Member Functions | |
| constructor () | |
| Constructor. | |
| constructor (bitmap) | |
| Constructor, with a bitmap object. More... | |
| IsEmpty () | |
| Check whether current object is empty or not. More... | |
| Release () | |
| Release current OFD renderer object. More... | |
| SetColorMode (color_mode) | |
| Set the color mode. More... | |
| SetContentFlag (content_flag) | |
| Set the content flag. More... | |
| StartRender (page, matrix) | |
| Start to render an OFD page. More... | |
Static Public Attributes | |
| static | e_ColorModeMapping |
| Map a color value to the color range defined by a background color and a foreground color. | |
| static | e_ColorModeMappingGray |
| Map gray/white/black color value to background/foreground; for other colors, no change. | |
| static | e_ColorModeNormal |
| Enumeration for rendering color mode. More... | |
| static | e_ContentFlagAllContent |
| Enumeration for OFD rendering content flags. More... | |
| static | e_ContentFlagAnnot |
| If set, annotations will be rendered.(Excluding highlight annotation and stamp) | |
| static | e_ContentFlagHighLightAnnots |
| If set, highlight annotations will be rendered. | |
| static | e_ContentFlagPage |
| If set, page content will be rendered. | |
| static | e_ContentFlagStampAnnots |
| If set, stamp annotations will be rendered. | |
This class is used to render an OFD page to a bitmap. Please ensure FSDK.Library.InitializeOFDEngine has been called successfully before using this class.
| FSDK.OFDRenderer.constructor | ( | bitmap | ) |
Constructor, with a bitmap object.
| [in] | bitmap | A bitmap object. It should not be an empty bitmap. |
| FSDK.OFDRenderer.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
| FSDK.OFDRenderer.Release | ( | ) |
Release current OFD renderer object.
Please call this function before FSDK.Library.ReleaseOFDEngine to release current OFD renderer object.
| FSDK.OFDRenderer.SetColorMode | ( | color_mode | ) |
Set the color mode.
| [in] | color_mode | Color mode. Please refer to values starting from FSDK.OFDRenderer.e_ColorModeNormal and this should be one of these values. The default value is FSDK.OFDRenderer.e_ColorModeNormal. |
| FSDK.OFDRenderer.SetContentFlag | ( | content_flag | ) |
Set the content flag.
| [in] | content_flag | Content flag. Please refer to values starting from FSDK.OFDRenderer.e_ContentFlagAllContent and this can be one or a combination of these values. The default value is FSDK.OFDRenderer.e_ContentFlagAllContent. |
| FSDK.OFDRenderer.StartRender | ( | page | , |
| matrix | |||
| ) |
Start to render an OFD page.
This function is used to start to render an OFD page.
| [in] | page | An OFD page object. It should not be an empty object. |
| [in] | matrix | A matrix for rendering the page, which is usually returned by function FSDK.OFDPage.GetDisplayMatrix. |
|
static |
Enumeration for rendering color mode.
Values of this enumeration should be used alone.
Normal color mode.
|
static |
Enumeration for OFD rendering content flags.
Values of this enumeration can be used alone or in combination.
If set, all content will be rendered. This value should be used alone.