public final class LegacyPdf extends XmlEntityWithInternals
Modifier and Type | Field and Description |
---|---|
int |
_OpenType
Enumerates the document open types.
|
int |
_PageTransitionType
Gets or sets a
PageTransitionType that indicates the pdf document page transition type
(i.e. |
String |
Author
Gets or sets a string that indicates the author of the Pdf document.
|
Color |
BackgroundColor
Gets or sets a
Aspose.Pdf.Generator.Color object that indicates the background color of the
pdf. |
int |
BookmarkLevel
Gets or sets a int value that indicates how many levels of
Heading of the pdf document is to be bookmarked. |
int |
CompressionLevel
Gets or sets an int value that indicates the compression level.
|
int |
Conformance |
int |
ConsecutiveHyphensLimits
Gets or sets an integer value that indicates the consecutive hyphens limits.
|
String |
Creator
Gets or sets a string that indicates the creator of the Pdf document.
|
String |
DefaultFontName
Gets or sets a string that indicates the default font name.
|
int |
DestinationType
Gets or sets a
DestinationType value that indicates the document open action. |
DocumentAttachments |
DocumentAttachments
Gets or sets a
DocumentAttachments which will be added upon the PDF document. |
int |
FirstLineIndent
Gets or sets an int value that indicates the indent of the first line.
|
GraphInfo |
GraphInfo
Gets or sets a
GraphInfo object that indicates the graph info in the Pdf document, that will be used as default one to all added Graph objects. |
String |
HyphenationDictionaryPath
Gets or sets a string that indicates the hyphenation dictionary path.
|
float |
HyphenationZoneWidth
Gets or sets a float value that indicates the hyphenation area width.
|
int |
InconsistentXmlImageParamsHandlingType
During loading of logical model of document from XML with BindXML method can be
found inconsistent combinations of image attributes .
|
Index |
Index
Gets or sets an
Index object. |
boolean |
IsAutoHyphenated
Gets or sets a bool value that indicates whehter the text is hyphenated automatically.
|
boolean |
IsBookmarked
Gets or sets a bool value that indicates whether the pdf document is bookmarked when generating PDF document.
|
boolean |
IsCoreFontUsed
Gets or sets a bool value that indicates whether PDF core fonts are used.
|
boolean |
IsFontNotFoundExceptionThrown
Gets or sets a bool value that indicates whether throw out exception when font is not found.
|
boolean |
IsImagesInXmlDeleteNeeded
Gets or sets a bool value that indicates whether images used in XML be deleted when the PDF
document is generated.
|
boolean |
IsLandscape
Gets or sets a bool value that indicates whether the page orientation is landscape.
|
boolean |
IsPageNumberForDocument
Gets or sets a bool value that indicates whether total page number is count for whole document.
|
boolean |
IsPageNumberRestarted |
boolean |
IsRightToLeft
Gets or sets a bool value that indicates whether the text or heading appear in the pdf is right-to-left aligned.
|
boolean |
IsRtlInSegmentMode
Gets or sets a bool value that indicates whether the text or heading is processed in segment mode.
|
boolean |
IsSpaced
Gets or sets a bool value that indicates whether the spaces at the begin of the text and returns in
the text be shown.
|
boolean |
IsTruetypeFontMapCached
Gets or sets a bool value that indicates whether truetype font map be cached on disk.
|
boolean |
IsWatermarkOnTop
Gets or sets a bool value that indicates if the watermark is on top of the page.
|
boolean |
IsWidowOrphanControlEnabled
Gets or sets a bool value that indicates whether the Widow/Orphan control is enabled.
|
boolean |
IsXmlSchemaCheckedOnBind
Gets or sets a bool value that indicates whether the error is ignored when unknown element(s) or attribute(s)
are used in xml file for this or that entitie's tags.
|
JavaScripts |
JavaScripts
Gets or sets a
JavaScripts object that indicates the JavaScripts to be added into
the PDF. |
String |
Keywords
Gets or sets a string that indicates key words of the Pdf document.
|
float |
LabelWidth
Gets or sets a float value that indicates the width of the heading label.
|
int |
PageDuration
Gets or sets a int value that indicates the duration in seconds for the current page.
|
int |
PageNumberFormat
Gets or sets a
PageNumberFormatType value that indicates the format of the page number . |
PageSetup |
PageSetup
Gets or sets a
PageSetup object that indicates default page setup parameters in the Pdf document. |
String |
Producer
This field indicates creator of the Pdf document(usually it's tool's name)
|
Sections |
Sections
Gets or sets a
Sections collection that indicates all sections in the Pdf document. |
Security |
Security
Gets or sets a
Aspose.Pdf.Generator.Security object that indicates the document security information(if any). |
String |
Subject
Gets or sets a string that indicates the subject of the Pdf document.
|
float |
TabStopPosition
Gets or sets the tab stop position.
|
String |
TempFolder |
TextInfo |
TextInfo
Gets or sets a
TextInfo object that indicates the text info in the Pdf document. |
String |
Title
Gets or sets a string that indicates the title of the Pdf document.
|
String |
TruetypeFontMapPath
Gets or set a string that indicates the path of the truetype font map file.
|
XmpMetadata |
XmpMetadata
Gets or sets a
XmpMetadata Object that indicates the XMP metadata to be added into the PDF document. |
Constructor and Description |
---|
LegacyPdf() |
Modifier and Type | Method and Description |
---|---|
Bookmarks |
getBookmarks()
Gets or sets a
Bookmarks object that indicates the bookmarks in the PDF. |
Watermarks |
getWatermarks()
Gets or sets a
Watermarks which will be added upon each page of the PDF document. |
void |
loadFromXml(InputStream xmlStream) |
void |
setBookmarks(Bookmarks value) |
void |
setWatermarks(Watermarks value) |
load
public String Author
Gets or sets a string that indicates the author of the Pdf document.
public String Title
Gets or sets a string that indicates the title of the Pdf document.
public String Creator
Gets or sets a string that indicates the creator of the Pdf document.
public String Producer
This field indicates creator of the Pdf document(usually it's tool's name)
public String Keywords
Gets or sets a string that indicates key words of the Pdf document.
public String Subject
Gets or sets a string that indicates the subject of the Pdf document.
public int _PageTransitionType
Gets or sets a PageTransitionType
that indicates the pdf document page transition type
(i.e. visual effect with which pages replaces each other in presentation mode).
public Sections Sections
Gets or sets a Sections
collection that indicates all sections in the Pdf document.
public TextInfo TextInfo
Gets or sets a TextInfo
object that indicates the text info in the Pdf document.
public GraphInfo GraphInfo
Gets or sets a GraphInfo
object that indicates the graph info in the Pdf document, that will be used as default one to all added Graph objects.
public DocumentAttachments DocumentAttachments
Gets or sets a DocumentAttachments
which will be added upon the PDF document.
public int InconsistentXmlImageParamsHandlingType
During loading of logical model of document from XML with BindXML method can be found inconsistent combinations of image attributes . F.e. setting Height, FixedHeight along with with usage of file-formats where sizes are set inside image bynary content itself, can lead to unexpected or weird distortions of image in result PDF-file. This parameter allows define processing behaviour in such situations. By default it's set as PutToConsistentStateIfPossibleOtherwiseThrowException.
public Security Security
Gets or sets a Aspose.Pdf.Generator.Security
object that indicates the document security information(if any).
public boolean IsAutoHyphenated
Gets or sets a bool value that indicates whehter the text is hyphenated automatically. Default value is false.
Pdf pdf = new Pdf(); pdf.IsAutoHyphenated = true; pdf.HyphenationZoneWidth = 0; pdf.ConsecutiveHyphensLimits = 0; //no limits pdf.HyphenationDictionaryPath = @"c:\temp\Hyphen.xml" pdf.BindXML("C:/xml/Test.xml",null); pdf.Save(C;/Pdf/Test.pdf);
public boolean IsXmlSchemaCheckedOnBind
Gets or sets a bool value that indicates whether the error is ignored when unknown element(s) or attribute(s) are used in xml file for this or that entitie's tags. Default is false, i.e. unknown attributes or elements are just ignored and loading does not stop.
public XmpMetadata XmpMetadata
Gets or sets a XmpMetadata
Object that indicates the XMP metadata to be added into the PDF document.
[JAva] Pdf pdf = new Pdf(); Section s = pdf.getSections.add(); Text text1 = new Text("This is a test for XMP Metadata"); s.getParagraphs().add(text1); pdf.XmpMetadata = new XmpMetadata(); //core properties pdf.getXmpMetadata().addCreationDate(new Date.toString()); //user properties pdf.getXmpMetadata().addUserProperty("xmlns:dc=\"http://purl.org/dc/elements/1.1/\"","dc:contributor","Aspose"); pdf.save("d:\\test\\test.pdf"); [XML] <Pdf xmlns="Aspose.Pdf"> <XmpMetadata> <MetadataItem Name="CreationDate" Value="2007-7-15 10:51:55" /> <MetadataItem XmlNamespace="xmlns:dc='http://purl.org/dc/elements/1.1/'" Name="dc:contributor" Value="Aspose" /> </XmpMetadata> <Section> <Text><Segment>This is a test for XMP Metadata</Segment></Text> </Section> </Pdf>
public int FirstLineIndent
Gets or sets an int value that indicates the indent of the first line. (size of blank space at the beginning of the text paragraph).
public boolean IsSpaced
Gets or sets a bool value that indicates whether the spaces at the begin of the text and returns in the text be shown. For the following XML:
<Text> <Segment>The first line, The second line.</Segment> </Text>If IsSpaced is false, the result will be:
The first line,The second line.If IsSpaced is true, the result will be:
The first line, The second line.
public boolean IsPageNumberRestarted
public boolean IsRightToLeft
Gets or sets a bool value that indicates whether the text or heading appear in the pdf is right-to-left aligned. If it is true, all the texts and headings will be processed as right-to-left language previously. If text or heading don't contain any right-to-left lanuage character, they will be processed as usual( left-to-right). This property is used for right-to-left aligned language such as Arabic and Hebrew.
public boolean IsRtlInSegmentMode
Gets or sets a bool value that indicates whether the text or heading is processed in segment mode. If it is true(default),segment in text will be processed one by one. If false, all segments in text will be put together, reorder in arabic rule. We recommend set it true when rendering rtl and non-rtl mixed texts.
public boolean IsWidowOrphanControlEnabled
Gets or sets a bool value that indicates whether the Widow/Orphan control is enabled. Default is true. If it is true, Widow/Orphan control is enabled and Widows/orphans themselves are eliminated (disabled).
public boolean IsLandscape
Gets or sets a bool value that indicates whether the page orientation is landscape. The default is false, portrait.
public boolean IsWatermarkOnTop
Gets or sets a bool value that indicates if the watermark is on top of the page.
public boolean IsTruetypeFontMapCached
Gets or sets a bool value that indicates whether truetype font map be cached on disk. Truetype font map is a font name to font file name map which is used when using unicode. If unicode is used, setting this property to true can make your application run fast. If this property is set to true and the system's fonts are changed (for example, new fonts are installed), delete the font map file (Aspose.Pdf.Generator.TruetypeFontMap.xml) and it will be generated again automatically.
public String HyphenationDictionaryPath
Gets or sets a string that indicates the hyphenation dictionary path.
public float HyphenationZoneWidth
Gets or sets a float value that indicates the hyphenation area width. Default value is 12 points.
public int ConsecutiveHyphensLimits
Gets or sets an integer value that indicates the consecutive hyphens limits. Default value is zero that means no limits.
public int CompressionLevel
Gets or sets an int value that indicates the compression level. It can be between 0 (the least compression) and 9 (the most compression) and the default value is 6.
public Color BackgroundColor
Gets or sets a Aspose.Pdf.Generator.Color
object that indicates the background color of the
pdf.
public String DefaultFontName
Gets or sets a string that indicates the default font name. When font name is not set or the font is not found, this font will be used. The default value is "Times-Roman".
public float TabStopPosition
Gets or sets the tab stop position. Default value is 36 points (0.5inch).
public int PageNumberFormat
Gets or sets a PageNumberFormatType
value that indicates the format of the page number .
public String TruetypeFontMapPath
Gets or set a string that indicates the path of the truetype font map file. This property is valid only when the "IsTruetypeFontMapCached" property is set to true.
IsTruetypeFontMapCached
public String TempFolder
public Index Index
Gets or sets an Index
object.
public JavaScripts JavaScripts
Gets or sets a JavaScripts
object that indicates the JavaScripts to be added into
the PDF.
[Java] Pdf pdf = new Pdf(); pdf.setJavaScripts ( new JavaScripts()); pdf.getJavaScripts().add("this.print(true);"); pdf.getJavaScripts().add("app.alert(\"hello world\");"); pdf.save("d:\\test\\test.pdf"); [XML] <Pdf xmlns="Aspose.Pdf"> <JavaScript ID="js1">this.print(true);</JavaScript> <JavaScript>app.alert("hello world");</JavaScript> </Pdf>
public boolean IsPageNumberForDocument
Gets or sets a bool value that indicates whether total page number is count for whole document. If this property is set to true, the "$P" symbol will be replaced by the total page number of the document. Otherwise "$P" will be replaced with the total page number of all sections that were not restarted ("IsPageNumberRestarted" is set to true).
public boolean IsFontNotFoundExceptionThrown
Gets or sets a bool value that indicates whether throw out exception when font is not found. The default value is false.In this case,if user specified font is not found,default font works.
public boolean IsCoreFontUsed
Gets or sets a bool value that indicates whether PDF core fonts are used. Default is true. If this property is set to false, PDF core fonts will be ignored and all font will be used as TrueType font.
public boolean IsImagesInXmlDeleteNeeded
Gets or sets a bool value that indicates whether images used in XML be deleted when the PDF document is generated.
public boolean IsBookmarked
Gets or sets a bool value that indicates whether the pdf document is bookmarked when generating PDF document.
The default value is false. If this property is set to true, Aspose.Pdf.Generator will create bookmarks for all the Heading
s
in the PDF if the relative property BookMarkLevel
is not set.
public int BookmarkLevel
Gets or sets a int value that indicates how many levels of 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.Generator will create bookmarks
for the corresponding Heading
s of level 1 to level levelNumber.
public int Conformance
public int DestinationType
Gets or sets a DestinationType
value that indicates the document open action.
values are : Retain, FitPage, FitWidth, FitHeight,FitBox
public int _OpenType
Enumerates the document open types.
public int PageDuration
Gets or sets a int value that indicates the duration in seconds for the current page. This property is used when using auto advancing in presentation mode.
public float LabelWidth
Gets or sets a float value that indicates the width of the heading label.
public PageSetup PageSetup
Gets or sets a PageSetup
object that indicates default page setup parameters in the Pdf document.
public Bookmarks getBookmarks()
Gets or sets a Bookmarks
object that indicates the bookmarks in the PDF.
public void setBookmarks(Bookmarks value)
public Watermarks getWatermarks()
Gets or sets a Watermarks
which will be added upon each page of the PDF document.
public void setWatermarks(Watermarks value)
public void loadFromXml(InputStream xmlStream)
Copyright © 2014 Aspose. All Rights Reserved.