Header file for PDF Document module of Foxit PDF SDK. More...
Go to the source code of this file.
Macros | |
Macro Definitions for PDF Saving Flags | |
| |
| #define | FSPDF_SAVEFLAG_INCREMENTAL 0x1 |
| Save PDF document incrementally. Normally, this flag should not be combined with FSPDF_SAVEFLAG_NOORIGINAL. | |
| #define | FSPDF_SAVEFLAG_NOORIGINAL 0x2 |
| Save PDF document without original data or unchanged objects. | |
| #define | FSPDF_SAVEFLAG_REMOVESECURITY 0x4 |
| Save PDF document remove security. | |
| #define | FSPDF_SAVEFLAG_OBJECTSTREAM 0x8 |
| Save PDF document by using object stream, in order to reduce the file size. | |
| #define | FSPDF_SAVEFLAG_OPTIMIZE 0x10 |
| Remove the unused objects/resources when saving the document, in order to reduce the file size. If it is combined with FSPDF_SAVEFLAG_INCREMENTAL, FSPDF_SAVEFLAG_INCREMENTAL would be ignored. Only support desktop platforms for now. | |
| #define | FSPDF_SAVEFLAG_INCREMENTONLY 0x20 |
| Save PDF document and only offer the data of increment. Normally, this flag should not be combined with any other saving flags. More... | |
| #define | FSPDF_SAVEFLAG_LINEARIZED 0x40 |
| Save PDF document with linearized. More... | |
Macro Definitions for Importing Pages Flags | |
| |
| #define | FSPDF_IMPORTFLAG_NORMAL 0x00 |
| Import pages normally and it equals to call function FSPDF_Doc_StartImportPages. | |
| #define | FSPDF_IMPORTFLAG_WITHLAYERS 0x01 |
| Import pages with layers and it equals to call function FSPDF_Doc_StartImportPagesWithLayers. | |
| #define | FSPDF_IMPORTFLAG_SHARESTREAM 0x02 |
| Import pages without cloning stream objects into memory and it will reduce memory overhead. | |
Functions | |
| FS_RESULT | FSPDF_Doc_Create (FSCRT_DOCUMENT *document) |
| Create a new document object. More... | |
| FS_RESULT | FSPDF_Doc_StartImportPages (FSCRT_DOCUMENT dstDoc, FS_INT32 startIndex, FSCRT_DOCUMENT srcDoc, const FS_INT32 *pageRanges, FS_INT32 count, FSCRT_PROGRESS *importProgress) |
| To start a progressive process of inserting a range of pages from a extra source document into the target document. More... | |
| FS_RESULT | FSPDF_Doc_StartImportPagesWithLayers (FSCRT_DOCUMENT dstDoc, FS_INT32 startIndex, FSCRT_DOCUMENT srcDoc, const FSCRT_BSTR *layerName, const FS_INT32 *pageRanges, FS_INT32 count, FSCRT_PROGRESS *importProgress) |
| To start a progressive process of inserting a range of pages from a extra source document with its layer information into the target document. More... | |
| FS_RESULT | FSPDF_Doc_StartImportPagesFromFileName (FSCRT_DOCUMENT dstDoc, FS_INT32 startIndex, const FSCRT_BSTR *srcFileName, const FSCRT_BSTR *password, const FSCRT_BSTR *layerName, const FS_INT32 *pageRanges, FS_INT32 count, FS_INT32 flags, FSCRT_PROGRESS *importProgress) |
| To start a progressive process of inserting a range of pages from an extra source document which specified by file path to the target document. More... | |
| FS_RESULT | FSPDF_Doc_StartSaveToFile (FSCRT_DOCUMENT document, FSCRT_FILE file, FS_INT32 flag, FSCRT_PROGRESS *saveProgress) |
| Start saving a PDF document to another file in a progressive manner. More... | |
| FS_RESULT | FSPDF_Doc_SaveAsWrapperFile (FSCRT_DOCUMENT wrapperDoc, FSCRT_FILE file, const FSPDF_WRAPPERDATA *wrapperData, FS_DWORD userPermissions, const FSCRT_BSTR *ownerPassword) |
| Save a PDF document as a wrapper file. More... | |
| FS_RESULT | FSPDF_Doc_SetAction (FSCRT_DOCUMENT document, FS_INT32 trigger, FS_INT32 index, const FSPDF_ACTIONDATA *actionData) |
| Set document trigger action. More... | |
| FS_RESULT | FSPDF_Doc_InsertAction (FSCRT_DOCUMENT document, FS_INT32 trigger, FS_INT32 index, const FSPDF_ACTIONDATA *actionData) |
| Insert document trigger action. More... | |
| FS_RESULT | FSPDF_Doc_RemoveAction (FSCRT_DOCUMENT document, FS_INT32 trigger, FS_INT32 index) |
| Remove document trigger action. More... | |
| FS_RESULT | FSPDF_Doc_RemoveAllActions (FSCRT_DOCUMENT document, FS_INT32 trigger) |
| Remove all document trigger action. More... | |
| FS_RESULT | FSPDF_Doc_RemoveJSActionByName (FSCRT_DOCUMENT document, const FSCRT_BSTR *name) |
| Remove a javascript action from the PDF document by the name of javascript action. More... | |
| FS_RESULT | FSPDF_Doc_SetFileVersion (FSCRT_DOCUMENT document, FS_INT32 version) |
| Specify the PDF file version which will be stored in PDF header section. This function does not check whether the PDF matches the specified version. More... | |
| FS_RESULT | FSPDF_Doc_SetDisplayMode (FSCRT_DOCUMENT document, FS_INT32 displayMode) |
| Set display mode specified in PDF document. More... | |
| FS_RESULT | FSPDF_PageLabels_SetRangeInfo (FSCRT_DOCUMENT document, FS_INT32 start, FS_INT32 style, const FSCRT_BSTR *prefix, FS_INT32 st) |
| Set page labels of PDF pages with a specified range. More... | |
| FS_RESULT | FSPDF_PageLabels_RemoveAll (FSCRT_DOCUMENT document) |
| Delete all page labels in the PDF document. More... | |
| FS_RESULT | FSPDF_Metadata_SetString (FSCRT_DOCUMENT document, const FSCRT_BSTR *key, const FSCRT_BSTR *string) |
| Set a UTF-8 string value to parameter key in metadata. More... | |
| FS_RESULT | FSPDF_Metadata_SetStringArray (FSCRT_DOCUMENT document, const FSCRT_BSTR *key, const FSCRT_BSTR *stringArray, const FS_INT32 count) |
| Set an UTF-8 string array value to parameter key in metadata. More... | |
| FS_RESULT | FSPDF_Metadata_SetDateTime (FSCRT_DOCUMENT document, const FSCRT_BSTR *key, const FSCRT_DATETIMEZONE *dt) |
| Set a date value to parameter key in metadata. More... | |
| FS_RESULT | FSPDF_Bookmark_SetData (FSPDF_BOOKMARK_ITERATOR iterator, const FSPDF_BOOKMARKDATA *bmData) |
| Set data to current bookmark positioned by parameter iterator. More... | |
| FS_RESULT | FSPDF_Bookmark_Insert (FSPDF_BOOKMARK_ITERATOR iterator, FS_INT32 pos, const FSPDF_BOOKMARKDATA *bmData) |
| Insert a new bookmark at parameter pos bookmark position and set the data. More... | |
| FS_RESULT | FSPDF_Bookmark_InsertAtPos (FSPDF_BOOKMARK_ITERATOR iterator, FSPDF_BOOKMARKPOS newParentPos, FS_INT32 childIndex) |
| Insert a bookmark to be the child (with specific index) of another bookmark with specific position and old one with the specific index will be the next sibling. More... | |
| FS_RESULT | FSPDF_Bookmark_Remove (FSPDF_BOOKMARK_ITERATOR iterator) |
| Remove the current bookmark item positioned by parameter iterator. More... | |
| FS_RESULT | FSPDF_Bookmark_SetAction (FSPDF_BOOKMARK_ITERATOR iterator, FS_INT32 index, const FSPDF_ACTIONDATA *actionData) |
| Set bookmark action. More... | |
| FS_RESULT | FSPDF_Bookmark_InsertAction (FSPDF_BOOKMARK_ITERATOR iterator, FS_INT32 index, const FSPDF_ACTIONDATA *actionData) |
| Insert bookmark action. More... | |
| FS_RESULT | FSPDF_Bookmark_RemoveAction (FSPDF_BOOKMARK_ITERATOR iterator, FS_INT32 index) |
| Remove a specific bookmark action. More... | |
| FS_RESULT | FSPDF_Bookmark_RemoveAllActions (FSPDF_BOOKMARK_ITERATOR iterator) |
| Remove all bookmark actions. More... | |
| FS_RESULT | FSPDF_Bookmark_Update (FSPDF_BOOKMARK_ITERATOR iterator) |
| Update specific bookmark iterator object after structure of bookmark tree has been changed. More... | |
| FS_RESULT | FSPDF_ViewerPref_SetUIVisibility (FSCRT_DOCUMENT document, const FSCRT_BSTR *uiItem, FS_BOOL uiVisible) |
| Set UI visibility in viewer preferences. More... | |
| FS_RESULT | FSPDF_ViewerPref_SetNonFullScreenPageMode (FSCRT_DOCUMENT document, FS_INT32 displayMode) |
| Set display mode for non full-screen mode in viewer preferences. More... | |
| FS_RESULT | FSPDF_ViewerPref_SetReadingDirection (FSCRT_DOCUMENT document, FS_INT32 direction) |
| Set reading direction in viewer preferences. More... | |
| FS_RESULT | FSPDF_ViewerPref_SetAreaType (FSCRT_DOCUMENT document, const FSCRT_BSTR *boxItem, FS_INT32 boxType) |
| Set the page box type in viewer preferences. More... | |
| FS_RESULT | FSPDF_ViewerPref_SetPrintScale (FSCRT_DOCUMENT document, const FSCRT_BSTR *printScale) |
| Set page scaling in viewer preferences. More... | |
| FS_RESULT | FSPDF_ViewerPref_SetPrintCopies (FSCRT_DOCUMENT document, FS_INT32 copies) |
| Set the number of copies to be printed. More... | |
| FS_RESULT | FSPDF_ViewerPref_SetPrintRanges (FSCRT_DOCUMENT document, const FS_INT32 *pageRanges, FS_INT32 count) |
| Set the page ranges to be printed. More... | |
| FS_RESULT | FSPDF_Attachments_InsertAttachment (FSPDF_ATTACHMENTS attachments, FS_INT32 index, FSPDF_ATTACHMENT attachment) |
| Insert an attachment. More... | |
| FS_RESULT | FSPDF_Attachments_RemoveAttachment (FSPDF_ATTACHMENTS attachments, FSPDF_ATTACHMENT attachment) |
| Remove an attachment. More... | |
| FS_RESULT | FSPDF_Doc_EmbedFont (FSCRT_DOCUMENT document, FSCRT_FONT font) |
| Embed a PDF font to the PDF document. More... | |
Header file for PDF Document module of Foxit PDF SDK.
Copyright (C) 2003-2016, Foxit Software Inc.. All Rights Reserved.
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 document.
It contains:
