pdfdocument-ag凯发旗舰厅

com.spire.pdf
class pdfdocument

java.lang.object
  com.spire.pdf.pdfdocument

public class pdfdocument
extends java.lang.object

root object of the library to create pdf files.

pdfdocument

public pdfdocument()

initializes a new instance of the class.

pdfdocument

public pdfdocument(java.lang.string filename)

initializes a new instance of the class.

parameters:

filename - the path to source pdf file.

see also:

this constructor imports an existing pdf file into the document object. it automatically populates the pages collection with the pages of the given document.

pdfdocument

public pdfdocument(java.lang.string filename,
                   java.lang.string password)

initializes a new instance of the class.

parameters:

filename - the path to source pdf document.

password - the password (user or owner) of the encrypted document.

pdfdocument

public pdfdocument(pdfconformancelevel pdflevel)

set document pdfconformancelevel

parameters:

pdflevel -

pdfdocument

public pdfdocument(byte[] bytes)

initializes a new instance of the class.

parameters:

bytes - the byte array with the file content.

pdfdocument

public pdfdocument(byte[] bytes,
                   java.lang.string password)

initializes a new instance of the class.

parameters:

bytes - the byte array with the file content.

password - the password (user or owner) of the encrypted document.

pdfdocument

public pdfdocument(java.io.inputstream stream)

initializes a new instance of the class.

parameters:

stream - the stream with the file.

pdfdocument

public pdfdocument(java.io.inputstream stream,
                   java.lang.string password)

initializes a new instance.

parameters:

stream - the stream with the file.

password - the password (user or owner) of the encrypted document.

getusehighqualityimage

public boolean getusehighqualityimage()

indicates whether to use the high qulity image when convert document

setusehighqualityimage

public void setusehighqualityimage(boolean value)

getallowcreateform

public boolean getallowcreateform()

get or set allow create form.

setallowcreateform

public void setallowcreateform(boolean value)

setusepsdirectlyforconvert

public void setusepsdirectlyforconvert(boolean value)

getconvertoptions

public pdfconvertoptions getconvertoptions()

gets some options when do convert operation.

returns:

convertoptions

getpagescaling

public pdfprintpagescaling getpagescaling()

get pdfdocument print pagescaling

setpagescaling

public void setpagescaling(pdfprintpagescaling value)

set pdfdocument print pagescaling

getcustomscaling

public int getcustomscaling()

get or set current pdf document print pagescaling

setcustomscaling

public void setcustomscaling(int value)

set current pdf document print pagescaling

getpdfstandard

public pdfdocumentbase getpdfstandard()

get current active pdf object

setpdfstandard

public void setpdfstandard(pdfdocumentbase value)

set current active pdf object

getconformance

public pdfconformancelevel getconformance()

get document pdfconformancelevel

getattachments

public pdfattachmentcollection getattachments()

gets the collection of document attachments displayed on a pdf page.

getbookmarks

public pdfbookmarkcollection getbookmarks()

gets the bookmarks.

getcolorspace

public  getcolorspace()

gets the color space for page that will be created.

setcolorspace

public void setcolorspace( value)

sets the color space for page that will be created.

getdocumentinformation

public pdfdocumentinformation getdocumentinformation()

gets document's information and properties.

getjavascripts

public  getjavascripts()

gets the additional document's actions.

getform

public pdfform getform()

gets the loaded form.

getpagenumber

public pdfpagenumber getpagenumber()

get the pdfpagelabel.

setpagenumber

public void setpagenumber(pdfpagenumber value)

set the pdfpagelabel.

getpages

public pdfpagecollection getpages()

gets the pages.

getusedfonts

public pdfusedfont[] getusedfonts()

gets the m_fonts which are available in the pdf document.

getcompressionlevel

public pdfcompressionlevel getcompressionlevel()

gets or sets the desired level of stream compression.

see also:

all new objects should be compressed with this level of the compression.

setcompressionlevel

public void setcompressionlevel(pdfcompressionlevel value)

sets the desired level of stream compression.

parameters:

value -

getpagesettings

public pdfpagesettings getpagesettings()

get a page settings in the pdf documents

