This class is used to render an OFD page to a bitmap. Please ensure common.Library.InitializeOFDEngine has been called successfully before using this class.
- See also
- foxit.common.Library
◆ ColorMode
Enumeration for rendering color mode.
Values of this enumeration should be used alone.
Enumerator |
---|
e_ColorModeNormal | Normal color mode.
|
e_ColorModeMappingGray | Map gray/white/black color value to background/foreground; for other colors, no change.
|
e_ColorModeMapping | Map a color value to the color range defined by a background color and a foreground color.
|
◆ ContentFlag
Enumeration for OFD rendering content flags.
Values of this enumeration can be used alone or in combination.
Enumerator |
---|
e_ContentFlagAllContent | If set, all content will be rendered. This value should be used alone.
|
e_ContentFlagPage | If set, page content will be rendered.
|
e_ContentFlagAnnot | If set, annotations will be rendered.(Excluding highlight annotation and stamp)
|
e_ContentFlagHighLightAnnots | If set, highlight annotations will be rendered.
|
e_ContentFlagStampAnnots | If set, stamp annotations will be rendered.
|
◆ OFDRenderer() [1/2]
foxit.addon.ofd.OFDRenderer.OFDRenderer |
( |
Bitmap |
bitmap | ) |
|
|
inline |
Constructor, with a bitmap object.
- Parameters
-
[in] | bitmap | A bitmap object. It should not be an empty bitmap. |
◆ OFDRenderer() [2/2]
foxit.addon.ofd.OFDRenderer.OFDRenderer |
( |
OFDRenderer |
other | ) |
|
|
inline |
Constructor, with another renderer object.
- Parameters
-
[in] | other | Another renderer object. |
◆ IsEmpty()
bool foxit.addon.ofd.OFDRenderer.IsEmpty |
( |
| ) |
|
|
inline |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
- Returns
- true means current object is empty, while false means not.
◆ SetColorMode()
Set the color mode.
- Parameters
-
- Returns
- None.
◆ SetContentFlag()
void foxit.addon.ofd.OFDRenderer.SetContentFlag |
( |
int |
content_flag | ) |
|
|
inline |
Set the content flag.
- Parameters
-
- Returns
- None.
◆ StartRender()
Start to render an OFD page.
This function is used to start to render an OFD page.
- Parameters
-
[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 OFDPage.GetDisplayMatrix . |
- Returns
- A progressive object. Please check the rate of current progress by function common.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function common.Progressive.Continue to continue the progress until the progress is finished.