Foxit PDF SDK
|
Public Types | |
enum | TextMergeOption { TextMergeOption.e_TextMergeNone = 0, TextMergeOption.e_TextMergeTJY = 1, TextMergeOption.e_TextMergeBTET = 2 } |
Enumeration for text merge. More... | |
Public Member Functions | |
GraphicsObjects (GraphicsObjects other) | |
Constructor, with another GraphicsObjects object. More... | |
bool | GenerateContent () |
Generate contents of current graphics objects. More... | |
bool | GenerateContent (GraphicsObjects.TextMergeOption text_merge_option) |
Generate contents of current graphics objects. More... | |
long | GetFirstGraphicsObjectPosition (GraphicsObject.Type filter) |
Get the position of first graphics object in graphics object list, based on type filter. More... | |
GraphicsObject | GetGraphicsObject (long position) |
Get the graphics object by position in graphics object list. More... | |
GraphicsObject | GetGraphicsObject (int index) |
Get a graphics object by index. More... | |
int | GetGraphicsObjectCount () |
Get the count of graphics objects in graphics object list. More... | |
int | GetGraphicsObjectIndex (GraphicsObject graphics_object) |
Get the index of a specified graphics object in graphics object list. More... | |
long | GetGraphicsObjectPosition (GraphicsObject graphics_object) |
Get the position of the specified graphics object. More... | |
long | GetLastGraphicsObjectPosition (GraphicsObject.Type filter) |
Get the position of last graphics object in graphics object list, based on type filter. More... | |
long | GetNextGraphicsObjectPosition (long position, GraphicsObject.Type filter) |
Get the position of next graphics object in graphics object list, based on type filter and specified current position. More... | |
long | GetPrevGraphicsObjectPosition (long position, GraphicsObject.Type filter) |
Get the position of previous graphics object in graphics object list, based on type filter and specified current position. More... | |
long | InsertGraphicsObject (long position_insert_after, GraphicsObject graphics_object) |
Insert a graphics object after the specified position. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
long | MoveGraphicsObjectByPosition (long current_position, long position_move_after) |
Move a graphics object from a position to another position. More... | |
bool | RemoveGraphicsObject (GraphicsObject graphics_object) |
Remove a graphics object. More... | |
bool | RemoveGraphicsObjectByPosition (long position) |
Remove a graphics object by position. More... | |
This class is used as a manager for graphics objects. It stores all its graphics objects in a graphics list, and use POSITION object to enumerate them. A valid POSITION object can be used to get one graphics object, insert new graphics object and even remove one.
If any graphics object is changed, or graphics object is inserted/removed, function GraphicsObjects.GenerateContent should be called to ensure that all these changes would be stored to PDF document. Please refer to function GraphicsObjects.GenerateContent for more details.
A PDF page's content usually consists of a sequence of graphics objects, that means PDF page is used like a manager for graphics objects as well. So class foxit.pdf.PDFPage is derived from class GraphicsObjects in order that class PDFPage can retrieve its graphics object.
A form XObject, a kind of graphics object, is a self-contained description of any sequence of graphics objects, so function graphics.FormXObject.GetGraphicsObjects can be used to retrieve a GraphicsObjects object from a form XObject in order to manage graphics objects which are contained in a form XObject.
|
strong |
Enumeration for text merge.
Values of this enumeration should be used alone.
|
inline |
Constructor, with another GraphicsObjects object.
[in] | other | Another GraphicsObjects object. |
|
inline |
Generate contents of current graphics objects.
If any graphics object is changed, or graphics object is inserted/removed/moved, this function should be called before saving related PDF document to ensure that all these changes would be stored to PDF document. Since it may take a long time to generate content, user is not recommended to call this function frequently, but only call this function when necessary, for example, just before the related PDF document is to be saved.
When this function succeeds, and current graphics object represents a PDF page, user is recommended to re-parse the PDF page by function PDFPage.StartParse with parameter is_reparse true before doing some operation on page content; otherwise the result of the operation may be unexpected. For example, if render the PDF page without re-parsing PDF page after this function succeeds, the page content may not be rendered as expected or unexpected error may occur. Please refer to function PDFPage.StartParse for more details about re-parsing a PDF page.
|
inline |
Generate contents of current graphics objects.
If any graphics object is changed, or graphics object is inserted/removed/moved, this function should be called before saving related PDF document to ensure that all these changes would be stored to PDF document. Since it may take a long time to generate content, user is not recommended to call this function frequently, but only call this function when necessary, for example, just before the related PDF document is to be saved.
When this function succeeds, and current graphics objects represent a PDF page, user is recommended to re-parse the PDF page by function PDFPage.StartParse with parameter is_reparse true before doing some operation on page content; otherwise the result of the operation may be unexpected. For example, if render the PDF page without re-parsing PDF page after this function succeeds, the page content may not be rendered as expected or unexpected error may occur. Please refer to function PDFPage.StartParse for more details about re-parsing a PDF page.
[in] | text_merge_option | The merge option for text object. Please refer to values starting from foxit.pdf.GraphicsObjects.TextMergeOption.e_TextMergeNone and this should be one of these values. |
|
inline |
Get the position of first graphics object in graphics object list, based on type filter.
After getting a position in the graphics object list, then user can call function GraphicsObjects.GetGraphicsObject to get the graphics object with this position.
[in] | filter | Type filter that specifies which kind of graphics object is to be gotten. Please refer to values starting from foxit.pdf.graphics.GraphicsObject.Type.e_TypeAll and this should be one of these values. foxit.pdf.graphics.GraphicsObject.Type.e_TypeAll means for all kinds of graphics objects. |
|
inline |
Get the graphics object by position in graphics object list.
[in] | position | A POSITION object that indicates the position in the graphics object list. It should not be null or 0. |
|
inline |
Get a graphics object by index.
[in] | index | Index of a graphics object to be retrieved. Valid range: from 0 to (count-1). count is returned by function GraphicsObjects.GetGraphicsObjectCount . |
|
inline |
Get the count of graphics objects in graphics object list.
|
inline |
Get the index of a specified graphics object in graphics object list.
[in] | graphics_object | A graphics object whose index is to be retrieved. Please ensure that input graphics object belongs to current graphics objects. |
|
inline |
Get the position of the specified graphics object.
[in] | graphics_object | A graphics object whose position is to be retrieved. |
|
inline |
Get the position of last graphics object in graphics object list, based on type filter.
After getting a position in the graphics object list, then user can call function GraphicsObjects.GetGraphicsObject to get the graphics object with this position.
[in] | filter | Type filter that specifies which kind of graphics object is to be gotten. Please refer to values starting from foxit.pdf.graphics.GraphicsObject.Type.e_TypeAll and this should be one of these values. foxit.pdf.graphics.GraphicsObject.Type.e_TypeAll means for all kinds of graphics objects. |
|
inline |
Get the position of next graphics object in graphics object list, based on type filter and specified current position.
After getting a position in the graphics object list, then user can call function GraphicsObjects.GetGraphicsObject to get the graphics object with this position.
[in] | position | A POSITION object that indicates a position in the graphics object list, whose next position is to be gotten. It should not be null or 0. |
[in] | filter | Type filter that specifies which kind of graphics object is to be gotten. Please refer to values starting from foxit.pdf.graphics.GraphicsObject.Type.e_TypeAll and this should be one of these values. foxit.pdf.graphics.GraphicsObject.Type.e_TypeAll means for all kinds of graphics objects. |
|
inline |
Get the position of previous graphics object in graphics object list, based on type filter and specified current position.
After getting a position in the graphics object list, then user can call function GraphicsObjects.GetGraphicsObject to get the graphics object with this position.
[in] | position | A POSITION object that indicates a position in the graphics object list, whose previous position is to be gotten. It should not be null or 0. |
[in] | filter | Type filter that specifies which kind of graphics object is to be gotten. Please refer to values starting from foxit.pdf.graphics.GraphicsObject.Type.e_TypeAll and this should be one of these values. foxit.pdf.graphics.GraphicsObject.Type.e_TypeAll means for all kinds of graphics objects. |
|
inline |
Insert a graphics object after the specified position.
[in] | position_insert_after | Used to specify the position, in order to insert parameter graphics_object after this position. 0 means that parameter graphics_object will be inserted before all graphics objects. |
[in] | graphics_object | A graphics object to be inserted. User should ensure that parameter graphics_object belongs to the same PDF document as current graphics objects. |
|
inline |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
|
inline |
Move a graphics object from a position to another position.
[in] | current_position | Current position of the graphics object which is to be moved to new position. |
[in] | position_move_after | Used to specify the position, in order to move the graphics object specified by parameter current_position after this position. 0 means that the graphics object specified by parameter current_positionwill be moved before all graphics objects. |
|
inline |
Remove a graphics object.
To remove a graphics object by position (function GraphicsObjects.RemoveGraphicsObjectByPosition ) is more direct and effective than to remove a graphics object directly (function GraphicsObjects.RemoveGraphicsObject ).
[in] | graphics_object | A graphics object to be removed. Please ensure this graphics object belongs to current graphics objects. |
|
inline |
Remove a graphics object by position.
To remove a graphics object by position (function GraphicsObjects.RemoveGraphicsObjectByPosition ) is more direct and effective than to remove a graphics object directly (function GraphicsObjects.RemoveGraphicsObject ).
[in] | position | Used to specify the position of a graphics object, to be removed. It should not be null or 0. |