Go to the documentation of this file.
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;
655 typedef enum _PasswordType {
671 typedef enum _EncryptType {
695 typedef enum _UserPermissions {
752 typedef enum _SaveFlags {
807 typedef enum _ImportPageFlags {
825 typedef enum _ExtractPagesOptions {
848 typedef enum _InsertDocOptions {
858 typedef enum _DisplayMode {
882 typedef enum _DataType {
896 typedef enum _WrapperType {
922 explicit PDFDoc(
const char* path);
932 explicit PDFDoc(
const wchar_t* path);
944 explicit PDFDoc(
const void* buffer,
size_t size);
1301 #ifndef __EMSCRIPTEN_RENDER__
1517 #ifndef __EMSCRIPTEN_RENDER__
1825 uint32 user_permissions = 0xFFFFFFFC,
const char* owner_password =
"");
1855 const wchar_t* crypto_filter,
const wchar_t* description,
float version,
1877 #ifndef __EMSCRIPTEN_RENDER__
2119 const wchar_t* src_file_path,
const String& password,
2175 const wchar_t* src_file_path,
const WString& password,
2327 #ifndef __EMSCRIPTEN_RENDER__
2548 #ifdef _SUPPORTWEBSDK_
2797 #endif // FS_PDFDOC_H_
FX_INT64 int64
Signed 64-bit integer.
Definition: fs_basictypes.h:190
When document is opened, full-screen mode, with no menu bar, window controls, or any other windows ar...
Definition: fs_pdfdoc.h:869
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
int GetFileVersion()
Get PDF file version stored in PDF header section.
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.
int GetReadingBookmarkCount()
Get the count of reading bookmarks.
PasswordType GetPasswordType() const
Get the type of current used password.
File writing interface.
Definition: fx_stream.h:453
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.
int GetSize() const
Get the number of elements in the array.
Definition: fx_basic.h:1360
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:592
void SetDisplayMode(DisplayMode display_mode)
Set the display mode.
bool RemoveReadingBookmark(const ReadingBookmark &reading_bookmark)
Remove a reading bookmark from current PDF document.
bool IsTaggedPDF() const
Check if current PDF document is a Tagged PDF file.
objects::PDFDictionary * GetEncryptDict() const
Get the encrypt dictionary.
SaveFlags
Enumeration for PDF document saving flags.
Definition: fs_pdfdoc.h:752
bool RemoveOpenAction()
Remove the action to be performed when the document is opened.
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
Definition: fs_pdfdoc.h:481
If set, that means OCProperties will be extracted as well.
Definition: fs_pdfdoc.h:833
objects::PDFDictionary * GetCatalog() const
Get the catalog dictionary.
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.
bool operator==(const PDFDoc &other) const
Equal operator.
WrapperData()
Constructor.
Definition: fs_pdfdoc.h:204
WString description
Description for wrapper file to show applications or confront users prompt information.
Definition: fs_pdfdoc.h:279
int64 GetWrapperOffset() const
Get wrapper offset if current document's wrapper type is PDFDoc::e_WrapperFoxit.
A user password is used in PDF document.
Definition: fs_pdfdoc.h:661
UserPermissions
Enumeration for user access permissions in a PDF document.
Definition: fs_pdfdoc.h:695
Definition: fs_action.h:418
void UpdateHeaderFooter(const HeaderFooter &headerfooter)
Update header-footer.
PDF 2.0 wrapper document.
Definition: fs_pdfdoc.h:902
Definition: fs_annot.h:994
bool DoJSOpenAction()
Perform JavaScript actions when the document is opened.
uint32 GetUserPermissions() const
Get user access permissions.
bool MovePageTo(const PDFPage &page, int dest_index)
Move a specified page to a new index position.
foxit::pdf::Signature GetSignature(int index)
Get a signature by index.
String GetHeader() const
Get PDF header identifying the version of the PDF specification to which the file conforms.
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.
Definition: fs_pdfdoc.h:283
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:492
Definition: fs_pdfdoc.h:201
Size
Enumeration for page size type.
Definition: fs_pdfpage.h:490
CFX_Object Object
Object type.
Definition: fs_basictypes.h:221
WString file_name
The payload file name.
Definition: fs_pdfdoc.h:362
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:587
SecurityHandler GetSecurityHandler()
Get current PDF security handler of current document.
Definition: fs_common.h:373
If set, do not display a watermark.
Definition: fs_pdfdoc.h:76
Definition: fs_security.h:365
int version
Wrapper version.
Definition: fs_pdfdoc.h:271
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:299
EmbeddedFontData(const EmbeddedFontData &other)
Constructor, with another embedded font data object.
Definition: fs_pdfdoc.h:457
bool ExportAnnotToFDF(const annots::Annot &pdf_annot, const fdf::FDFDoc &fdf_doc)
Export specified annotation to a FDF/XFDF document.
bool operator==(const TableOfContentsConfig &other) const
Equal operator.
Definition: fs_pdfdoc.h:527
bool IsLinearized() const
Check if current PDF document is a linearized file.
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.
EmbeddedFontData()
Constructor.
Definition: fs_pdfdoc.h:450
WrapperType
Enumeration for wrapper type.
Definition: fs_pdfdoc.h:896
File stream interface, reading & writing.
Definition: fx_stream.h:675
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:585
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.
bool RemoveSecurity()
Remove the security handler from current document, so that the later saved document will be unencrypt...
Header file for common definitions and classes.
TiledWatermarkSettings()
Constructor and set the default value.
Definition: fs_pdfdoc.h:109
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.
bool RemoveAllHeaderFooters()
Remove all header-footers.
DisplayMode
Enumeration for display mode which specifies how the document should be displayed when opened.
Definition: fs_pdfdoc.h:858
If set, that means Javascript will be extracted as well.
Definition: fs_pdfdoc.h:831
When document is opened, thumbnail images are visible.
Definition: fs_pdfdoc.h:864
No encryption pattern.
Definition: fs_pdfdoc.h:675
Save document without original data or unchanged objects.
Definition: fs_pdfdoc.h:773
TiledWatermarkSettings(float row_space, float col_space, float rotation, int opacity, int scale, uint32 flags)
Constructor, with parameters.
Definition: fs_pdfdoc.h:94
bool operator!=(const PDFDoc &other) const
Not equal operator.
bool RemoveBookmark(const Bookmark &bookmark)
Remove a specified bookmark.
File reading interface.
Definition: fx_stream.h:570
objects::PDFObject * GetIndirectObject(uint32 object_number)
Get an indirect object by indirect object number.
void CreateDSS()
Create DSS information in current PDF document.
Save document without updating metadata "ModDate" and "CreationDate".
Definition: fs_pdfdoc.h:799
Header file for file operation related definitions and functions.
StdEncryptData GetStdEncryptData() const
Get encrypt data of standard encryption (known as password encryption).
Definition: fs_security.h:961
objects::PDFDictionary * GetInfo() const
Get the information dictionary.
void SetFileVersion(int version)
Set the PDF file version which will be stored in PDF header section of the saved PDF file.
WString description
Description for payload file to show applications or confront users prompt information.
Definition: fs_pdfdoc.h:366
String GetUserPassword(const String &owner_password)
Get the user password based on owner password.
EmbeddedFontData & operator=(const EmbeddedFontData &other)
Assign operator.
Definition: fs_pdfdoc.h:468
WrapperData GetWrapperData() const
Get wrapper data if current document's wrapper type is PDFDoc::e_WrapperFoxit.
ErrorCode
Enumeration for error code.
Definition: fs_basictypes.h:237
Encryption type: Foxit DRM encryption.
Definition: fs_pdfdoc.h:681
Import pages normally.
Definition: fs_pdfdoc.h:809
common::Progressive StartEmbedAllFonts(common::PauseCallback *pause=0)
Start to convert all un-embeded fonts to embeded fonts.
int GetSignatureCount()
Get the count of signature.
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.
Definition: fs_pdfobject.h:55
common::Font GetFont(int index)
Get a font by index.
bool operator!=(const TableOfContentsConfig &other) const
Not equal operator.
Definition: fs_pdfdoc.h:547
Definition: fs_watermark.h:333
void ClearRenderCache()
Clear the cache used during rendering, to reduce the memory usage.
Encryption type: password, which is the standard encryption.
Definition: fs_pdfdoc.h:677
bool IsPortfolio()
Check whether current PDF document is a portfolio file or not.
bool RemovePage(int index)
Remove a PDF page by page index.
ReadingBookmark GetReadingBookmark(int index)
Get a reading bookmark by index.
Assemble PDF document. (Bit 11 in permission value)
Definition: fs_pdfdoc.h:739
DisplayMode GetDisplayMode() const
Get the display mode.
When document is opened, optional content group panels are visible.
Definition: fs_pdfdoc.h:871
bool HasLayer() const
Check whether current PDF document has layer (known as "Optional content group" in <PDF reference 1....
PDFPage GetPage(int index)
Get a PDF page by index.
(Reserved, not supported yet) If set, only link annotations are to imported from or exported to XFDF ...
Definition: fs_pdfdoc.h:888
uint64 GetFileSize()
Get file size.
Save document with removing redundant PDF objects.
Definition: fs_pdfdoc.h:792
int scale
The image or page scale in percents. Valid range: from 0 to 100. 0 means not displayed,...
Definition: fs_pdfdoc.h:188
When document is opened, attachment panels are visible.
Definition: fs_pdfdoc.h:873
DataType
Enumeration for data type used to decide which object(s) will be imported from or exported to FDF/XFD...
Definition: fs_pdfdoc.h:882
If set, form fields are to imported from or exported to FDF/XFDF document.
Definition: fs_pdfdoc.h:884
Definition: fs_security.h:824
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:475
ExtractPagesOptions
Enumeration for options used for extracting pages.
Definition: fs_pdfdoc.h:825
PDFPage InsertPage(int index, float width, float height)
Insert a new blank PDF page to document, by index.
RMSEncryptData GetRMSEncryptData() const
Get encrypt data of RMS encryption.
(Reserved, currently, this value is not used.) Encryption type: Foxit connected PDF DRM encryption.
Definition: fs_pdfdoc.h:687
BYTE STRING CLASS.
Definition: fx_string.h:317
Definition: fs_annot.h:1654
actions::Action GetOpenAction()
Get the action to be performed when the document is opened.
PageBasicInfo(float width, float height, common::Rotation rotation)
Constructor, with parameters.
Definition: fs_pdfdoc.h:383
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
When document is opened, neither document outlines nor thumbnail images are visible.
Definition: fs_pdfdoc.h:860
Encryption type: Microsoft RMS encryption.
Definition: fs_pdfdoc.h:685
bool MovePagesTo(const common::Range &page_range, int dest_index)
Move one or more pages (specified by index) to a new index position.
bool HasHeaderFooter()
Check whether current document has header-footer.
PageBasicInfo()
Constructor.
Definition: fs_pdfdoc.h:389
WString GetPageText(int page_index) const
Get the specified PDF page text which the text is in display order.
Unknown encryption type.
Definition: fs_pdfdoc.h:673
WString type
Wrapper type to indicate a type of the current wrapper file.
Definition: fs_pdfdoc.h:273
Definition: fs_signature.h:99
int GetFirstAvailPageIndex() const
Get the page index of the fist available page.
const TYPE GetAt(int nIndex) const
This method retrieves an element specified by an index number.
Definition: fx_basic.h:1396
Definition: fs_security.h:137
bool HidePageTemplate(const wchar_t *template_name)
Hide a named page.
WString uri
The URI for consumers to get more information.
Definition: fs_pdfdoc.h:277
int GetBookmarkLevelDepth()
Get bookmark level depth.
Rotation
Enumeration for rotation.
Definition: fs_common.h:57
bool IsUserPassword(const String &password)
Check if input password is the user password of current PDF document.
Unknown rotation.
Definition: fs_common.h:67
When document is opened, document outlines (bookmarks) are visible.
Definition: fs_pdfdoc.h:862
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).
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:570
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.
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.
PDFDoc & operator=(const PDFDoc &other)
Assign operator.
Header file for PDF object related definitions and classes.
Definition: fs_pdfdoc.h:373
int GetPageCount() const
Get the count of pages.
Header file for PDF page related definitions and classes.
PayLoadData & operator=(const PayLoadData &payload_data)
Assign operator.
Definition: fs_pdfdoc.h:329
annots::AnnotArray GetAnnotsByIdArray(const WStringArray &unique_id_arr)
Get annotations by the unique ID array.
Fill PDF form. (Bit 9 in permission value)
Definition: fs_pdfdoc.h:726
bool SaveAs(const char *file_path, uint32 save_flags=PDFDoc::e_SaveFlagNormal)
Save current PDF document as another PDF file.
CFX_WideString WString
Wide string.
Definition: fs_basictypes.h:223
EncryptType
Enumeration for encryption type.
Definition: fs_pdfdoc.h:671
PageBasicInfo & operator=(const PageBasicInfo &page_info)
Assign operator.
Definition: fs_pdfdoc.h:409
common::Progressive StartRecognizeForm(common::PauseCallback *pause=0)
Start to recognize form in current PDF document.
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:216
Foxit namespace.
Definition: fs_taggedpdf.h:27
Definition: fs_security.h:56
PayLoadData()
Constructor.
Definition: fs_pdfdoc.h:286
uint32 AddIndirectObject(objects::PDFObject *pdf_object)
Add a PDF object to current PDF document, to be an indirect object.
Definition: fs_bookmark.h:58
void InsertDocument(int dest_index, const PDFDoc &src_doc, uint32 options)
Insert another PDF document to the specified location of current PDF document.
PageBasicInfo GetPageBasicInfo(int index)
Get the basic information of a page specified by index.
void RemoveSignature(const foxit::pdf::Signature &signature)
Remove a signature.
Save document incrementally.
Definition: fs_pdfdoc.h:765
Definition: fs_readingbookmark.h:43
int opacity
Opacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.
Definition: fs_pdfdoc.h:183
If set, that means attachment files will be extracted as well.
Definition: fs_pdfdoc.h:840
If set, annotations (except link annotations) are to imported from or exported to FDF/XFDF document.
Definition: fs_pdfdoc.h:886
Definition: fx_basic.h:3758
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:176
ErrorCode LoadW(const WString &password=WString())
Load current document content by using a specified password.
Encryption type: digital certificate encryption.
Definition: fs_pdfdoc.h:679
uint32 flags
Watermark flags.
Definition: fs_pdfdoc.h:197
Definition: fs_pdfobject.h:809
int GetFontCount()
Count all the PDF fonts used in current PDF document.
void AddHeaderFooter(const HeaderFooter &headerfooter)
Add new header-footer.
bool HasForm() const
Check whether current PDF document has interactive form (also known as AcroForm).
void Set(float width, float height, common::Rotation rotation)
Set value.
Definition: fs_pdfdoc.h:425
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 with layers.
Definition: fs_pdfdoc.h:811
Operate text annotations and fill in interactive form fields. (Bit 6 in permission value)
Definition: fs_pdfdoc.h:720
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).
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:347
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:262
If set, that means structure tree will be extracted as well.
Definition: fs_pdfdoc.h:829
ReadingBookmark InsertReadingBookmark(int reading_bookmark_index, const WString &title, int dest_page_index)
Insert a reading bookmark to current PDF document.
Definition: fs_signature.h:2091
PasswordType CheckPassword(const String &password)
Check the type of a specified password.
InsertDocOptions
Enumeration for options used for inserting a PDF document to another.
Definition: fs_pdfdoc.h:848
float rotation
Rotation angle in degrees.
Definition: fs_pdfdoc.h:178
Definition: fs_pdfdoc.h:59
objects::PDFDictionary * GetTrailer() const
Get the trailer dictionary.
ImportPageFlags
Enumeration for flags used for importing pages.
Definition: fs_pdfdoc.h:807
bool SetOpenAction(actions::Action &action)
Set the action to be performed when the document is opened.
If set, that means annotations related to extracted pages will be extracted as well.
Definition: fs_pdfdoc.h:827
#define NULL
The null-pointer value.
Definition: fx_system.h:792
common::Progressive StartGetPayloadFile(foxit::common::file::WriterCallback *payload_file, common::PauseCallback *pause=0)
Start to get payload file.
WrapperData & operator=(const WrapperData &wrapper_data)
Assign operator.
Definition: fs_pdfdoc.h:242
Save document normally, without using any special flag.
Definition: fs_pdfdoc.h:757
Definition: fs_pdfdoc.h:648
WString crypto_filter
The name of the cryptographic filter used to encrypt the encrypted payload document.
Definition: fs_pdfdoc.h:360
WString app_id
Application identity to indicate applications to open this wrapper data.
Definition: fs_pdfdoc.h:275
Definition: fs_pdfpage.h:412
If set, that means to use PDFDoc::e_SaveFlagXRefStream saving flag for the result file in order to re...
Definition: fs_pdfdoc.h:838
EncryptType GetEncryptionType() const
Get the encryption type.
bool IsOwnerPassword(const String &password)
Check if input password is the owner password of current PDF document.
Definition: fs_fdfdoc.h:51
float height
Page height (unit is 1/72 inch).
Definition: fs_pdfdoc.h:435
Bookmark CreateRootBookmark()
Create new bookmark root node.
TableOfContentsConfig & operator=(const TableOfContentsConfig &other)
Assign operator.
Definition: fs_pdfdoc.h:512
PDFPage AddPageFromTemplate(const wchar_t *template_name)
Adds a new PDF page to document, from a named template.
Import pages without cloning stream objects into memory.
Definition: fs_pdfdoc.h:817
bool SetSecurityHandler(const SecurityHandler &handler)
Set a PDF security handler for encryption, such as standard encryption(password), certificate encrypt...
Definition: fs_security.h:580
bool IsEncrypted() const
Check whether current document is an encrypted file or not.
float version
The version number of the cryptographic filter used to encrypt the encrypted payload referenced by th...
Definition: fs_pdfdoc.h:358
EmbeddedFontData GetEmbeddedFontData()
Get embedded font data.
TableOfContentsConfig()
Constructor.
Definition: fs_pdfdoc.h:499
Print PDF document with higher qualities. (Bit 12 in permission value)
Definition: fs_pdfdoc.h:745
Definition: fs_basictypes.h:228
WrapperData(const WrapperData &wrapper_data)
Constructor, with another wrapper data object.
Definition: fs_pdfdoc.h:228
int64 file_size
The payload file size.
Definition: fs_pdfdoc.h:364
If set, do not print a watermark.
Definition: fs_pdfdoc.h:74
void Set(float row_space, float col_space, float rotation, int opacity, int scale, uint32 flags)
Set value.
Definition: fs_pdfdoc.h:164
bool IsWrapper() const
Check whether current document is a wrapper file or not.
Definition: fs_common.h:1428
Encryption type: customized encryption.
Definition: fs_pdfdoc.h:683
An owner password is used in PDF document.
Definition: fs_pdfdoc.h:663
PageBasicInfo(const PageBasicInfo &page_info)
Constructor, with another page basic information object.
Definition: fs_pdfdoc.h:398
Modify PDF contents. (Bit 4 in permission value)
Definition: fs_pdfdoc.h:708
If set, the watermark will be a part of page content when inserted to a PDF page.
Definition: fs_pdfdoc.h:68
bool IsXFA() const
Check whether current PDF document is an XFA document.
PagingSealSignature AddPagingSealSignature(const common::Range &page_range, float width, float height)
Add a paging seal signature to document by page range.
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:440
WrapperType GetWrapperType() const
Get Wrapper type.
CustomEncryptData GetCustomEncryptData() const
Get encrypt data of custom encryption.
CertificateEncryptData GetCertificateEncryptData() const
Get encrypt data of certificate encryption.
Definition: fs_pdfdoc.h:447
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:477
float width
Page width (unit is 1/72 inch).
Definition: fs_pdfdoc.h:432
PayLoadData(const PayLoadData &payload_data)
Constructor, with another payload data object.
Definition: fs_pdfdoc.h:314
Definition: fs_pdfobject.h:422
objects::PDFDictionary * GetPagesDict() const
Get the dictionary of "Pages".
WIDE STRING CLASS.
Definition: fx_string.h:1461
Header file for bookmark related definitions and classes.
If set, show watermark above other page content.
Definition: fs_pdfdoc.h:72
Definition: fs_common.h:1273
Normal document.
Definition: fs_pdfdoc.h:898
DRMEncryptData GetDRMEncryptData() const
Get encrypt data of Foxit DRM encryption.
If set, that means attachments will be inserted to target document as well.
Definition: fs_pdfdoc.h:850
bool IsEmpty() const
Check whether current object is empty or not.
PayLoadData GetPayLoadData()
Get payload data if current document's wrapper type is PDFDoc::e_WrapperPDFV2.
TiledWatermarkSettings(const TiledWatermarkSettings &settings)
Constructor, with another tiled watermark settings object.
Definition: fs_pdfdoc.h:122
Bookmark GetRootBookmark()
Get bookmark root node.
Header file for reading bookmark related definitions and classes.
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:578
void DeleteIndirectObject(uint32 object_number)
Delete an indirect object by indirect object number.
Foxit wrapper document.
Definition: fs_pdfdoc.h:900
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
HeaderFooter GetEditableHeaderFooter()
Get the editable header footer object.
Save document by using XRef stream.
Definition: fs_pdfdoc.h:778
Print PDF document with normal mode. (Bit 3 in permission value)
Definition: fs_pdfdoc.h:701
The password is invalid.
Definition: fs_pdfdoc.h:657
Extract PDF contents. (Bit 5 in permission value)
Definition: fs_pdfdoc.h:714
ErrorCode Load(const String &password="")
Load current document content by using a specified password.
No password is used in PDF document.
Definition: fs_pdfdoc.h:659
FX_UINT64 uint64
Unsigned 64-bit integer.
Definition: fs_basictypes.h:192
Flags
Enumeration for tiled watermark setting flags.
Definition: fs_pdfdoc.h:66
Definition: fs_basictypes.h:443
Page size: letter.
Definition: fs_pdfpage.h:492
Disabilities support. (Bit 10 in permission value)
Definition: fs_pdfdoc.h:732
Save document as a linearized file.
Definition: fs_pdfdoc.h:785
PasswordType
Enumeration for the type of current used password in a PDF document.
Definition: fs_pdfdoc.h:655
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....
@2024 Foxit Software Incorporated. All rights reserved.