returns:

pdfpage settings info

setpagesettings

public void setpagesettings(pdfpagesettings value)

set a page settings in the pdf documents

getsections

public pdfsectioncollection getsections()

gets the sections of a page

returns:

sectioncollection

getfileinfo

public pdffileinfo getfileinfo()

get the file info int the pdf document

setfileinfo

public void setfileinfo(pdffileinfo value)

set the file info int the pdf document

getsecurity

public pdfsecurity getsecurity()

gets the security parameters of the document.

getviewerpreferences

public pdfviewerpreferences getviewerpreferences()

gets a viewer preferences object controlling the way the document is to be presented on the screen or in print.

setviewerpreferences

public void setviewerpreferences(pdfviewerpreferences value)

sets a viewer preferences object controlling the way the document is to be presented on the screen or in print.

getafteropenaction

public pdfaction getafteropenaction()

gets the action to execute when the document is opened.

setafteropenaction

public void setafteropenaction(pdfaction value)

sets the action to execute when the document is opened.

getafterprintaction

public pdfjavascriptaction getafterprintaction()

gets the action to be performed after the document is printed.

setafterprintaction

public void setafterprintaction(pdfjavascriptaction value)

sets the action to be performed after the document is printed.

parameters:

value -

getaftersaveaction

public pdfjavascriptaction getaftersaveaction()

gets the jave script action to be performed after the document is saved.

setaftersaveaction

public void setaftersaveaction(pdfjavascriptaction value)

sets the jave script action to be performed after the document is saved.

parameters:

value -

getbeforecloseaction

public pdfjavascriptaction getbeforecloseaction()

gets or sets the action to be performed before the document is closed.

setbeforecloseaction

public void setbeforecloseaction(pdfjavascriptaction value)

getbeforeprintaction

public pdfjavascriptaction getbeforeprintaction()

gets or sets the action to be performed before the document is printed.

setbeforeprintaction

public void setbeforeprintaction(pdfjavascriptaction value)

getbeforesaveaction

public pdfjavascriptaction getbeforesaveaction()

gets the java script action to be performed before the document is saved.

setbeforesaveaction

public void setbeforesaveaction(pdfjavascriptaction value)

sets the java script action to be performed before the document is saved.

getxmpmetadata

public xmpmetadata getxmpmetadata()

gettemplate

public pdfdocumenttemplate gettemplate()

gets the template of pdf document

getenablefontcache

public static boolean getenablefontcache()

indicates whether enable font cache.

setenablefontcache

public static void setenablefontcache(boolean value)

gettag

public java.lang.object gettag()

settag

public void settag(java.lang.object value)

isencrypted

public boolean isencrypted()

indicates the document is encrypted or not

isportfolio

public boolean isportfolio()

indicates the document is a pdf portfolio or not.

returns:

isportfolio

getlayers

public pdflayercollection getlayers()

gets optional content properties

returns:

layer

throws:

com.spire.ms.system.exception

dispose

public void dispose()

releases unmanaged resources and performs other cleanup operations before the is reclaimed by garbage collection.

loadfromfile

public void loadfromfile(java.lang.string filename,
                         java.lang.string password)

initializes a new instance of the class.

parameters:

filename - the path to source pdf document.

password - the password (user or owner) of the encrypted document.

loadfromfile

public void loadfromfile(java.lang.string filename)

initializes a new instance of the class.

parameters:

filename - the path to source pdf file.

see also:

this constructor imports an existing pdf file into the document object. it automatically populates the pages collection with the pages of the given document.

loadfromfile

public void loadfromfile(java.lang.string filename,
                         fileformat fileformat)

loadfromxps

public void loadfromxps(byte[] xpsbytes)

load a xps bytes array.

parameters:

xpsbytes - the xps byte array

loadfromxps

public void loadfromxps(java.lang.string filename)

load a xps file.

parameters:

filename -

loadfromxps

public void loadfromxps(java.io.inputstream xpsstream)

load a xps stream.

parameters:

xpsstream -

loadfrombytes

public void loadfrombytes(byte[] bytes)

initializes a new instance of the class.

parameters:

bytes - the byte array with the file content.

