fpdf_pageobjects_w.h File Reference

Header file for PDF Page Objects module of Foxit PDF SDK. More...

Go to the source code of this file.

Functions

FS_RESULT FSPDF_PageObjects_InsertObject (FSCRT_PAGE page, FSPDF_PAGEOBJECTS pageObjs, FS_INT32 typeFilter, FS_INT32 index, FSPDF_PAGEOBJECT pageObj)
 Insert a page object and it will be automatically freed. More...
 
FS_RESULT FSPDF_PageObjects_RemoveObject (FSCRT_PAGE page, FSPDF_PAGEOBJECTS pageObjs, FSPDF_PAGEOBJECT pageObj)
 Remove a page object. More...
 
FS_RESULT FSPDF_PageObjects_GenerateContents (FSCRT_PAGE page, FSPDF_PAGEOBJECTS pageObjs)
 Generate PDF Page contents. More...
 
FS_RESULT FSPDF_PageObject_Clone (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FSPDF_PAGEOBJECT *clonedPageObj)
 Clone a new page object. More...
 
FS_RESULT FSPDF_PageObject_SetMatrix (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, const FSCRT_MATRIX *matrix)
 Set matrix of a page object. More...
 
FS_RESULT FSPDF_PageObject_Transform (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, const FSCRT_MATRIX *matrix, FS_BOOL needTransformClipPath)
 Transform a page object. More...
 
FS_RESULT FSPDF_PageObject_SetGraphState (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, const FSPDF_GRAPHSTATE *graphState)
 Set graph states of a page object. More...
 
FS_RESULT FSPDF_PageObject_SetColor (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FS_BOOL isStroke, FS_ARGB color)
 Set color of a page object . More...
 
FS_RESULT FSPDF_PageObject_SetClipRect (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, const FSCRT_RECTF *clipRect)
 Set clip rectangle of a page object. More...
 
FS_RESULT FSPDF_TextObject_Create (FSCRT_PAGE page, FSPDF_PAGEOBJECT *textObj)
 Create a new text Object. More...
 
FS_RESULT FSPDF_TextObject_SetTextState (FSCRT_PAGE page, FSPDF_PAGEOBJECT textObj, const FSPDF_TEXTSTATE *textState, FS_BOOL italic, FS_INT32 weight)
 Set text states of a text object. More...
 
FS_RESULT FSPDF_TextObject_SetUnicodeString (FSCRT_PAGE page, FSPDF_PAGEOBJECT textObj, const FSCRT_BSTR *unicodeStr)
 Set unicode string for a text object. More...
 
FS_RESULT FSPDF_PathObject_Create (FSCRT_PAGE page, FSPDF_PAGEOBJECT *pathObj)
 Create a new path object. More...
 
FS_RESULT FSPDF_PathObject_SetPathData (FSCRT_PAGE page, FSPDF_PAGEOBJECT pathObj, FSCRT_PATHDATA pathData)
 Set path data of a path object. More...
 
FS_RESULT FSPDF_PathObject_SetFillMode (FSCRT_PAGE page, FSPDF_PAGEOBJECT pathObj, FS_INT32 fillMode)
 Set fill mode of a path object. More...
 
FS_RESULT FSPDF_PathObject_SetStrokeState (FSCRT_PAGE page, FSPDF_PAGEOBJECT pathObj, FS_BOOL isStroke)
 Set stroke state of a path object. More...
 
FS_RESULT FSPDF_PathObject_ConvertFromTextObject (FSCRT_PAGE page, FSPDF_PAGEOBJECT *convertedObj)
 Convert text object to path object for avoiding print deviation. More...
 
FS_RESULT FSPDF_ImageObject_Create (FSCRT_PAGE page, FSPDF_PAGEOBJECT *imageObj)
 Create an image object. More...
 
FS_RESULT FSPDF_ImageObject_SetBitmap (FSCRT_PAGE page, FSPDF_PAGEOBJECT imageObj, FSCRT_BITMAP bitmap, FSCRT_BITMAP mask)
 Set a bitmap to an image object. More...
 
FS_RESULT FSPDF_ImageObject_SetImage (FSCRT_PAGE page, FSPDF_PAGEOBJECT imageObj, FSCRT_IMAGE image)
 Set an image to an image object. More...
 
FS_RESULT FSPDF_ImageObject_SetImageFromFileName (FSCRT_PAGE page, FSPDF_PAGEOBJECT imageObj, const FSCRT_BSTR *imageFileName, FS_INT32 frameIndexOfImage)
 Set an image to an image object from a specific file path. More...
 
FS_RESULT FSPDF_FormXObject_Create (FSCRT_PAGE page, FSPDF_PAGEOBJECT *formXObj)
 Create a Form XObject object. More...
 
FS_RESULT FSPDF_FormXObject_ExtractAPFromPage (FSCRT_PAGE page, FSPDF_PAGEOBJECT formXObj, FSCRT_PAGE srcPage, FS_BOOL isAnnotsIncluded)
 Extract appearance of contents and annotations from a source page to a Form XObject object. More...
 
FS_RESULT FSPDF_PageObject_AddClipPath (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FSCRT_PATHDATA pathData, FS_INT32 fillMode)
 Add path for clipping to a page object. More...
 
FS_RESULT FSPDF_PageObject_DeleteClipPath (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FS_INT32 index)
 Delete a path for clipping from a page object. More...
 
FS_RESULT FSPDF_PageObject_AddClipText (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FSPDF_PAGEOBJECT textObj)
 Add text for clipping to a page object. More...
 
FS_RESULT FSPDF_PageObject_DeleteClipText (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FS_INT32 index)
 Delete a text for clipping from a page object. More...
 
FS_RESULT FSPDF_PageObject_ClearClips (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj)
 Clear all clips from a page object. More...
 
FS_RESULT FSPDF_PageObject_Release (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj)
 Release a page object which is created or which is cloned but not inserted into any PDF page. More...
 

Detailed Description

Header file for PDF Page Objects module of Foxit PDF SDK.

Copyright (C) 2003-2016, Foxit Software Inc.. All Rights Reserved.

http://www.foxitsoftware.com

The following code is copyrighted and contains proprietary information and trade secrets of Foxit Software Inc.. You cannot distribute any part of Foxit PDF SDK to any third party or general public, unless there is a separate license agreement with Foxit Software Inc. which explicitly grants you such rights.

This header file provides direct access to PDF page objects.
It contains:

  • 1. Add and remove page object.
  • 2. Generate page content.
  • 3. Clone page object.
  • 4. Set page object common attributes.
  • 5. Create text object and set particular attributes.
  • 6. Create path object and set particular attributes.
  • 7. Create image object and set particular attributes.
  • 8. Create Form XObject objects.
  • 9. Add and delete path clip.
  • 10. Add and delete text clip.
Note
If you want to purchase Foxit PDF SDK license and use ANY of the following functions, please request for enabling Edit Add-on explicitly.

Foxit Corporation