- Created by martinajindrova, last modified on Apr 06, 2019
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 10 Next »
Properties:
PictureDPI | ||
---|---|---|
DPI (dots-per-inch) resolution to which all pictures are recomputed. You can use this property to reduce the output document size. This property must be sent before calling the SetParams method. | ||
DefaultPictureFormat | ||
Picture format of activeX components converted to pictures. Allowed values: “bmp”, “jpg”, "png", "tif", "gif" Default value: “jpg” | ||
JPEGQuality | ||
JPEG Quality for converting to JPEG format. Default value: 80 | XFRX 15.1.0 |
Methods:
Control document | |
---|---|
attachToPDFDocument() | |
Attach XFRX#INIT object with PDF output. Syntax: PDFL::AttachtoPDFDocument(toSession) Parameters: toSession | |
EndPage() | |
Close current page. Syntax: PDFL::EndPage() | |
CreateDocument() | |
Creates a new XFF file. Syntax: PDFL::CreateDocument( m.tcName, m.tlAdd, m.tcOwner, m.tcUser) Return values 0 … the file was successfully created An existing file is overwritten. Parameters: tcName tlAdd m.tcOwner m.tcUser | |
FinishDocument() | |
Close current page.Ends the creation of the document. Syntax: PDFL::FinishDocument() | |
NewPage() | |
Adds a new page at the end of the document. Syntax: PDFL::NewPage(tnPageWidth, tnPageHeight) Parameters: tnPageWidth, tnPageHeight | |
SetOtherParams() | |
This method is used to add various output type specific parameters. The first parameter is a string value representing the parameter to be set, the second parameter is the values to be set. See to SetOtherParams(…) Syntax: PDFL::SetOtherParams(..) | |
ShowDocument() | |
Show PDF file via shell API. Syntax: PDFL::ShowDocument() | |
Document properties | |
setVersion() | |
Set PDF file version. See to PDF parameter VERSION. | |
setEmbeddingType() | |
Set font embedding. See to PDF Font Embedding. | |
setPDFA() | |
Set PDF\A version. See to PDF/A support | |
setOutline() | |
Set flag of bookmarks. PDFL::SetOutline(m.tlShow) | |
setSubject() | |
Set subject for output file. See to setSubject(). | |
setKeywords() | |
Set keywords for output file. See to setKeywords(). | |
setCreator() | |
Set creator for output file. See to setCreator(). | |
setProducer() | |
Set producer for output file. See to setProducer(). | |
setCreationDate() | |
Set creations date for output file. See to setCreationDate(). | |
setComments() | |
Set comments for output file. See to setComments(). | |
setCategory() | |
Set category for output file. See to setCategory(). | |
setManager() | |
Set manager for output file. See to setManager(). | |
setCompany() | |
Set company for output file. See to setCompany(). | |
setAuthor() | |
Set author for output file. See to setAuthor(). | |
setTitle() | |
Set title for output file. See to setTitle() | |
setPermissions() | |
Set the user permissions in the PDF document. See to setPermissions(). | |
setPasswords() | |
Set password for output file. See to setPasswords(). | |
DigitalSignature() | |
Set digital signature for output file. See to PDF specific features#DigitalsignaturesinPDF. | |
Drawing methods | |
AddBox() | |
Draws a rectangle on the current page. Syntax: PDFL::AddBox(m.x0, m.y0, m.nwidth, m.nheight, m.nsize, m.nfill, m.tnpenpat, m.noffset, m.tnMode, m.tnRotate, m.lnRotationPoint) Parameters: X0, Y0 nWidth nHeight nSize tnFill Optional, default value = 0. tnPenPat Optional, default value = 8. nOffset tnMode Optional, default value = 0. tnRotate (since XFRX 17.3) The text rotation angle in degrees. The label will be rotated counterclockwise. Optional, default value = 0. tnRotationPoint (since XFRX 17.3) The point within the rectangle around which the text is rotated. The allowed values are 0..8, optional, default value = 0 (left, top). Please see the picture on the right for the point positions. The border and fill color needs to be defined via SetColor() method before calling AddBox() method. | |
AddLine() | |
Draws a line on the current page. Syntax: PDFL::AddLine(m.x0, m.y0, m.x1, m.y1, m.lnWidth [, m.lnPattern[, m.tnRotation]]) Parameters: X0, Y0 X1, Y1 lnWidth lnPenPattern Optional, default value = 8. tnRotation Rotation angle. Optional, default value = 0. The border color needs to be defined via SetForeColor() method before calling AddLine() method. | |
AppendLine() | |
Append a line from current position on the current page. Syntax: PDFL::AppendLine(m.tnx, m.tny) Parameters: tnX, tnY | |
AppendBezier() | |
Append a bezier line from current position on the current page. Syntax: PDFL::AppendBezier(m.tnx, m.tny, m.tnx1, m.tny1, m.tnx2, m.tny2, m.lcType ) Parameters: tnX, tnY tnX1, tnY1 m.lcType | |
AddPicture() | |
Draws a picture on the current page into a given bounding rectangle. Syntax: PDFL::AddPicture(m.tcPic, m.tnLeft, m.tnTop, m.tnWidth, m.tnHeight, m.tnAdjType, m.tnRotate, m.tnRotationPoint [, m.lcLinkName[, m.lcLinkHref [, m.lcmyk[, m.lneg[, m.tcMask[, m.lcMaskImage]]]]]]) Parameters: tcPic tnLeft, tnTop tnWidth tnHeight tnAdjType tnRotate tnRotationPoint The point within the rectangle around which the text is rotated. The allowed values are 0..8, optional, default value = 0 (left, top). Please see the picture on the right for the point positions. lcLinkName lcLinkRef lcmyk lNeg tcMask m.lcMaskImage | |
AddGenPicture() | |
Draws a general field on the current page into a given bounding rectangle. Syntax: PDFL::AddGenPicture(m.tcField, m.tnLeft, m.tnTop, m.tnWidth, m.tnHeight, m.tnAdjType, m.tnRotate, m.lnRotationPoint [, m.lcLinkName[, m.lcLinkHref [, m.lcmyk[, m.lneg[, m.tcMask[, m.lcMaskImage]]]]]]) Parameters: tcField tnLeft, tnTop tnWidth tnHeight tnAdjType tnRotate tnRotationPoint The point within the rectangle around which the text is rotated. The allowed values are 0..8, optional, default value = 0 (left, top). Please see the picture on the right for the point positions. lcLinkName lcLinkRef lcmyk lNeg tcMask m.lcMaskImage | |
newLine() | |
Change position for new line. Syntax: PDFL::NewLine() | |
outText() | |
Put text to current position. Syntax: PDFL::OutText(m.tcText, m.tnRotation, m.lnRotationPoint, m.llAddBackColor, m.lcLinkName, m.lcLinkHref) Parameters: tcText | |
SetBackColor() | |
Sets the background drawing colors. Syntax: PDFL::SetColor(tbr, tbg, tbb) Parameters: tbr, tbg, tbb | |
SetColor() | |
Sets the foreground and background drawing colors. Syntax: PDFL::SetColor(tfr, tfg, tfb, tbr, tbg, tbb) Parameters: tfr, tfg, tfb tbr, tbg, tbb | |
SetFont() | |
Sets font name and attributes for subsequent DrawText() or DrawTextBox() calls. Syntax: PDFL::SetFont(tcFontName, tnSize[, tlBold[, tlItalic[, tlUnderline [, tnEmbed[, lnCodePage ]]]]]) Parameters: tcFontName tnSize tlBold, tlItalics, tlUnderline 0 - font will not be embedded. | |
SetForeColor() | |
Sets the foreground drawing colors. Syntax: PDFL::SetColor(tfr, tfg, tfb) Parameters: tfr, tfg, tfb | |
SetPos() | |
Sets the position where the text will be drawn by the subsequent DrawText() method call. Syntax: PDFL::SetPos(tnXPos, tnYPos) Parameters: tnXPos, tnYPos |
- No labels