loadfromstream

public void loadfromstream(java.io.inputstream stream)

initializes a new instance of the class.

parameters:

stream - the stream with the file.

createbooklet

public void createbooklet(java.lang.string filename,
                          float width,
                          float height,
                          boolean doubleside)

for the document create booklet

parameters:

filename - booklet file name

width - booklet width

height - booklet height

doubleside - booklet double side

createbooklet

public void createbooklet(java.lang.string filename,
                          double width,
                          double height,
                          boolean doubleside)

for the document create booklet

parameters:

filename - booklet name

width - booklet width

height - booklet height

doubleside - booklet doubleside

createbooklet

public void createbooklet(java.lang.string filename,
                          float width,
                          float height,
                          boolean doubleside,
                           begindrawpage,
                           enddrawpage)

for the document create booklet

parameters:

filename - booklet name

width - booklet width

height - booklet height

doubleside - booklet double side

begindrawpage - booklet begin draw page

enddrawpage - booklet end draw page

verifysignature

public boolean verifysignature(java.lang.string signname)

verify signature int the pdf document

parameters:

signname - sign name

returns:

if return true the document is verify signature

getsignatrecontuent

public byte[] getsignatrecontuent(java.lang.string signname)

close

public void close()

closes the document. completely if set to true the document should be disposed completely.

see also:

the document is disposed after calling the close method. so, the document can not be saved if close method was invoked.

savetostream

public void savetostream(java.io.outputstream stream)

saves the document to the specified stream.

parameters:

stream - the stream object where pdf document will be saved.

savetostream

public void savetostream(java.io.outputstream stream,
                         fileformat format)

savetostream

public java.io.bytearrayoutputstream[] savetostream(int startindex,
                                                    int endindex,
                                                    fileformat format)

savetofile

public void savetofile(java.lang.string filename)

saves pdf document to file.

parameters:

filename - a relative or absolute path for the file

savetofile

public void savetofile(java.lang.string filename,
                       fileformat fileformat)

saves pdf document to file.

parameters:

filename - a relative or absolute path for the file

fileformat - file format for the file

savetopdfx1a2001

@deprecated
public void savetopdfx1a2001(java.lang.string filename)

deprecated. 

resave file to pdf x1a2001 type file. recommand to use savetopdf(filename,pdfconformancelevel).

parameters:

filename -

savetopdf

public void savetopdf(java.lang.string filename,
                      pdfconformancelevel pdfconformancelevel)

this is recreate pdf for pdf conformance.

parameters:

filename -

pdfconformancelevel -

savetofile

public void savetofile(java.lang.string filename,
                       int startindex,
                       int endindex,
                       fileformat fileformat)

saves pdf document to other format files. current only supports save pdf document to svg

parameters:

filename - a relative or absolute path for the file

startindex - the start page index.the index starts at 0

endindex - the end page index.

fileformat - file format for the file

saveasimage

public java.awt.image.bufferedimage saveasimage(int pageindex)

saves pdf document page as bufferedimage

parameters:

pageindex - page with page index to save as image

returns:

returns page as bufferedimage

saveasimage

public java.awt.image.bufferedimage saveasimage(int pageindex,
                                                pdfimagetype type)

saves pdf document page as image

parameters:

pageindex - page index

type - pdfimagetype type

returns:

returns page as image

saveasimage

public java.awt.image.bufferedimage saveasimage(int pageindex,
                                                pdfimagetype type,
                                                int dpix,
                                                int dpiy)

saves pdf document page as image,set pdfimagetype and image dpi

parameters:

pageindex - page index

type - pdfimagetype type

dpix - pictures x resolution

dpiy - pictures y resolution

returns:

returns page as image

deepclone

public java.lang.object deepclone()

creates a new object that is a copy of the current instance.

see also:

the resulting clone must be of the same type as or a compatible type to the original instance.

appendpage

public void appendpage(pdfdocument doc)

append a page to the pdf files

appendpage

public pdfpagebase appendpage()

append a page to the pdf files

returns:

added page

insertpage

public pdfpagebase insertpage(pdfdocument doc,
                              pdfpagebase page)

imports a page.

