20 #ifndef __EMSCRIPTEN_RENDER__ 25 #ifndef __EMSCRIPTEN_RENDER__ 37 #ifndef __EMSCRIPTEN_RENDER__ 49 class ReadingBookmark;
50 class SecurityHandler;
52 class CertificateEncryptData;
54 class CustomEncryptData;
56 class PagingSealSignature;
57 class WatermarkTextProperties;
584 : nonstandard_font_name_array(other.nonstandard_font_name_array)
585 , standard_font_name_array(other.standard_font_name_array) {}
783 typedef enum _PasswordType {
799 typedef enum _EncryptType {
823 typedef enum _UserPermissions {
880 typedef enum _SaveFlags {
936 typedef enum _ImportPageFlags {
954 typedef enum _ExtractPagesOptions {
981 typedef enum _InsertDocOptions {
993 typedef enum _DisplayMode {
1017 typedef enum _DataType {
1031 typedef enum _WrapperType {
1057 explicit PDFDoc(
const char* path);
1067 explicit PDFDoc(
const wchar_t* path);
1079 explicit PDFDoc(
const void* buffer,
size_t size);
1438 #ifndef __EMSCRIPTEN_RENDER__ 1655 #ifndef __EMSCRIPTEN_RENDER__ 1963 uint32 user_permissions = 0xFFFFFFFC,
const char* owner_password =
"");
1993 const wchar_t* crypto_filter,
const wchar_t* description,
float version,
2015 #ifndef __EMSCRIPTEN_RENDER__ 2268 const wchar_t* src_file_path,
const String& password,
2324 const wchar_t* src_file_path,
const WString& password,
2519 #ifndef __EMSCRIPTEN_RENDER__ 2756 #ifdef _SUPPORTWEBSDK_ 3035 #endif // FS_PDFDOC_H_ bool include_toc_pages
true means to include catalog page(s) in the calculation of pages number in the table of contents,...
Definition: fs_pdfdoc.h:720
PageBasicInfo GetPageBasicInfo(int index)
Get the basic information of a page specified by index.
ImportPageFlags
Enumeration for flags used for importing pages.
Definition: fs_pdfdoc.h:936
TiledWatermarkSettings(const TiledWatermarkSettings &settings)
Constructor, with another tiled watermark settings object.
Definition: fs_pdfdoc.h:122
bool enable_remove_form_fields
A boolean value indicating whether to remove interactive form fields.
Definition: fs_pdfdoc.h:454
common::Progressive StartRecognizeForm(common::PauseCallback *pause=0)
Start to recognize form in current PDF document.
bool SaveAsWrapperFile(const wchar_t *file_path, const WrapperData *wrapper_data=0, uint32 user_permissions=0xFFFFFFFC, const char *owner_password="")
Save current PDF document as a wrapper file.
Bookmark GetRootBookmark()
Get bookmark root node.
Operate text annotations and fill in interactive form fields. (Bit 6 in permission value)
Definition: fs_pdfdoc.h:848
Flags
Enumeration for tiled watermark setting flags.
Definition: fs_pdfdoc.h:66
Definition: fs_pdfobject.h:448
int version
Wrapper version.
Definition: fs_pdfdoc.h:275
If set, form fields are to imported from or exported to FDF/XFDF document.
Definition: fs_pdfdoc.h:1019
int GetReadingBookmarkCount()
Get the count of reading bookmarks.
bool RemoveBookmark(const Bookmark &bookmark)
Remove a specified bookmark.
WStringArray standard_font_name_array
Font name array of embedded fonts which are standard fonts and can be replaced by system fonts if the...
Definition: fs_pdfdoc.h:603
void Set(float version, const wchar_t *crypto_filter, const wchar_t *file_name, int64 file_size, const wchar_t *description)
Set value.
Definition: fs_pdfdoc.h:351
If set, annotations (except link annotations) are to imported from or exported to FDF/XFDF document.
Definition: fs_pdfdoc.h:1021
Bookmark CreateRootBookmark()
Create new bookmark root node.
bool SetSecurityHandler(const SecurityHandler &handler)
Set a PDF security handler for encryption, such as standard encryption(password), certificate encrypt...
common::Progressive StartSaveAs(const char *file_path, uint32 save_flags=PDFDoc::e_SaveFlagNormal, common::PauseCallback *pause=0)
Start to save current PDF document as another PDF file.
bool operator==(const PDFDoc &other) const
Equal operator.
TiledWatermarkSettings()
Constructor and set the default value.
Definition: fs_pdfdoc.h:109
Definition: fs_common.h:1368
File writing interface.
Definition: fx_stream.h:470
int GetFirstAvailPageIndex() const
Get the page index of the fist available page.
void ClearRenderCache()
Clear the cache used during rendering, to reduce the memory usage.
bool HasForm() const
Check whether current PDF document has interactive form (also known as AcroForm).
bool enable_remove_fileattachment
A boolean value indicating whether to remove embedded file attachments.
Definition: fs_pdfdoc.h:426
StdEncryptData GetStdEncryptData() const
Get encrypt data of standard encryption (known as password encryption).
TableOfContentsConfig(const wchar_t *title, Int32Array bookmark_level_array, bool is_show_serial_number, bool include_toc_pages)
Constructor, with parameter.
Definition: fs_pdfdoc.h:618
If set, do not display a watermark.
Definition: fs_pdfdoc.h:76
bool enable_remove_link
A boolean value indicating whether to remove hyperlink annotations.
Definition: fs_pdfdoc.h:482
ErrorCode Load(const String &password="")
Load current document content by using a specified password.
Definition: fs_pdfdoc.h:59
bool is_show_serial_number
true means to show the serial number in the table of contents, while false means not to show the seri...
Definition: fs_pdfdoc.h:715
RMSEncryptData GetRMSEncryptData() const
Get encrypt data of RMS encryption.
common::Progressive StartSaveAsPayloadFile(const wchar_t *file_path, const wchar_t *payload_file_path, const wchar_t *crypto_filter, const wchar_t *description, float version, uint32 save_flags=PDFDoc::e_SaveFlagNormal, common::PauseCallback *pause=0)
Start to save current PDF document as a wrapper document with a payload document (defined in PDF 2....
CFX_Object Object
Object type.
Definition: fs_basictypes.h:220
Save document normally, without using any special flag.
Definition: fs_pdfdoc.h:886
Extract PDF contents. (Bit 5 in permission value)
Definition: fs_pdfdoc.h:842
Definition: fs_annot.h:1666
bool HidePageTemplate(const wchar_t *template_name)
Hide a named page.
float version
The version number of the cryptographic filter used to encrypt the encrypted payload referenced by th...
Definition: fs_pdfdoc.h:362
Assemble PDF document. (Bit 11 in permission value)
Definition: fs_pdfdoc.h:867
bool enable_remove_metadata
A boolean value indicating whether to remove document metadata.
Definition: fs_pdfdoc.h:419
Unknown rotation.
Definition: fs_common.h:67
Encryption type: password, which is the standard encryption.
Definition: fs_pdfdoc.h:805
bool operator==(const TableOfContentsConfig &other) const
Equal operator.
Definition: fs_pdfdoc.h:653
bool ExportAnnotToFDF(const annots::Annot &pdf_annot, const fdf::FDFDoc &fdf_doc)
Export specified annotation to a FDF/XFDF document.
PayLoadData(const PayLoadData &payload_data)
Constructor, with another payload data object.
Definition: fs_pdfdoc.h:318
objects::PDFDictionary * GetTrailer() const
Get the trailer dictionary.
WrapperType
Enumeration for wrapper type.
Definition: fs_pdfdoc.h:1031
If set, the watermark will be a part of page content when inserted to a PDF page.
Definition: fs_pdfdoc.h:68
Modify PDF contents. (Bit 4 in permission value)
Definition: fs_pdfdoc.h:836
PagingSealSignature AddPagingSealSignature(const common::Range &page_range, float width, float height, bool to_check_permission=true)
Add a paging seal signature to document by page range.
SecurityHandler GetSecurityHandler()
Get current PDF security handler of current document.
Int32Array bookmark_level_array
A bookmark level array which is used to specify bookmarks to be used to generate "Table of Contents"....
Definition: fs_pdfdoc.h:712
float row_space
The row spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative nu...
Definition: fs_pdfdoc.h:174
bool enable_remove_hidden_text
A boolean value indicating whether to remove hidden text.
Definition: fs_pdfdoc.h:461
Definition: fs_basictypes.h:227
bool SetOpenAction(actions::Action &action)
Set the action to be performed when the document is opened.
Definition: fs_pdfdoc.h:573
TiledWatermarkSettings(float row_space, float col_space, float rotation, int opacity, int scale, uint32 flags)
Constructor, with parameters.
Definition: fs_pdfdoc.h:94
A user password is used in PDF document.
Definition: fs_pdfdoc.h:789
WString description
Description for payload file to show applications or confront users prompt information.
Definition: fs_pdfdoc.h:370
Save document without updating metadata "ModDate" and "CreationDate".
Definition: fs_pdfdoc.h:928
bool ImportFromFDF(const fdf::FDFDoc &fdf_doc, int types=pdf::PDFDoc::e_Forms|pdf::PDFDoc::e_Annots, const common::Range &page_range=common::Range())
Import form fields and annotations from a FDF/XFDF document.
annots::AnnotArray GetAnnotsByIdArray(const WStringArray &unique_id_arr)
Get annotations by the unique ID array.
PageBasicInfo()
Constructor.
Definition: fs_pdfdoc.h:512
common::Progressive StartLoad(const String &password="", bool is_cache_stream=true, common::PauseCallback *pause=0)
Start to loading current document content by using a specified password.
int64 GetWrapperOffset() const
Get wrapper offset if current document's wrapper type is PDFDoc::e_WrapperFoxit.
common::Progressive StartImportPages(int dest_index, const PDFDoc &src_doc, uint32 flags=PDFDoc::e_ImportFlagNormal, const char *layer_name="", const common::Range &page_range=common::Range(), common::PauseCallback *pause=0)
Start to import pages from another PDF document (via PDF document object).
bool MovePagesTo(const common::Range &page_range, int dest_index)
Move one or more pages (specified by index) to a new position.
int GetSize() const
Get the number of elements in the array.
Definition: fx_basic.h:1360
WString crypto_filter
The name of the cryptographic filter used to encrypt the encrypted payload document.
Definition: fs_pdfdoc.h:364
Header file for file operation related definitions and functions.
bool operator !=(const TableOfContentsConfig &other) const
Not equal operator.
Definition: fs_pdfdoc.h:673
File reading interface.
Definition: fx_stream.h:587
void UpdateHeaderFooter(const HeaderFooter &headerfooter)
Update header-footer.
Import pages with layers.
Definition: fs_pdfdoc.h:940
If set, that means structure tree will be extracted as well.
Definition: fs_pdfdoc.h:958
objects::PDFDictionary * GetCatalog() const
Get the catalog dictionary.
Encryption type: customized encryption.
Definition: fs_pdfdoc.h:811
WIDE STRING CLASS.
Definition: fx_string.h:1461
bool IsLinearized() const
Check if current PDF document is a linearized file.
WString description
Description for wrapper file to show applications or confront users prompt information.
Definition: fs_pdfdoc.h:283
Save document without original data or unchanged objects.
Definition: fs_pdfdoc.h:902
Save document incrementally.
Definition: fs_pdfdoc.h:894
bool IsWrapper() const
Check whether current document is a wrapper file or not.
CFX_WideString WString
Wide string.
Definition: fs_basictypes.h:222
void SetFileVersion(int version)
Set the PDF file version which will be stored in PDF header section of the saved PDF file.
bool ExportFormFieldsToFDF(const pdf::interform::FieldArray &field_array, bool is_include, const fdf::FDFDoc &fdf_doc)
Export specified form fields to a FDF/XFDF document.
int GetFileVersion()
Get PDF file version stored in PDF header section.
float height
Page height (unit is 1/72 inch).
Definition: fs_pdfdoc.h:558
No password is used in PDF document.
Definition: fs_pdfdoc.h:787
PasswordType CheckPassword(const String &password)
Check the type of a specified password.
PasswordType GetPasswordType() const
Get the type of current used password.
FX_UINT64 uint64
Unsigned 64-bit integer.
Definition: fs_basictypes.h:191
uint32 GetUserPermissions() const
Get user access permissions.
HeaderFooter GetEditableHeaderFooter()
Get the editable header footer object.
If set, that means attachment files will be extracted as well.
Definition: fs_pdfdoc.h:969
Print PDF document with higher qualities. (Bit 12 in permission value)
Definition: fs_pdfdoc.h:873
Definition: fs_pdfdoc.h:287
Definition: fs_pdfdoc.h:776
Configuration settings for removing hidden or sensitive data from a PDF document.
Definition: fs_pdfdoc.h:374
Normal document.
Definition: fs_pdfdoc.h:1033
Definition: fs_security.h:646
PayLoadData & operator=(const PayLoadData &payload_data)
Assign operator.
Definition: fs_pdfdoc.h:333
ReadingBookmark InsertReadingBookmark(int reading_bookmark_index, const WString &title, int dest_page_index)
Insert a reading bookmark to current PDF document.
int GetBookmarkLevelDepth()
Get bookmark level depth.
bool IsEmpty() const
Check whether current object is empty or not.
bool RemoveAllHeaderFooters()
Remove all header-footers.
int64 file_size
The payload file size.
Definition: fs_pdfdoc.h:368
(Reserved, not supported yet) If set, only link annotations are to imported from or exported to XFDF ...
Definition: fs_pdfdoc.h:1023
bool ExportToFDF(const fdf::FDFDoc &fdf_doc, int types=pdf::PDFDoc::e_Forms|pdf::PDFDoc::e_Annots, const common::Range &page_range=common::Range())
Export form fields and annotations to a FDF/XFDF document.
bool IsOwnerPassword(const String &password)
Check if input password is the owner password of current PDF document.
Definition: fs_watermark.h:333
An owner password is used in PDF document.
Definition: fs_pdfdoc.h:791
If set, show watermark above other page content.
Definition: fs_pdfdoc.h:72
ExtractPagesOptions
Enumeration for options used for extracting pages.
Definition: fs_pdfdoc.h:954
Header file for bookmark related definitions and classes.
Definition: fs_fdfdoc.h:51
objects::PDFDictionary * GetPagesDict() const
Get the dictionary of "Pages".
Definition: fs_security.h:1027
EmbeddedFontData(const EmbeddedFontData &other)
Constructor, with another embedded font data object.
Definition: fs_pdfdoc.h:583
Definition: fs_security.h:137
Import pages without cloning stream objects into memory.
Definition: fs_pdfdoc.h:946
Definition: fs_pdfdoc.h:567
common::Progressive StartGetPayloadFile(foxit::common::file::WriterCallback *payload_file, common::PauseCallback *pause=0)
Start to get payload file.
void RemoveStructTree()
Remove structure tree from current PDF document.
Header file for reading bookmark related definitions and classes.
bool DoJSOpenAction()
Perform JavaScript actions when the document is opened.
If set, that means OCProperties will be extracted as well.
Definition: fs_pdfdoc.h:962
int GetSignatureCount()
Get the count of signature.
uint64 GetFileSize()
Get file size.
WStringArray nonstandard_font_name_array
Font name array of embedded fonts which cannot be replaced by system fonts if they are to be unembede...
Definition: fs_pdfdoc.h:601
Definition: fs_signature.h:2091
Definition: fs_pdfdoc.h:496
SaveFlags
Enumeration for PDF document saving flags.
Definition: fs_pdfdoc.h:880
ErrorCode LoadW(const WString &password=WString())
Load current document content by using a specified password.
ErrorCode
Enumeration for error code.
Definition: fs_basictypes.h:236
PageBasicInfo(float width, float height, common::Rotation rotation)
Constructor, with parameters.
Definition: fs_pdfdoc.h:506
WString type
Wrapper type to indicate a type of the current wrapper file.
Definition: fs_pdfdoc.h:277
int scale
The image or page scale in percents. Valid range: from 1 to 100. 100 means the image or page is displ...
Definition: fs_pdfdoc.h:192
EmbeddedFontData & operator=(const EmbeddedFontData &other)
Assign operator.
Definition: fs_pdfdoc.h:594
EmbeddedFontData()
Constructor.
Definition: fs_pdfdoc.h:576
void Sanitize()
Removes all hidden or potentially sensitive information from the current PDF document using default s...
int GetFontCount()
Count all the PDF fonts used in current PDF document.
common::Progressive StartAddTiledWatermark(const wchar_t *text, const TiledWatermarkSettings &settings, const WatermarkTextProperties &properties, const common::Range &page_range, common::PauseCallback *pause=0)
Add text type tiled watermark to PDF pages.
Import pages normally.
Definition: fs_pdfdoc.h:938
Definition: fs_pdfdoc.h:205
File stream interface, reading & writing.
Definition: fx_stream.h:692
bool RemoveOpenAction()
Remove the action to be performed when the document is opened.
When document is opened, neither document outlines nor thumbnail images are visible.
Definition: fs_pdfdoc.h:995
DisplayMode
Enumeration for display mode which specifies how the document should be displayed when opened.
Definition: fs_pdfdoc.h:993
bool IsUserPassword(const String &password)
Check if input password is the user password of current PDF document.
float width
Page width (unit is 1/72 inch).
Definition: fs_pdfdoc.h:555
TiledWatermarkSettings & operator=(const TiledWatermarkSettings &settings)
Assign operator.
Definition: fs_pdfdoc.h:137
void Set(const wchar_t *title, Int32Array bookmark_level_array, bool is_show_serial_number, bool include_toc_pages)
Set value.
Definition: fs_pdfdoc.h:696
EncryptType GetEncryptionType() const
Get the encryption type.
bool HasLayer() const
Check whether current PDF document has layer (known as "Optional content group" in <PDF reference 1....
objects::PDFDictionary * GetEncryptDict() const
Get the encrypt dictionary.
common::Progressive StartEmbedAllFonts(common::PauseCallback *pause=0)
Start to convert all un-embeded fonts to embeded fonts.
WString GetPageText(int page_index) const
Get the specified PDF page text which the text is in display order.
Size
Enumeration for page size type.
Definition: fs_pdfpage.h:490
WString file_name
The payload file name.
Definition: fs_pdfdoc.h:366
Definition: fx_basic.h:3758
If set, that means signature will be extracted as well. It must be combined with PDFDoc:e_ExtractPage...
Definition: fs_pdfdoc.h:973
objects::PDFDictionary * GetInfo() const
Get the information dictionary.
bool IsXFA() const
Check whether current PDF document is an XFA document.
If set, do not print a watermark.
Definition: fs_pdfdoc.h:74
float rotation
Rotation angle in degrees.
Definition: fs_pdfdoc.h:180
When document is opened, full-screen mode, with no menu bar, window controls, or any other windows ar...
Definition: fs_pdfdoc.h:1004
Print PDF document with normal mode. (Bit 3 in permission value)
Definition: fs_pdfdoc.h:829
PageBasicInfoArray GetAllPageBasicInfo()
Get the basic information of all page.
(Reserved, currently, this value is not used.) Encryption type: Foxit connected PDF DRM encryption.
Definition: fs_pdfdoc.h:815
Save document as a linearized file.
Definition: fs_pdfdoc.h:914
When document is opened, document outlines (bookmarks) are visible.
Definition: fs_pdfdoc.h:997
bool IsPortfolio()
Check whether current PDF document is a portfolio file or not.
PasswordType
Enumeration for the type of current used password in a PDF document.
Definition: fs_pdfdoc.h:783
When document is opened, optional content group panels are visible.
Definition: fs_pdfdoc.h:1006
Definition: fs_common.h:373
PDFPage AddPageFromTemplate(const wchar_t *template_name)
Adds a new PDF page to document, from a named template.
FX_INT64 int64
Signed 64-bit integer.
Definition: fs_basictypes.h:189
const TYPE GetAt(int nIndex) const
This method retrieves an element specified by an index number.
Definition: fx_basic.h:1396
CustomEncryptData GetCustomEncryptData() const
Get encrypt data of custom encryption.
If set, that means annotations related to extracted pages will be extracted as well.
Definition: fs_pdfdoc.h:956
InsertDocOptions
Enumeration for options used for inserting a PDF document to another.
Definition: fs_pdfdoc.h:981
Disabilities support. (Bit 10 in permission value)
Definition: fs_pdfdoc.h:860
DataType
Enumeration for data type used to decide which object(s) will be imported from or exported to FDF/XFD...
Definition: fs_pdfdoc.h:1017
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:195
void SetDisplayMode(DisplayMode display_mode)
Set the display mode.
Save document with removing redundant PDF objects.
Definition: fs_pdfdoc.h:921
Definition: fs_pdfpage.h:412
bool RemoveReadingBookmark(const ReadingBookmark &reading_bookmark)
Remove a reading bookmark from current PDF document.
Encryption type: digital certificate encryption.
Definition: fs_pdfdoc.h:807
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:213
WrapperType GetWrapperType() const
Get Wrapper type.
EmbeddedFontData GetEmbeddedFontData()
Get embedded font data.
If set, that means bookmark will be inserted to target document as well.
Definition: fs_pdfdoc.h:985
Header file for common definitions and classes.
When document is opened, attachment panels are visible.
Definition: fs_pdfdoc.h:1008
HiddenInfoSettingData & operator=(const HiddenInfoSettingData &data)
Assign operator.
Definition: fs_pdfdoc.h:399
ReadingBookmark GetReadingBookmark(int index)
Get a reading bookmark by index.
No encryption pattern.
Definition: fs_pdfdoc.h:803
void Set(int version, const wchar_t *type, const wchar_t *app_id, const wchar_t *uri, const wchar_t *description)
Set value.
Definition: fs_pdfdoc.h:266
The password is invalid.
Definition: fs_pdfdoc.h:785
PDFDoc & operator=(const PDFDoc &other)
Assign operator.
If set, that means bookmark will be extracted as well.
Definition: fs_pdfdoc.h:971
void DeleteIndirectObject(uint32 object_number)
Delete an indirect object by indirect object number.
bool enable_remove_searchIndex
A boolean value indicating whether to remove the search index.
Definition: fs_pdfdoc.h:440
Definition: fs_security.h:890
bool operator !=(const PDFDoc &other) const
Not equal operator.
objects::PDFObject * GetIndirectObject(uint32 object_number)
Get an indirect object by indirect object number.
WString uri
The URI for consumers to get more information.
Definition: fs_pdfdoc.h:281
float col_space
The column spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative...
Definition: fs_pdfdoc.h:177
Header file for PDF object related definitions and classes.
Encryption type: Microsoft RMS encryption.
Definition: fs_pdfdoc.h:813
Definition: fs_basictypes.h:451
If set, that means attachments will be inserted to target document as well.
Definition: fs_pdfdoc.h:983
DisplayMode GetDisplayMode() const
Get the display mode.
String GetHeader() const
Get PDF header identifying the version of the PDF specification to which the file conforms.
common::Font GetFont(int index)
Get a font by index.
Fill PDF form. (Bit 9 in permission value)
Definition: fs_pdfdoc.h:854
int GetPageCount() const
Get the count of pages.
bool enable_remove_comment
A boolean value indicating whether to remove comments and annotations.
Definition: fs_pdfdoc.h:447
bool enable_remove_overlaping
A boolean value indicating whether to remove overlapping objects.
Definition: fs_pdfdoc.h:489
void RemoveHiddenInfo(const HiddenInfoSettingData &hidden_data_setting)
Removes specified types of hidden information from the current PDF document based on user-defined set...
Header file for PDF page related definitions and classes.
PDFPage GetPage(int index)
Get a PDF page by index.
bool RemoveSecurity()
Remove the security handler from current document, so that the later saved document will be unencrypt...
CertificateEncryptData GetCertificateEncryptData() const
Get encrypt data of certificate encryption.
WrapperData(int version, const wchar_t *type, const wchar_t *app_id, const wchar_t *uri, const wchar_t *description)
Constructor, with parameters.
Definition: fs_pdfdoc.h:220
Definition: fs_annot.h:1006
PDFPage InsertPage(int index, float width, float height)
Insert a new blank PDF page to document, by index.
Save document by using XRef stream.
Definition: fs_pdfdoc.h:907
Definition: fs_security.h:56
Definition: fs_common.h:1523
Definition: fs_pdfobject.h:850
bool IsEncrypted() const
Check whether current document is an encrypted file or not.
void Set(float row_space, float col_space, float rotation, int opacity, int scale, uint32 flags)
Set value.
Definition: fs_pdfdoc.h:164
String GetUserPassword(const String &owner_password)
Get the user password based on owner password.
If set, that means to use PDFDoc::e_SaveFlagXRefStream saving flag for the result file in order to re...
Definition: fs_pdfdoc.h:967
actions::Action GetOpenAction()
Get the action to be performed when the document is opened.
PayLoadData(float version, const wchar_t *crypto_filter, const wchar_t *file_name, foxit::int64 file_size, const wchar_t *description)
Constructor, with parameters.
Definition: fs_pdfdoc.h:303
bool SaveAs(const char *file_path, uint32 save_flags=PDFDoc::e_SaveFlagNormal)
Save current PDF document as another PDF file.
Rotation
Enumeration for rotation.
Definition: fs_common.h:57
Foxit namespace.
Definition: fs_taggedpdf.h:27
Definition: fs_pdfobject.h:55
WrapperData & operator=(const WrapperData &wrapper_data)
Assign operator.
Definition: fs_pdfdoc.h:246
DRMEncryptData GetDRMEncryptData() const
Get encrypt data of Foxit DRM encryption.
Definition: fs_action.h:418
bool enable_remove_bookmark
A boolean value indicating whether to remove bookmarks.
Definition: fs_pdfdoc.h:433
WString app_id
Application identity to indicate applications to open this wrapper data.
Definition: fs_pdfdoc.h:279
common::Progressive StartLoadW(const WString &password=WString(), bool is_cache_stream=true, common::PauseCallback *pause=0)
Start to loading current document content by using a specified password.
If set, that means Javascript will be extracted as well.
Definition: fs_pdfdoc.h:960
If set, the watermark will be an annotation when inserted to a PDF page, and the watermark will be sh...
Definition: fs_pdfdoc.h:70
BYTE STRING CLASS.
Definition: fx_string.h:317
Unknown encryption type.
Definition: fs_pdfdoc.h:801
EncryptType
Enumeration for encryption type.
Definition: fs_pdfdoc.h:799
int opacity
Opacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.
Definition: fs_pdfdoc.h:186
void CreateDSS()
Create DSS information in current PDF document.
common::Progressive StartExtractPages(const char *file_path, uint32 options, const common::Range &page_range=common::Range(), common::PauseCallback *pause=0)
Start to extract pages from current PDF document.
bool IsTaggedPDF() const
Check if current PDF document is a Tagged PDF file.
PDF 2.0 wrapper document.
Definition: fs_pdfdoc.h:1037
bool enable_remove_content
A boolean value indicating whether to remove invisible or obscured content.
Definition: fs_pdfdoc.h:475
common::Rotation rotation
Page rotation. Please refer to values starting from common::e_Rotation0 and this should be one of the...
Definition: fs_pdfdoc.h:563
uint32 flags
Watermark flags.
Definition: fs_pdfdoc.h:201
TableOfContentsConfig & operator=(const TableOfContentsConfig &other)
Assign operator.
Definition: fs_pdfdoc.h:638
When document is opened, thumbnail images are visible.
Definition: fs_pdfdoc.h:999
bool enable_remove_hidden_layer
A boolean value indicating whether to remove hidden layers (Optional Content Groups).
Definition: fs_pdfdoc.h:468
HiddenInfoSettingData()
Constructs a HiddenDataSetting object with all removal options enabled by default.
Definition: fs_pdfdoc.h:379
void InsertDocument(int dest_index, const PDFDoc &src_doc, uint32 options)
Insert another PDF document to the specified location of current PDF document.
TableOfContentsConfig()
Constructor.
Definition: fs_pdfdoc.h:625
#define NULL
The null-pointer value.
Definition: fx_system.h:792
Definition: fs_signature.h:99
Page size: letter.
Definition: fs_pdfpage.h:492
void RemoveSignature(const foxit::pdf::Signature &signature)
Remove a signature.
WString title
Title for the table of contents. If this is an empty string, the default value "Table of Contents" wi...
Definition: fs_pdfdoc.h:704
PayLoadData()
Constructor.
Definition: fs_pdfdoc.h:290
Encryption type: Foxit DRM encryption.
Definition: fs_pdfdoc.h:809
common::Progressive StartImportPagesFromFilePath(int dest_index, const wchar_t *src_file_path, const String &password, uint32 flags=PDFDoc::e_ImportFlagNormal, const char *layer_name="", const common::Range &page_range=common::Range(), common::PauseCallback *pause=0)
Start to import pages from another PDF document (via file path).
WrapperData GetWrapperData() const
Get wrapper data if current document's wrapper type is PDFDoc::e_WrapperFoxit.
PageBasicInfo & operator=(const PageBasicInfo &page_info)
Assign operator.
Definition: fs_pdfdoc.h:532
PageBasicInfo(const PageBasicInfo &page_info)
Constructor, with another page basic information object.
Definition: fs_pdfdoc.h:521
void AddHeaderFooter(const HeaderFooter &headerfooter)
Add new header-footer.
foxit::pdf::Signature GetSignature(int index)
Get a signature by index.
Definition: fs_security.h:365
void AddTableOfContents(const wchar_t *title, Int32Array bookmark_level_array)
Insert page(s) as the table of contents to the front of current PDF document.
Definition: fs_pdfdoc.h:607
bool RemovePage(int index)
Remove a PDF page by page index.
void SetCacheFile(foxit::common::file::StreamCallback *file_stream, bool is_own_file_stream)
Set cache file (represented by a file stream) to current PDF document.
WrapperData()
Constructor.
Definition: fs_pdfdoc.h:208
Definition: fs_bookmark.h:58
bool HasHeaderFooter()
Check whether current document has header-footer.
void Set(float width, float height, common::Rotation rotation)
Set value.
Definition: fs_pdfdoc.h:548
Definition: fs_readingbookmark.h:43
UserPermissions
Enumeration for user access permissions in a PDF document.
Definition: fs_pdfdoc.h:823
WrapperData(const WrapperData &wrapper_data)
Constructor, with another wrapper data object.
Definition: fs_pdfdoc.h:232
Foxit wrapper document.
Definition: fs_pdfdoc.h:1035
PayLoadData GetPayLoadData()
Get payload data if current document's wrapper type is PDFDoc::e_WrapperPDFV2.
uint32 AddIndirectObject(objects::PDFObject *pdf_object)
Add a PDF object to current PDF document, to be an indirect object.
bool MovePageTo(const PDFPage &page, int dest_index)
Move a specified page to a new position.