Page Comparison

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. Default value: 0 (do not recompute, keep pictures as they are)
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:

Code Block
PDFL::AttachtoPDFDocument(toSession)

Parameters:

toSession
Instance of XFRX#INIT object.

EndPage()

Close current page.

Syntax:

Code Block
PDFL::EndPage()

CreateDocument()

Creates a new XFF file.

Syntax:

Code Block
PDFL::CreateDocument( m.tcName, m.tlAdd, m.tcOwner, m.tcUser)

Return values

0 … the file was successfully created
-1 … file couldn’t have been created ()

An existing file is overwritten.

Parameters:

tcName
The file name if the document to be created. If this parameter is empty, the XFF file is created in memory.

tlAdd
If .T. and file exist then output will be add to existing file..

m.tcOwner
The owner password.

m.tcUser
The user password

FinishDocument()

Close current page.Ends the creation of the document.

Syntax:

Code Block
PDFL::FinishDocument()

NewPage()

Adds a new page at the end of the document.

Syntax:

Code Block
PDFL::NewPage(tnPageWidth, tnPageHeight)

Parameters:

tnPageWidth, tnPageHeight
The width and height of the new page.

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:

Code Block
PDFL::SetOtherParams(..)

ShowDocument()

Show PDF file via shell API.

Syntax:

Code Block
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.

Code Block
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:

Code Block
PDFL::AddBox(m.x0, m.y0, m.nwidth, m.nheight, m.nsize, m.nfill, m.tnpenpat, m.noffset, m.tnMode)

Parameters:

X0, Y0
The X,Y coordinates of the upper left hand corner.

nWidth
The width of the rectangle

nHeight
The height of the rectangle

nSize
The line width in points. 0 represents hairline. Optional, default value = 1.

tnFill
    The fill pattern:
      0 ... No fill
      1 ... Fill (color)
      2 ... Horizontal Line
      3 ... Vertical Line
      4 ... Upward Diagonal
      5 … Downward Diagonal
      6 ... Cross
      7 ... Diagonal Cross

Optional, default value = 0.

tnPenPat
   The border line pattern:
      0 ... no border
      1 ... dotted
      2 ... dashed
      3 ... dash-dot
      4 ... dash-dot-dot
      8 … solid line

Optional, default value = 8.

nOffset
The radius of the rectangle edges curvature. 0 makes the rectangle right-angled (no rounding), 99 creates an ellipse. Optional, default value = 0.

tnMode
   The mode opaque/transparent (since XFRX 16.0):
      0 ... Opaque
      1 ... Transparent

Optional, default value = 0.

Info
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:

Code Block
PDFL::AddLine(m.x0, m.y0, m.x1, m.y1, m.lnWidth [, m.lnPattern[, m.tnRotation]])

Parameters:

X0, Y0
The X,Y coordinates of the start point of the line.

X1, Y1
The X,Y coordinates of the end point of the line.

lnWidth
The line width in points. 0 represents hairline. Optional, default value = 1.

lnPenPattern
   The border line pattern:
      0 ... no border
      1 ... dotted
      2 ... dashed
      3 ... dash-dot
      4 ... dash-dot-dot
      8 … solid line

Optional, default value = 8.

tnRotation Rotation angle. Optional, default value = 0.

Info
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:

Code Block
PDFL::AppendLine(m.tnx, m.tny)

Parameters:

tnX, tnY
The X,Y coordinates of the end point of the line.

AppendBezier()

Append a bezier line from current position on the current page.

Syntax:

Code Block
PDFL::AppendBezier(m.tnx, m.tny, m.tnx1, m.tny1, m.tnx2, m.tny2)

Parameters:

tnX, tnY
The X,Y coordinates of the upper left hand corner of the bounding rectangle.

tnX1, tnY1
The X,Y coordinates of the end point of the line.

tnX1, tnY1
A control points of Bézier.

AddPicture()

Draws a picture on the current page into a given bounding rectangle.

Syntax:

Code Block
PDFL::AddPicture(m.tcPic, m.tnLeft, m.tnTop, m.tnWidth, m.tnHeight, m.tnAdjType, m.tnRotate, m.lnRotationPoint [, m.lcLinkName[, m.lcLinkHref [, m.lcmyk[, m.lneg[, m.tcMask]]]]])

Parameters:

tcPic
The picture file name

tnLeft, tnTop
The X,Y coordinates of the upper left hand corner of the bounding rectangle.

tnWidth
The width of the rectangle

tnHeight
The height of the rectangle

tnAdjType
   0 … clip picture
   1 … stretch picture, retain shape
   2 … stretch picture, fill frame

tnRotate
The text rotation angle in degrees. The label will be rotated counterclockwise. Optional, default value = 0.

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
If this parameter is filled, the text will be a named target of a hyperlink. (see lcLinkRef parameter).

lcLinkRef
If this parameter is filled, the text will be a hyperlink. It will navigate to a target with lcLinkRef name.

lcmyk
.T. or .F. if JEG image use CMYK..

lNeg
.T. or .F. if image use negative colors.

tcMask
Mask color for transparent See to transparent image.

AddGenPicture()

Draws a general field on the current page into a given bounding rectangle.

Syntax:

Code Block
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]]]]])

Parameters:

tcField
The general field name

tnLeft, tnTop
The X,Y coordinates of the upper left hand corner of the bounding rectangle.

tnWidth
The width of the rectangle

tnHeight
The height of the rectangle

tnAdjType
   0 … clip picture
   1 … stretch picture, retain shape
   2 … stretch picture, fill frame

tnRotate
The text rotation angle in degrees. The label will be rotated counterclockwise. Optional, default value = 0.

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
If this parameter is filled, the text will be a named target of a hyperlink. (see lcLinkRef parameter).

lcLinkRef
If this parameter is filled, the text will be a hyperlink. It will navigate to a target with lcLinkRef name.

lcmyk
.T. or .F. if JEG image use CMYK..

lNeg
.T. or .F. if image use negative colors.

tcMask
Mask color for transparent See to transparent image.

newLine()

Change position for new line.

Syntax:

Code Block
PDFL::NewLine()

outText()

Put text to current position.

Syntax:

Code Block
PDFL::OutText(m.tcText, m.tnRotation, m.lnRotationPoint, m.llAddBackColor, m.lcLinkName, m.lcLinkHref)

Parameters:

tcText
   Output text.

tnRotation
   The text rotation angle in degrees. The label will be rotated counterclockwise. Optional, default value = 0.

lnRotationPoint
   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.

llAddBackColor
   Add background color under text.

lcLinkName
   If this parameter is filled, the text will be a named target of a hyperlink. (see lcLinkRef parameter).

lcLinkHref
If this parameter is filled, the text will be a hyperlink. It will navigate to a target with lcLinkRef name.

SetBackColor()

Sets the background drawing colors.

Syntax:

Code Block
PDFL::SetColor(tbr, tbg, tbb)

Parameters:

tbr, tbg, tbb
Red, green and blue components of the background color (optional)

SetColor()

Sets the foreground and background drawing colors.

Syntax:

Code Block
PDFL::SetColor(tfr, tfg, tfb, tbr, tbg, tbb)

Parameters:

tfr, tfg, tfb
Red, green and blue components of the foreground color

tbr, tbg, tbb
Red, green and blue components of the background color (optional)

SetFont()

Sets font name and attributes for subsequent DrawText() or DrawTextBox() calls.

Syntax:

Code Block
PDFL::SetFont(tcFontName, tnSize[, tlBold[, tlItalic[, tlUnderline [, tnEmbed[, lnCodePage ]]]]])

Parameters:

tcFontName
The font name

tnSize
The font size in points

tlBold, tlItalics, tlUnderline
The font attributes. These parameters are optional, the default value is .F.

tnEmbed
Font embedding

0 - font will not be embedded.
1 - font will be included as subset
2 - font will be included as all characters
3 - font will be included as UNICODE subset

lnCodePage
Code page.

SetForeColor()

Sets the foreground drawing colors.

Syntax:

Code Block
PDFL::SetColor(tfr, tfg, tfb)

Parameters:

tfr, tfg, tfb
Red, green and blue components of the foreground color

SetPos()

Sets the position where the text will be drawn by the subsequent DrawText() method call.

Syntax:

Code Block
PDFL::SetPos(tnXPos, tnYPos)

Parameters:

tnXPos, tnYPos
The X and Y (horizontal and vertical) coordinates of the position. The unit of the coordinates is defined by SetUnit() method, the default unit is Point (pt).

Table of Contents

Page Comparison

Versions Compared

Old Version 7

New Version 8

Key

Properties:

PictureDPI

DefaultPictureFormat

JPEGQuality

Methods:

Control document

attachToPDFDocument()

EndPage()

CreateDocument()

FinishDocument()

NewPage()

SetOtherParams()

ShowDocument()

Document properties

setVersion()

setEmbeddingType()

setPDFA()

setOutline()

setSubject()

setKeywords()

setCreator()

setProducer()

setCreationDate()

setComments()

setCategory()

setManager()

setCompany()

setAuthor()

setTitle()

setPermissions()

setPasswords()

DigitalSignature()

Drawing methods

AddBox()

AddLine()

AppendLine()

AppendBezier()

AddPicture()

AddGenPicture()

newLine()

outText()

SetBackColor()

SetColor()

SetFont()

SetForeColor()

SetPos()