parameters:

doc - the loaded document.

page - the page.

returns:

the page in the target document.

insertpage

public pdfpagebase insertpage(pdfdocument doc,
                              int pageindex)

imports a page.

parameters:

doc - the loaded document.

pageindex - index of the page.

returns:

the page in the target document.

insertpagerange

public pdfpagebase insertpagerange(pdfdocument doc,
                                   int startindex,
                                   int endindex)

imports a page range from a loaded document.

parameters:

doc - the loaded document.

startindex - the start page index.

endindex - the end page index.

returns:

the last created page in the target document.

merge

public static pdfdocumentbase merge(pdfdocumentbase dest,
                                    java.lang.object... srcs)

merges the specified source documents and return destination document. the destination document, where the other documents are merged into. if it's null a new document object will be created.

parameters:

dest - the source documents.

returns:

the document containing merged documents.

mergefiles

public static pdfdocumentbase mergefiles(java.lang.string[] inputfiles)

merges the pdf documents specified by the paths the array of string paths. a new pdf document containing all merged documents.

returns:

document

mergefiles

public static pdfdocumentbase mergefiles(java.io.inputstream[] inputstreams)

merges the pdf documents specified by the stream.

parameters:

inputstreams -

returns:

a new pdf document containing all merged documents.

mergefiles

public static pdfdocumentbase mergefiles(java.lang.string firstinputfile,
                                         java.lang.string secinputfile)

merges the pdf documents specified by the paths.

parameters:

firstinputfile -

secinputfile -

returns:

a new pdf document containing all merged documents.

split

public void split(java.lang.string destfilepattern)

splits a pdf file to many pdf files, each of them consists of one page from the source file.

parameters:

destfilepattern - template for destination file names. each destination file will have 'destfilename{0***}' name, where *** is an optional format string for the number of the page inside of the source document.

split

public void split(java.lang.string destfilepattern,
                  int startnumber)

splits a pdf file to many pdf files, each of them consists of one page from the source file. template for destination file names. the number that is use as a start point for the page numbering. each destination file will have 'destfilename{0***}' name, where *** is an optional format string for the number of the page inside of the source document.

getprintpagemode

public  getprintpagemode()

get or set pdfdocument pages print mode

setprintpagemode

public void setprintpagemode( value)

set pdfdocument pages print mode

getzoomfator

public float getzoomfator()

getprintfrompage

public int getprintfrompage()

gets the pagenumber which you choose as the start page to printing

setprintfrompage

public void setprintfrompage(int value)

sets the pagenumber which you choose as the start page to printing

getprinttopage

public int getprinttopage()

gets the pagenumber which you choose as the final page to printing.

setprinttopage

public void setprinttopage(int value)

sets the pagenumber which you choose as the final page to printing.

getcustomhandlelandscape

public boolean getcustomhandlelandscape()

gets a value indicating handle pagesettings landscape.

setcustomhandlelandscape

public void setcustomhandlelandscape(boolean value)

set a value indicating handle pagesettings landscape.

setdocprintdpi

public void setdocprintdpi(int docprintdpi)

sets the dpi to print using image

getdocprintdpi

public int getdocprintdpi()

get the dpi to print using image

getprintusingimagemode

public boolean getprintusingimagemode()

get print by using image mode

setprintusingimagemode

public void setprintusingimagemode(boolean usingimagemode)

set print by using image mode

setexporttextocrhandler

public static void setexporttextocrhandler(iocr iocr)

when export text,if have image ,will call iocr and add text to export content.

parameters:

iocr -

setexporttextocrhandler

public static void setexporttextocrhandler(iocr iocr,
                                           boolean enableocr)

parameters:

iocr -

enableocr -

getexporttextocrhandler

public static iocr getexporttextocrhandler()

returns:

setexporttextenableocr

public static void setexporttextenableocr(boolean enableocr)

parameters:

enableocr -

getexporttextenableocr

public static boolean getexporttextenableocr()

isautooptimizingtextcolor

public static boolean isautooptimizingtextcolor()

isautooptimizingtextcolor

public static void isautooptimizingtextcolor(boolean autooptimizingtextcolor)