|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectaspose.pdf.Pdf
public class Pdf
Represents the Pdf document.
Typical usages are the following:
In case you use Java 1.4 you must set system property "aspose.pdf.fontpath" before to create first Pdf object
Field Summary | |
---|---|
Paragraphs |
bkFootNotes
Indicates the backup footnote paragraphs. |
int[] |
CurrentBookmarkIds
Indicates the array used to store the current bookmark Ids. |
Text |
currentTextInAll
Indicates the current Text . |
TextInfo |
curSegTextInfo
Indicates the TextInfo of the current Segment . |
java.util.Locale |
CustomLocale
Indicates the custom locale as the value Locale.US. |
boolean |
firstItem
Indicates the object is first item or not. |
boolean |
firstItemInOL
Indicates the object is first item in OL or not. |
float |
FootNoteCurPosInMultiSegProcessing
Indicates the current position of the footnote in multiple segments. |
float |
FootNoteHeightSum
Indicates the footnote height. |
float |
FootNotePageBottom
Indicates the footnote page bottom. |
Paragraphs |
footnoteParas
Indicates the footnote Paragraph arrays. |
aspose.pdf.pdftext.Hashmap |
ImagePath
ImagePath is used to save all of the paths of Image ,in order to delete these files. |
boolean |
IsContainsTable
Indicates the pdf contains table or not. |
boolean |
IsFirstPage
Indicates the page is the first page or not. |
boolean |
IsFirstPageCreated
Indicates whether this is the first page or not. |
boolean |
IsFromHtml
Indicates the document is from html or not. |
boolean |
IsFromRS
Indicates the document is from Rs or not. |
boolean |
IsRowBrokenForFixedHeight
Indicates whether break the row by fixed height or not. |
boolean |
isSamePage
Indicates this is same page or not. |
boolean |
IsSaveCalled
Indicates whether save has been called or not. |
boolean |
IsSaveState
Indicates whether the document is in saving state |
boolean |
IsSecuritySet
Indicates whether the security of the document has been set. |
java.util.Locale |
OriginalLocale
Indicates default original locale. |
boolean |
PageHaveFootLine
Indicates the page have footline or not. |
java.util.ArrayList |
parsedObject
Indicates the parsed objects. |
Heading |
pre1
Indicates the Heading object. |
Paragraph |
preParagraph
Indicates the previous paragraph. |
int |
RefPageID
User access #$REFPAGE the corresponding unique ID. |
GeneratorBase |
TempGenerator1
Initializes a new instance of the GeneratorBase class. |
int |
tempNumberOfFootNoteInDoc
Indicates the temp number of the footnote in this document. |
java.util.ArrayList |
ToBeFreed
The resources need to be released after the PDF is been generated To avoid memory leaks |
java.lang.String |
Url
Indicates the url. |
Constructor Summary | |
---|---|
Pdf()
Initializes a new instance of the Pdf class for Evaluation License. |
|
Pdf(BinaryFileStream docStream)
Initializes a new instance of the Pdf class for Evaluation License. |
Method Summary | |
---|---|
void |
bindPCL(java.lang.String pclFileName)
Binds an PCL document to the Pdf object. |
void |
bindXML(java.io.InputStream xmlFile,
java.io.InputStream xslFile)
Binds an xml/xsl document to the Pdf object. |
void |
bindXML(java.lang.String xmlFile,
java.lang.String xslFile)
Binds an xml/xsl document to the Pdf object. |
void |
bindXML(TextFileStream xmlStream,
TextFileStream xslStream)
Binds an xml/xsl stream to the Pdf object. |
void |
bindXML(XMLDocument xmlDoc,
java.lang.String xslFile)
Binds an xml/xsl document to the Pdf object. |
void |
checkWatermark(Sections sections)
Represents a checkWatermark action. |
void |
close()
Close the document. |
static java.lang.Object |
CreateObjFromXml(java.lang.String xmlFile,
java.lang.String xslFile)
Create object from an xml/xsl document. |
static java.lang.Object |
CreateObjFromXml(TextFileStream xmlStream,
TextFileStream xslStream)
Create object from an xml/xsl stream. |
static java.lang.Object |
createObjFromXml(XMLDocument xmlDoc,
XslTransform xsl)
Reads object info from a xml document. |
static MemStream |
CreateTruetypeFontMapStream()
Creates the TrueType font map stream. |
AssignInfo |
getAssignInfo()
Gets a AssignInfo value that indicates the page assignment info. |
void |
getAssignInfo(AssignInfo value)
Sets a BinaryFileStream value that indicates the page assignment info. |
java.lang.String |
getAuthor()
Gets a string that indicates the author of the Pdf document. |
Color |
getBackgroundColor()
Gets a Color object that indicates the
background color of the pdf. |
Section |
getBackupSection()
It is use to store the header and footer on odder page of mirror margin |
TextInfo |
getBackupTextInfo()
Gets the TextInfo object that indicates the backup TextInfo of the document. |
int |
getBookMarkLevel()
Gets a int value that indicates how many levels of Heading of the pdf document is to be bookmarked. |
Bookmarks |
getBookmarks()
Gets a Bookmarks object that indicates the bookmarks in the PDF. |
byte[] |
getBuffer()
Gets the data buffer used to generate the pdf document in memory. |
int |
getCompressionLevel()
Gets an int value that indicates the compression level. |
PdfConformance |
getConformance()
NOTE: This is beta version of PdfA. |
int |
getConsecutiveHyphens()
Gets the number of consecutive hyphens. |
void |
getConsecutiveHyphens(int value)
Gets the number of consecutive hyphens. |
int |
getConsecutiveHyphensLimits()
Gets an integer value that indicates the consecutive hyphens limits. |
java.lang.String |
getCreator()
Gets a String that indicates the creator of the Pdf document. |
Text |
getCurrentTextInAll()
Gets a Text object that indicates the current Text |
TextInfo |
getCurSegTextInfo()
Gets a TextInfo object that indicates the TextInfo of the current Segment |
CustomFonts |
getCustomFonts()
Gets a CustomFonts object that indicates
the custom fonts of the document. |
java.util.Locale |
getCustomLocale()
Gets the custom locale information. |
java.lang.String |
getDefaultFontName()
Gets a string that indicates the default font name. |
DestinationType |
getDestinationType()
Gets or sets a DestinationType value that
indicates the document open action. |
BinaryFileStream |
getDocStream()
Gets a BinaryFileStream value that indicates the stream of the document. |
DocumentAttachments |
getDocumentAttachments()
Gets a DocumentAttachments which will be added upon the PDF document. |
void |
getDocumentAttachments(DocumentAttachments value)
Sets a DocumentAttachments which will be added upon the PDF document. |
int |
getEndNoteNumberInDoc()
Gets an integer value that indicates the endnote number in this document |
Heading |
getFirstHeading()
Represents a Heading object that indicates the first heading in this document. |
boolean |
getFirstItemInOL()
Gets a boolean value that indicates the object is first item in OL or not. |
int |
getFirstLineIndent()
Gets an int value that indicates the indent of the first line. |
aspose.pdf.xml.Substitute |
getFirstSubstitute()
Gets a Substitute object that indicates the first substitutor in the document. |
int |
getFootNoteNumberInDoc()
Gets an integer value that indicates the footnote number in this document |
GeneratorBase |
getGeneratorBase()
Gets the GeneratorBase object that indicates the GeneratorBase of the document. |
GraphInfo |
getGraphInfo()
Gets a GraphInfo object that indicates the graph info in the Pdf document. |
HeadingInfoArray |
getHeadingInfos()
Gets a HeadingInfoArray object that indicates the heading info. |
aspose.pdf.html.HtmlInfo |
getHtmlInfo()
Gets a aspose.pdf.html.HtmlInfo object that indicates the necessary info when converting |
java.lang.String |
getHyphenationDictionaryPath()
Gets a string that indicates the hyphenation dictionary path. |
float |
getHyphenationZoneWidth()
Gets a float value that indicates the hyphenation area width. |
aspose.pdf.pdftext.Hashmap |
getHyphenDicMap()
Gets the number of consecutive hyphens. |
XMLDocument |
getHyphenDictionary()
Gets a hyphenation Dictionary file. |
aspose.pdf.pdftext.Hashmap |
getImagePath()
Gets a Hashmap object that indicates
the Image path. |
boolean |
getIsAutoFontAdjusted()
Gets a boolean value that indicates whether allow to adjust fonts automatically. |
void |
getIsAutoFontAdjusted(boolean value)
Gets a boolean value that indicates whether allow to adjust fonts automatically. |
boolean |
getIsAutoHyphenated()
Gets a bool value that indicates whether the text is hyphenated automatically. |
boolean |
getIsBookmarked()
Gets a bool value that indicates whether the pdf document is bookmarked when generating PDF document. |
boolean |
getIsBuffered()
Gets a bool value that indicates whether memory buffer is used when generating PDF document. |
boolean |
getIsCoreFontUsed()
Gets a bool value that indicates whether PDF core fonts are used. |
boolean |
getIsFirstPageCreated()
Gets a boolean value that indicates whether this is the first page or not. |
boolean |
getIsFontMapCreated()
Gets a boolean value that indicates whether the font map has been created or not. |
boolean |
getIsFontNotFoundExceptionThrown()
Gets a bool value that indicates whether throw out exception when font is not found. |
boolean |
getIsImagesInXmlDeleteNeeded()
Gets a bool value that indicates whether images used in XML be deleted when the PDF document is generated. |
boolean |
getIsLandscape()
Gets a bool value that indicates whether the page orientation is landscape. |
boolean |
getIsPageNumberForDocument()
Gets a bool value that indicates whether the "image not found" error is ignored or not. |
boolean |
getIsPageNumberRestarted()
Gets a bool value that indicates whether the page number is restarted in new section. |
boolean |
getIsRightToLeft()
Gets a bool value that indicates whether the text or heading appear in the pdf is right-to-left aligned. |
boolean |
getIsRtlInSegmentMode()
Gets a bool value that indicates whether the text or heading is processed in segment mode. |
boolean |
getIsSaveState()
Gets the boolean value that indicates whether the document is in saving state. |
boolean |
getIsSegmentMerged()
Gets a bool value that indicates whether the segments with same format are merged into one. |
boolean |
getIsSpaced()
Gets a bool value that indicates whether the spaces at the begin of the text and returns in the text be shown. |
boolean |
getIsTruetypeFontMapCached()
Gets a bool value that indicates whether truetype font map be cached on disk. |
boolean |
getIsWatermarkOnTop()
Gets a bool value that indicates if the watermark is on top of the page. |
boolean |
getIsWidowOrphanControlEnabled()
Gets a bool value that indicates whether the Widow/Orphan control is enabled. |
boolean |
getIsXmlSchemaCheckedOnBind()
Gets a bool value that indicates whether the error is ignored when unknown elements or attributes are used in xml file. |
JavaScripts |
getJavaScripts()
Gets a JavaScripts object that indicates the JavaScripts to be added into
the PDF. |
java.lang.String |
getKeywords()
Gets a string that indicates key words of the Pdf document. |
float |
getLabelWidth()
Gets a float value that indicates the width of the heading label. |
aspose.pdf.xml.Substitute |
getLastSubstitute()
Gets a Substitute object that indicates the last substitutor in the document. |
boolean |
getLinearized()
Gets a bool value that indicates if the document needs to be linearized (optimization for web access) . |
ListSection |
getListOfFigures()
Gets a ListSection object that indicates
the list of figures. |
ListSection |
getListOfTables()
Gets a ListSection object that indicates
the list of table. |
java.lang.Object |
getObjectByID(java.lang.String ID)
Gets a object with specified ID in the document. |
OpenType |
getOpenType()
Gets a OpenType that indicates the document open type. |
int |
getPageCount()
Gets a int value that indicates the pages count of the generated PDF. |
int |
getPageDuration()
Gets a int value that indicates the duration in seconds for the current page. |
int |
GetPageNumber(java.lang.String ID)
Gets the page number of a paragraph when the PDF is generated. |
PageNumberFormatType |
getPageNumberFormat()
Gets a PageNumberFormatType value that indicates the format of the page number . |
aspose.pdf.xml.Page |
getPages()
Gets a Page object that indicates the pages chain contains in this document. |
PageSetup |
getPageSetup()
Gets a PageSetup object that indicates the page setup info in the Pdf document. |
int |
getPagesNumber()
Represents an int value that indicates the current pages number. |
PageTransitionType |
getPageTransitionType()
Gets a PageTransitionType that indicates the pdf document page transition type. |
java.lang.String |
getPdfXslFile()
Gets a String value that indicates document's xsl file. |
java.lang.String |
getProducer()
Gets a string that indicates the producer of the Pdf document. |
int |
getRefPageID()
Gets a int value that indicates User access #$REFPAGE the corresponding unique ID. |
Sections |
getSections()
Gets a Sections collection that indicates all sections in the Pdf document. |
Security |
getSecurity()
Gets a Security object that indicates
the document security information. |
float |
GetStringWidth(java.lang.String str,
TextInfo info)
Gets the string width in PDF with specified text formatting. |
java.lang.String |
getSubject()
Gets a string that indicates the subject of the Pdf document. |
ListSection |
getTableOfContents()
Gets a ListSection object that indicates
the table of contents. |
float |
getTabStopPosition()
Gets the tab stop position. |
GeneratorBase |
getTempGenerator()
Gets a GeneratorBase object that indicates
the temp generator. |
GeneratorBase |
getTempGenerator1()
Gets a GeneratorBase object that indicates
the temp generator. |
TextInfo |
getTextInfo()
Gets a TextInfo object that indicates the text info in the Pdf document. |
void |
getTextInfo(TextInfo value)
Sets a TextInfo object that indicates the text info in the Pdf document. |
static int |
getTimeOutOfFileWebRequest()
Gets the length of time until the request times out for the Pdf document. |
java.lang.String |
getTitle()
Gets a string that indicates the creator of the Pdf document. |
java.util.ArrayList |
getToBeFreed()
Gets an ArrayList that indicates The resources need to be released after the PDF is been generated To avoid memory leaks |
java.lang.String |
getTruetypeFontDirectoryPath()
Gets a string that indicates the path of the truetype font directory. |
java.lang.String |
getTruetypeFontMapPath()
Gets a string that indicates the path of the truetype font map file. |
MemStream |
getTruetypeFontMapStream()
Gets a memory stream that indicates the TrueType font map stream. |
void |
getTruetypeFontMapStream(MemStream value)
Sets a memory stream that indicates the TrueType font map stream. |
Watermarks |
getWatermarks()
Gets a Watermarks which will be added upon each page
of the PDF document. |
java.lang.String |
getXmlFilePath()
Gets a String value that indicates the xml file path. |
XmpMetadata |
getXmpMetadata()
Gets a XmpMetadata Object that indicates the XMP metadata to be added into the PDF document. |
void |
PdfInit()
Complete the initiation of the pdf document. |
void |
pdfInitForMultiSave()
Complete the initiation of the pdf document for multiple save. |
void |
ProcessLists()
Add Lists to the pdf document if the user has specified the list. |
void |
save(BasicStream stream)
Generates Pdf document and put it to a BasicStream object. |
void |
save(java.io.OutputStream stream)
Generates Pdf document and put it to a OutputStream object. |
void |
save(java.lang.String pdfFile)
Generates Pdf document and saves it. |
void |
save(java.lang.String fileName,
SaveType saveType,
aspose.pdf.HttpResponse response)
Generates Pdf document and sends it to the client browser. |
void |
setAuthor(java.lang.String value)
Sets a string that indicates the author of the Pdf document. |
void |
setBackgroundColor(Color value)
Sets a Color object that indicates the
background color of the pdf. |
void |
setBackupSection(Section value)
It is use to store the header and footer on odder page of mirror margin |
void |
setBackupTextInfo(TextInfo value)
Sets the TextInfo object that indicates the backup TextInfo of the document. |
void |
setBookMarkLevel(int value)
Gets a int value that indicates how many levels of Heading of the pdf document is to be bookmarked. |
void |
setBookmarks(Bookmarks value)
Sets a Bookmarks object that indicates the bookmarks in the PDF. |
void |
setCompressionLevel(int value)
Sets an int value that indicates the compression level. |
void |
setConformance(PdfConformance value)
NOTE: This is beta version of PdfA. |
void |
setConsecutiveHyphens(int ch)
Sets the number of consecutive hyphens. |
void |
setConsecutiveHyphensLimits(int value)
Sets an integer value that indicates the consecutive hyphens limits. |
void |
setCreator(java.lang.String value)
Sets a String that indicates the creator of the Pdf document. |
void |
setCurrentTextInAll(Text CurrentTextInAll)
Sets a Text object that indicates the current Text |
void |
setCurSegTextInfo(TextInfo curSegTextInfo)
Sets a TextInfo object that indicates the TextInfo of the current Segment |
void |
setCustomFonts(CustomFonts value)
Sets a Security object that indicates
the custom fonts of the document. |
void |
setDefaultFontName(java.lang.String value)
Sets a string that indicates the default font name. |
void |
setDestinationType(DestinationType value)
Sets or sets a DestinationType value that
indicates the document open action. |
void |
setDocStream(BinaryFileStream value)
Sets a BinaryFileStream value that indicates the stream of the document. |
void |
setEndNoteNumberInDoc(int value)
Sets an integer value that indicates the endnote number in this document |
void |
setFirstHeading(Heading value)
Sets the Heading object that indicates the first heading in this document. |
void |
setFirstItemInOL(boolean fio)
Sets a boolean value that indicates the object is first item in OL or not. |
void |
setFirstLineIndent(int value)
Sets an int value that indicates the indent of the first line. |
void |
setFirstSubstitute(aspose.pdf.xml.Substitute value)
Sets a Substitute object that indicates the first substitutor in the document. |
void |
setFootNoteNumberInDoc(int value)
Sets an integer value that indicates the footnote number in this document |
void |
setGeneratorBase(GeneratorBase value)
Sets the GeneratorBase object that indicates the GeneratorBase of the document. |
void |
setGraphInfo(GraphInfo value)
Sets a GraphInfo object that indicates the graph info in the Pdf document. |
void |
setHeadingInfos(aspose.pdf.xml.HeadingInfoArray value)
Sets a HeadingInfoArray object that indicates the heading info. |
void |
setHtmlInfo(aspose.pdf.html.HtmlInfo value)
Sets a aspose.pdf.html.HtmlInfo object that indicates the necessary info when converting |
void |
setHyphenationDictionaryPath(java.lang.String value)
Sets a string that indicates the hyphenation dictionary path. |
void |
setHyphenationZoneWidth(float value)
Sets a float value that indicates the hyphenation area width. |
void |
setHyphenDicMap(aspose.pdf.pdftext.Hashmap value)
Sets the number of consecutive hyphens. |
void |
setHyphenDictionary(XMLDocument value)
Sets a hyphenation Dictionary file. |
void |
setImagePath(aspose.pdf.pdftext.Hashmap ImagePath)
Sets a Hashmap object that indicates
the Image path. |
void |
setIsAutoHyphenated(boolean value)
Sets a bool value that indicates whether the text is hyphenated automatically. |
void |
setIsBookmarked(boolean value)
Sets a bool value that indicates whether the pdf document is bookmarked when generating PDF document. |
void |
setIsBuffered(boolean value)
Sets a bool value that indicates whether memory buffer is used when generating PDF document. |
void |
setIsCoreFontUsed(boolean value)
Sets a bool value that indicates whether PDF core fonts are used. |
void |
setIsFirstPageCreated(boolean IsFirstPageCreated)
Gets a boolean value that indicates whether this is the first page or not. |
void |
setIsFontMapCreated(boolean value)
Sets a boolean value that indicates whether the font map has been created or not. |
void |
setIsFontNotFoundExceptionThrown(boolean value)
Sets a bool value that indicates whether throw out exception when font is not found. |
void |
setIsImagesInXmlDeleteNeeded(boolean value)
Sets a bool value that indicates whether images used in XML be deleted when the PDF document is generated. |
void |
setIsLandscape(boolean value)
Sets a bool value that indicates whether the page orientation is landscape. |
void |
setIsPageNumberForDocument(boolean value)
Sets a bool value that indicates whether the "image not found" error is ignored or not. |
void |
setIsPageNumberRestarted(boolean value)
Sets a bool value that indicates whether the page number is restarted in new section. |
void |
setIsRightToLeft(boolean value)
Sets a bool value that indicates whether the text or heading appear in the pdf is right-to-left aligned. |
void |
setIsRtlInSegmentMode(boolean value)
Sets a bool value that indicates whether the text or heading is processed in segment mode. |
void |
setIsSaveState(boolean IsSaveState)
Sets the boolean value that indicates whether the document is in saving state. |
void |
setIsSegmentMerged(boolean value)
Sets a bool value that indicates whether the segments with same format are merged into one. |
void |
setIsSpaced(boolean value)
Sets a bool value that indicates whether the spaces at the begin of the text and returns in the text be shown. |
void |
setIsTruetypeFontMapCached(boolean value)
Sets a bool value that indicates whether truetype font map be cached on disk. |
void |
setIsWatermarkOnTop(boolean value)
Sets a bool value that indicates if the watermark is on top of the page. |
void |
setIsWidowOrphanControlEnabled(boolean value)
Sets a bool value that indicates whether the Widow/Orphan control is enabled. |
void |
setIsXmlSchemaCheckedOnBind(boolean value)
Sets a bool value that indicates whether the error is ignored when unknown elements or attributes are used in xml file. |
void |
setJavaScripts(JavaScripts value)
Sets a JavaScripts object that indicates the JavaScripts to be added into
the PDF. |
void |
setKeywords(java.lang.String value)
Sets a string that indicates key words of the Pdf document. |
void |
setLabelWidth(float value)
Sets a float value that indicates the width of the heading label. |
void |
setLastSubstitute(aspose.pdf.xml.Substitute value)
Sets a Substitute object that indicates the last substitutor in the document. |
static void |
setLicense(java.lang.String licenseFile)
Obsolete. |
void |
setLinearized(boolean value)
Sets a bool value that indicates if the document needs to be linearized (optimization for web access) . |
void |
setOpenType(OpenType value)
Sets a OpenType that indicates the document open type. |
void |
setPageDuration(int value)
Sets a int value that indicates the duration in seconds for the current page. |
void |
setPageNumberFormat(PageNumberFormatType value)
Sets a PageNumberFormatType value that indicates the format of the page number . |
void |
setPages(aspose.pdf.xml.Page value)
Sets a Page object that indicates the pages chain contains in this document. |
void |
setPageSetup(PageSetup value)
Sets a PageSetup object that indicates the page setup info in the Pdf document. |
void |
setPagesNumber(int value)
Represents an int value that indicates the current pages number. |
void |
setPageTransitionType(PageTransitionType value)
Sets a PageTransitionType that indicates the pdf document page transition type. |
void |
setPdfXslFile(java.lang.String value)
Sets a String value that indicates document's xsl file. |
void |
setProducer(java.lang.String value)
Sets a string that indicates the producer of the Pdf document. |
void |
setRefPageID(int rd)
Sets a int value that indicates User access #$REFPAGE the corresponding unique ID. |
void |
setSections(Sections value)
Sets a Sections collection that indicates all sections in the Pdf document. |
void |
setSecurity()
Set security of the document. |
void |
setSecurity(Security value)
Sets a Security object that indicates
the document security information. |
void |
setSubject(java.lang.String value)
Sets a string that indicates the subject of the Pdf document. |
void |
setTabStopPosition(float value)
Sets the tab stop position. |
void |
setTempGenerator(GeneratorBase value)
Sets a GeneratorBase object that indicates
the temp generator. |
void |
setTempGenerator1(GeneratorBase TempGenerator1)
Sets a GeneratorBase object that indicates
the temp generator. |
static void |
setTimeOutOfFileWebRequest(int value)
Sets the length of time until the request times out for the Pdf document. |
static void |
setTimeOutOfFileWebRequest(java.net.URI url)
Sets the FileWebRequest.Timeout property for the web images. |
void |
setTitle(java.lang.String value)
Sets a string that indicates the creator of the Pdf document. |
void |
setToBeFreed(java.util.ArrayList ToBeFreed)
Sets an ArrayList that indicates The resources need to be released after the PDF is been generated To avoid memory leaks |
void |
setTruetypeFontDirectoryPath(java.lang.String value)
Sets a string that indicates the path of the truetype font directory. |
void |
setTruetypeFontMapPath(java.lang.String value)
Sets a string that indicates the path of the truetype font map file. |
void |
SetUnicode()
Sets all fonts in the document to be unicode. |
void |
setWatermarks(Watermarks value)
Sets a Watermarks which will be added upon each page
of the PDF document. |
void |
setXmlFilePath(java.lang.String value)
Sets a String value that indicates the xml file path. |
void |
setXmpMetadata(XmpMetadata value)
Sets a XmpMetadata Object that indicates the XMP metadata to be added into the PDF document. |
static java.lang.String |
version()
Deprecated. @see BuildVersionInfo |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public java.util.Locale OriginalLocale
public java.util.Locale CustomLocale
public Paragraph preParagraph
public java.util.ArrayList parsedObject
public boolean IsContainsTable
public java.lang.String Url
public TextInfo curSegTextInfo
TextInfo
of the current Segment
.
public Text currentTextInAll
Text
.
public Heading pre1
Heading
object.
public boolean firstItem
public boolean firstItemInOL
public Paragraphs footnoteParas
Paragraph
arrays.
public float FootNotePageBottom
public float FootNoteCurPosInMultiSegProcessing
public Paragraphs bkFootNotes
public float FootNoteHeightSum
public boolean isSamePage
public boolean PageHaveFootLine
public int tempNumberOfFootNoteInDoc
public boolean IsFromHtml
public boolean IsSaveCalled
public int[] CurrentBookmarkIds
public GeneratorBase TempGenerator1
GeneratorBase
class.
public aspose.pdf.pdftext.Hashmap ImagePath
public boolean IsFirstPageCreated
public int RefPageID
public boolean IsFirstPage
public java.util.ArrayList ToBeFreed
public boolean IsSaveState
public boolean IsSecuritySet
public boolean IsFromRS
public boolean IsRowBrokenForFixedHeight
Constructor Detail |
---|
public Pdf()
Pdf
class for Evaluation License.
Remarks: It can be used in both Windows Forms applications and Web Forms applications when the license type is Evaluation License.
public Pdf(BinaryFileStream docStream)
Pdf
class for Evaluation License. You can use
SetLicense method to set license if you have purchased license.If you use this constructor,the
component will work in direct-to-file or direct-to-stream mode. That means all paragraphs will
be rendered into pdf file or stream without being saved in the document object model. Less memory
will be consumed in this mode,but you can't access the paragraphs that be added into the document
any more, so some of the advanced features such as combination of XML and API,hyperlink to
specified paragraph,total page number in footer,etc.,is not available.
docStream
- The stream to write the document.Method Detail |
---|
public static java.lang.String version()
public java.util.Locale getCustomLocale()
public TextInfo getCurSegTextInfo()
TextInfo
object that indicates the TextInfo
of the current Segment
TextInfo
object.public void setCurSegTextInfo(TextInfo curSegTextInfo)
TextInfo
object that indicates the TextInfo
of the current Segment
curSegTextInfo
- public Text getCurrentTextInAll()
Text
object that indicates the current Text
Text
.public void setCurrentTextInAll(Text CurrentTextInAll)
Text
object that indicates the current Text
CurrentTextInAll
- public boolean getFirstItemInOL()
public void setFirstItemInOL(boolean fio)
fio
- public aspose.pdf.pdftext.Hashmap getHyphenDicMap()
public void setHyphenDicMap(aspose.pdf.pdftext.Hashmap value)
value
- public void setConsecutiveHyphens(int ch)
public int getConsecutiveHyphens()
public void getConsecutiveHyphens(int value)
public XMLDocument getHyphenDictionary()
public void setHyphenDictionary(XMLDocument value)
value
- public boolean getIsAutoHyphenated()
public void setIsAutoHyphenated(boolean value)
value
- public java.lang.String getHyphenationDictionaryPath()
public void setHyphenationDictionaryPath(java.lang.String value)
value
- public float getHyphenationZoneWidth()
public void setHyphenationZoneWidth(float value)
value
- public int getConsecutiveHyphensLimits()
public void setConsecutiveHyphensLimits(int value)
value
- public java.lang.String getPdfXslFile()
public void setPdfXslFile(java.lang.String value)
value
- public int getFootNoteNumberInDoc()
public void setFootNoteNumberInDoc(int value)
value
- public int getEndNoteNumberInDoc()
public void setEndNoteNumberInDoc(int value)
value
- public PageNumberFormatType getPageNumberFormat()
PageNumberFormatType
value that indicates the format of the page number .
public void setPageNumberFormat(PageNumberFormatType value)
PageNumberFormatType
value that indicates the format of the page number .
value
- public void PdfInit()
public void pdfInitForMultiSave()
public BinaryFileStream getDocStream()
BinaryFileStream
value that indicates the stream of the document.
public void setDocStream(BinaryFileStream value)
BinaryFileStream
value that indicates the stream of the document.
value
- public AssignInfo getAssignInfo()
AssignInfo
value that indicates the page assignment info.
public void getAssignInfo(AssignInfo value)
BinaryFileStream
value that indicates the page assignment info.
value
- public void close()
public static void setLicense(java.lang.String licenseFile)
Remarks: Use this class for licenses purchased before 2005/01/22.
Aspose has upgraded to a new licensing system, please use License.
License.setLicense(java.io.InputStream)
for licenses purchased after that date.
licenseFile
- The license filename with its path.public GeneratorBase getGeneratorBase()
GeneratorBase
object that indicates the GeneratorBase of the document.
public void setGeneratorBase(GeneratorBase value)
GeneratorBase
object that indicates the GeneratorBase of the document.
value
- public Section getBackupSection()
public void setBackupSection(Section value)
public TextInfo getBackupTextInfo()
TextInfo
object that indicates the backup TextInfo of the document.
public void setBackupTextInfo(TextInfo value)
TextInfo
object that indicates the backup TextInfo of the document.
value
- public static void setTimeOutOfFileWebRequest(java.net.URI url)
url
- Uri objectpublic void save(java.lang.String pdfFile)
pdfFile
- The file path and name to save the Pdf document.
Typical usages are the following:
public Color getBackgroundColor()
Color
object that indicates the
background color of the pdf.
public void setBackgroundColor(Color value)
Color
object that indicates the
background color of the pdf.
value
- public void save(java.lang.String fileName, SaveType saveType, aspose.pdf.HttpResponse response)
fileName
- The name for the document that will appear at the client browser.
The name should not contain path. If you use SaveType.OpenInBrowser,
the file name is of no use.saveType
- Specifies how the document is presented at the client browser.response
- The HttpResponse object to put the pdf to.public void save(java.io.OutputStream stream) throws java.io.IOException
OutputStream
object.
stream
- The OutputStream
object to which the document writes.
java.io.IOException
public void save(BasicStream stream)
BasicStream
object.
stream
- The BasicStream
object to which the document writes.public void setSecurity()
public void bindXML(XMLDocument xmlDoc, java.lang.String xslFile)
Pdf
object.
xmlDoc
- The xml document.xslFile
- The xsl documnet file name if XSLT is used.public void bindXML(java.io.InputStream xmlFile, java.io.InputStream xslFile) throws java.io.IOException
Pdf
object.
xmlFile
- The xml InputStream
stream.xslFile
- The xsl InputStream
stream if XSLT is used
java.io.IOException
public void bindXML(java.lang.String xmlFile, java.lang.String xslFile)
Pdf
object.
xmlFile
- The xml file.xslFile
- The xsl file if XSLT is usedpublic void bindXML(TextFileStream xmlStream, TextFileStream xslStream)
Pdf
object.
xmlStream
- The xml stream.xslStream
- The xsl stream. This parameter can be null if no xml is used.public void bindPCL(java.lang.String pclFileName)
Pdf
object.
pclFileName
- The PCL file.public byte[] getBuffer()
Gets the data buffer used to generate the pdf document in memory.
Typical usages are the following:
public PageSetup getPageSetup()
PageSetup
object that indicates the page setup info in the Pdf document.
public void setPageSetup(PageSetup value)
PageSetup
object that indicates the page setup info in the Pdf document.
value
- public TextInfo getTextInfo()
TextInfo
object that indicates the text info in the Pdf document.
public void getTextInfo(TextInfo value)
TextInfo
object that indicates the text info in the Pdf document.
value
- public GraphInfo getGraphInfo()
GraphInfo
object that indicates the graph info in the Pdf document.
public void setGraphInfo(GraphInfo value)
GraphInfo
object that indicates the graph info in the Pdf document.
value
- public aspose.pdf.xml.Page getPages()
Page
object that indicates the pages chain contains in this document.
public void setPages(aspose.pdf.xml.Page value)
Page
object that indicates the pages chain contains in this document.
value
- public int getPagesNumber()
public void setPagesNumber(int value)
value
- public Sections getSections()
Sections
collection that indicates all sections in the Pdf document.
public void setSections(Sections value)
Sections
collection that indicates all sections in the Pdf document.
value
- public int getFirstLineIndent()
public void setFirstLineIndent(int value)
value
- public boolean getIsSpaced()
public void setIsSpaced(boolean value)
public HeadingInfoArray getHeadingInfos()
public void setHeadingInfos(aspose.pdf.xml.HeadingInfoArray value)
value
- public Heading getFirstHeading()
Heading
object that indicates the first heading in this document.
public void setFirstHeading(Heading value)
Heading
object that indicates the first heading in this document.
value
- public float getLabelWidth()
public void setLabelWidth(float value)
value
- public aspose.pdf.xml.Substitute getFirstSubstitute()
public void setFirstSubstitute(aspose.pdf.xml.Substitute value)
value
- public aspose.pdf.xml.Substitute getLastSubstitute()
public void setLastSubstitute(aspose.pdf.xml.Substitute value)
value
- public int getCompressionLevel()
public void setCompressionLevel(int value)
value
- public DestinationType getDestinationType()
DestinationType
value that
indicates the document open action.
public void setDestinationType(DestinationType value)
DestinationType
value that
indicates the document open action.
public OpenType getOpenType()
OpenType
that indicates the document open type.
public void setOpenType(OpenType value)
OpenType
that indicates the document open type.
value
- public java.lang.String getAuthor()
public void setAuthor(java.lang.String value)
value
- public static int getTimeOutOfFileWebRequest()
public static void setTimeOutOfFileWebRequest(int value)
value
- public java.lang.String getTitle()
public void setTitle(java.lang.String value)
value
- public java.lang.String getCreator()
public void setCreator(java.lang.String value)
value
- public java.lang.String getProducer()
public void setProducer(java.lang.String value)
value
- public java.lang.String getKeywords()
public void setKeywords(java.lang.String value)
value
- public java.lang.String getSubject()
public void setSubject(java.lang.String value)
value
- public PageTransitionType getPageTransitionType()
PageTransitionType
that indicates the pdf document page transition type.
public void setPageTransitionType(PageTransitionType value)
PageTransitionType
that indicates the pdf document page transition type.
value
- public int getPageDuration()
public void setPageDuration(int value)
public Security getSecurity()
Security
object that indicates
the document security information.
public void setSecurity(Security value)
Security
object that indicates
the document security information.
value
- public CustomFonts getCustomFonts()
CustomFonts
object that indicates
the custom fonts of the document.
public void setCustomFonts(CustomFonts value)
Security
object that indicates
the custom fonts of the document.
value
- public GeneratorBase getTempGenerator()
GeneratorBase
object that indicates
the temp generator.
public void setTempGenerator(GeneratorBase value)
GeneratorBase
object that indicates
the temp generator.
value
- public GeneratorBase getTempGenerator1()
GeneratorBase
object that indicates
the temp generator.
public void setTempGenerator1(GeneratorBase TempGenerator1)
GeneratorBase
object that indicates
the temp generator.
TempGenerator1
- public boolean getIsImagesInXmlDeleteNeeded()
Reamrks: This property is used when integration with Aspose.Word. When converting Word document to PDF,Aspose.Word will save images in Word document as file and add the file name into XML. If this property is set to true,Aspose.Pdf will delete these image files used in XML.
public void setIsImagesInXmlDeleteNeeded(boolean value)
public aspose.pdf.pdftext.Hashmap getImagePath()
Hashmap
object that indicates
the Image path.
public void setImagePath(aspose.pdf.pdftext.Hashmap ImagePath)
Hashmap
object that indicates
the Image path.
ImagePath
- public boolean getIsFontMapCreated()
public void setIsFontMapCreated(boolean value)
value
- public boolean getIsBuffered()
getBuffer()
method can't be used.
public void setIsBuffered(boolean value)
getBuffer()
method can't be used.
public java.lang.Object getObjectByID(java.lang.String ID)
ID
- The object ID.
public ListSection getTableOfContents()
ListSection
object that indicates
the table of contents.
public ListSection getListOfTables()
ListSection
object that indicates
the list of table.
public ListSection getListOfFigures()
ListSection
object that indicates
the list of figures.
public void ProcessLists()
public boolean getIsBookmarked()
Heading
s
in the PDF if the relative property BookMarkLevel
is not set.
public void setIsBookmarked(boolean value)
Heading
s
in the PDF if the relative property BookMarkLevel
is not set.
value
- public int getBookMarkLevel()
Heading
of the pdf document is to be bookmarked.
The default value is 0, which means every heading of the PDF is to be taged as a bookmark.
Only when the relative property IsBookmarked
is set as true, this property is valid.
If IsBookmarked
is true and this property is set to a non-integer value levelNumber,
Aspose.Pdf will create bookmarks for the corresponding Heading
s of level 1 to level levelNumber.
public void setBookMarkLevel(int value)
Heading
of the pdf document is to be bookmarked.
The default value is 0, which means every heading of the PDF is to be taged as a bookmark.
Only when the relative property IsBookmarked
is set as true, this property is valid.
If IsBookmarked
is true and this property is set to a non-integer value levelNumber,
Aspose.Pdf will create bookmarks for the corresponding Heading
s of level 1 to level levelNumber.
value
- public float getTabStopPosition()
public void setTabStopPosition(float value)
value
- public java.lang.String getXmlFilePath()
public void setXmlFilePath(java.lang.String value)
value
- public aspose.pdf.html.HtmlInfo getHtmlInfo()
aspose.pdf.html.HtmlInfo
object that indicates the necessary info when converting
public void setHtmlInfo(aspose.pdf.html.HtmlInfo value)
aspose.pdf.html.HtmlInfo
object that indicates the necessary info when converting
value
- public boolean getIsPageNumberRestarted()
public void setIsPageNumberRestarted(boolean value)
value
- public boolean getIsCoreFontUsed()
public void setIsCoreFontUsed(boolean value)
value
- public boolean getIsXmlSchemaCheckedOnBind()
public void setIsXmlSchemaCheckedOnBind(boolean value)
value
- public boolean getIsPageNumberForDocument()
public void setIsPageNumberForDocument(boolean value)
value
- public boolean getIsTruetypeFontMapCached()
public void setIsTruetypeFontMapCached(boolean value)
value
- public java.lang.String getTruetypeFontMapPath()
public void setTruetypeFontMapPath(java.lang.String value)
value
- public void setTruetypeFontDirectoryPath(java.lang.String value)
value
- public java.lang.String getTruetypeFontDirectoryPath()
public MemStream getTruetypeFontMapStream()
public void getTruetypeFontMapStream(MemStream value)
value
- public static MemStream CreateTruetypeFontMapStream()
public boolean getIsFirstPageCreated()
public void setIsFirstPageCreated(boolean IsFirstPageCreated)
IsFirstPageCreated
- public boolean getIsSegmentMerged()
public void setIsSegmentMerged(boolean value)
value
- public int getRefPageID()
public void setRefPageID(int rd)
rd
- public int getPageCount()
save
method is called.
public float GetStringWidth(java.lang.String str, TextInfo info)
str
- The string.info
- The text formatting info.
Typical usages are the following:
public Watermarks getWatermarks()
Watermarks
which will be added upon each page
of the PDF document.
public void setWatermarks(Watermarks value)
Watermarks
which will be added upon each page
of the PDF document.
value
- public void checkWatermark(Sections sections)
sections
- public DocumentAttachments getDocumentAttachments()
DocumentAttachments
which will be added upon the PDF document.
public void getDocumentAttachments(DocumentAttachments value)
DocumentAttachments
which will be added upon the PDF document.
public boolean getIsFontNotFoundExceptionThrown()
public void setIsFontNotFoundExceptionThrown(boolean value)
value
- public java.util.ArrayList getToBeFreed()
public void setToBeFreed(java.util.ArrayList ToBeFreed)
ToBeFreed
- public boolean getIsWatermarkOnTop()
public void setIsWatermarkOnTop(boolean value)
value
- public boolean getIsLandscape()
public void setIsLandscape(boolean value)
value
- public static java.lang.Object CreateObjFromXml(java.lang.String xmlFile, java.lang.String xslFile)
xmlFile
- The xml file.xslFile
- The xsl file if XSLT is used.
Remarks: Section
, Text
, Graph
, Image
,
Segment
, Table
, Attachment
, FloatingBox
objects are supported.
Typical usages are the following:
public static java.lang.Object CreateObjFromXml(TextFileStream xmlStream, TextFileStream xslStream)
xmlStream
- The xml stream.xslStream
- The xsl stream. This parameter can be null if no xml is used.
Section
, Text
, Graph
, Image
,
Segment
, Table
, Attachment
,FloatingBox
objects are supported.
Typical usages are the following:
public static java.lang.Object createObjFromXml(XMLDocument xmlDoc, XslTransform xsl)
xmlDoc
- The xml document.xsl
- The XslTransform
object if XSLT is used.
Remarks: Section
, Text
, Graph
, Image
,
Segment
, Table
, Attachment
, FloatingBox
objects are supported.
Typical usages are the following:
public boolean getIsSaveState()
public void setIsSaveState(boolean IsSaveState)
IsSaveState
- public int GetPageNumber(java.lang.String ID)
ID
- The ID of the paragraph.
public JavaScripts getJavaScripts()
JavaScripts
object that indicates the JavaScripts to be added into
the PDF.
Typical usages are the following:
public void setJavaScripts(JavaScripts value)
JavaScripts
object that indicates the JavaScripts to be added into
the PDF.
value
- Typical usages are the following:
public XmpMetadata getXmpMetadata()
XmpMetadata
Object that indicates the XMP metadata to be added into the PDF document.
Typical usages are the following:
public void setXmpMetadata(XmpMetadata value)
XmpMetadata
Object that indicates the XMP metadata to be added into the PDF document.
value
- Typical usages are the following:
public void SetUnicode()
Remarks: When converting Word to Pdf, some font is needed to be set to unicode in Aspose.Pdf. This method is used to set all fonts to unicode. The font subset will then be embedded.
public java.lang.String getDefaultFontName()
public void setDefaultFontName(java.lang.String value)
value
- public boolean getIsRightToLeft()
public void setIsRightToLeft(boolean value)
value
- public boolean getIsRtlInSegmentMode()
public void setIsRtlInSegmentMode(boolean value)
value
- public boolean getIsWidowOrphanControlEnabled()
public void setIsWidowOrphanControlEnabled(boolean value)
value
- public boolean getIsAutoFontAdjusted()
public void getIsAutoFontAdjusted(boolean value)
value
- public Bookmarks getBookmarks()
Bookmarks
object that indicates the bookmarks in the PDF.
public void setBookmarks(Bookmarks value)
Bookmarks
object that indicates the bookmarks in the PDF.
value
- public boolean getLinearized()
public void setLinearized(boolean value)
public PdfConformance getConformance()
NOTE: This is beta version of PdfA.Gets a
PdfConformance
object that indicates the conformance in the PDF.
The default value is PdfConformance.None .
you need to set this property before Save method is called .
Notice that PdfConformance.PdfA1B and PdfConformance.PdfA1A currently only support TrueType fonts and RGB color space ,
specify a wrong font name or a CMYK color name will cause exception.
public void setConformance(PdfConformance value)
NOTE: This is beta version of PdfA.Sets a
PdfConformance
object that indicates the conformance in the PDF.
The default value is PdfConformance.None .
you need to set this property before Save method is called .
Notice that PdfConformance.PdfA1B and PdfConformance.PdfA1A currently only support TrueType fonts and RGB color space ,
specify a wrong font name or a CMYK color name will cause exception.
value
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |