Foxit PDF SDK
foxit.pdf.Combination Class Reference
Inheritance diagram for foxit.pdf.Combination:
foxit.common.Base

Public Types

enum  CombineDocsOptions {
  CombineDocsOptions.e_CombineDocsOptionBookmark = 0x0001, CombineDocsOptions.e_CombineDocsOptionAcroformRename = 0x0002, CombineDocsOptions.e_CombineDocsOptionStructrueTree = 0x0004, CombineDocsOptions.e_CombineDocsOptionOutputIntents = 0x0008,
  CombineDocsOptions.e_CombineDocsOptionOCProperties = 0x0010, CombineDocsOptions.e_CombineDocsOptionMarkInfos = 0x0020, CombineDocsOptions.e_CombineDocsOptionPageLabels = 0x0040, CombineDocsOptions.e_CombineDocsOptionNames = 0x0080,
  CombineDocsOptions.e_CombineDocsOptionObjectStream = 0x0100, CombineDocsOptions.e_CombineDocsOptionDuplicateStream = 0x0200
}
 Enumeration for options used for combining PDF files. More...
 

Static Public Member Functions

static Progressive StartCombineDocuments (string dest_file_path, CombineDocumentInfoArray document_array, int options, PauseCallback pause)
 Start to combine PDF files. More...
 
static Progressive StartCombineDocuments (FileWriterCallback dest_file, CombineDocumentInfoArray document_array, int options, PauseCallback pause)
 Start to combine PDF files. More...
 

Detailed Description

This class can be used to combine several PDF files into one PDF file.

Member Enumeration Documentation

◆ CombineDocsOptions

Enumeration for options used for combining PDF files.

Values of this enumeration can be used alone or in combination.

Enumerator
e_CombineDocsOptionBookmark 

If set, that means bookmarks of source PDF files will be outputted to combined result PDF file.

e_CombineDocsOptionAcroformRename 

If set, that means fields with same name will be renamed in combined result PDF file.

e_CombineDocsOptionStructrueTree 

If set, that means structure trees of source PDF files will be outputted to combined result PDF file.

e_CombineDocsOptionOutputIntents 

If set, that means output intents of source PDF files will be outputted to combined result PDF file.

e_CombineDocsOptionOCProperties 

If set, that means "OCProperties" of source PDF files will be outputted to combined result PDF file.

e_CombineDocsOptionMarkInfos 

If set, that means "MarkInfo" of source PDF files will be outputted to combined result PDF file.

e_CombineDocsOptionPageLabels 

If set, that means page labels of source PDF files will be outputted to combined result PDF file.

e_CombineDocsOptionNames 

If set, that means "Dests" name trees and "EmbeddedFiles" name trees of source PDF files will be outputted to combined result PDF file.

e_CombineDocsOptionObjectStream 

If set, that means object streams will be used to generate combined result PDF file in order to reduce result file size.

e_CombineDocsOptionDuplicateStream 

If set, that means duplicate stream objects from source PDF files will be outputted to combined result PDF file.

Member Function Documentation

◆ StartCombineDocuments() [1/2]

static Progressive foxit.pdf.Combination.StartCombineDocuments ( string  dest_file_path,
CombineDocumentInfoArray  document_array,
int  options,
PauseCallback  pause 
)
inlinestatic

Start to combine PDF files.

It may take a long time to combining documents, so Foxit PDF SDK uses a progressive process to do this.

Parameters
[in]dest_file_pathA full path to save the combined result PDF file. This should not be an empty string.
[in]document_arrayAn information array which represents information of source PDF files which are to be combined.
[in]optionsOptions for combining PDF documents. Please refer to values starting from foxit.pdf.Combination.CombineDocsOptions.e_CombineDocsOptionBookmark and this can be one or a combination of these values. 0 means no option is used.
[in]pausePause object which decides if the combining process needs to be paused. This can be null which means not to pause during the parsing process. If this is not null, it should be a valid pause object implemented by user.
Returns
A progressive object. Please check the rate of current progress by function common.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function common.Progressive.Continue to continue the progress until the progress is finished.

◆ StartCombineDocuments() [2/2]

static Progressive foxit.pdf.Combination.StartCombineDocuments ( FileWriterCallback  dest_file,
CombineDocumentInfoArray  document_array,
int  options,
PauseCallback  pause 
)
inlinestatic

Start to combine PDF files.

It may take a long time to combining documents, so Foxit PDF SDK uses a progressive process to do this.

Parameters
[in]dest_fileA foxit.common.fxcrt.FileWriterCallback object which is implemented by user to store the data of combined result PDF file in custom method.
[in]document_arrayAn information array which represents information of source PDF files which are to be combined.
[in]optionsOptions for combining PDF documents. Please refer to values starting from foxit.pdf.Combination.CombineDocsOptions.e_CombineDocsOptionBookmark and this can be one or a combination of these values. 0 means no option is used.
[in]pausePause object which decides if the combining process needs to be paused. This can be null which means not to pause during the parsing process. If this is not null, it should be a valid pause object implemented by user.
Returns
A progressive object. Please check the rate of current progress by function common.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function common.Progressive.Continue to continue the progress until the progress is finished.