PL/PDF

PL/PDF
User's Guide
v5.24

1
www.plpdf.com [email protected]
 PL/PDF
Contents

Introduction ...........................................................................1
Installation .........................................................................1
Using PL/PDF .........................................................................1
Documentation ........................................................................1
Code Examples ........................................................................1
Contact ..............................................................................1
Certification ..........................................................................2
GetCertKey ...........................................................................2
checkCertKey .........................................................................2
getLicencedProductsV5 ................................................................2
Administrative commands ................................................................3
AddCJKFont ...........................................................................3
AddTTF ...............................................................................3
init .................................................................................3
init1 ................................................................................3
getVersion ...........................................................................4
setRotatePages .......................................................................4
sendDoc ..............................................................................4
setAllMargin .........................................................................4
setAutoNewPage .......................................................................5
setNOCompress ........................................................................5
setDocAuthor .........................................................................5
setDocCreator ........................................................................5
setDocDisplayMode ....................................................................5
setDocKeywords .......................................................................6
setDocSubject ........................................................................6
SetDocTitle ..........................................................................6
setEncoding ..........................................................................6
setHeaderProcName ....................................................................7
setHeaderProcName5 ...................................................................7
set3HeaderProcName ...................................................................8
setFooterProcName ....................................................................8
setFooterProcName5 ...................................................................8
set3FooterProcName ...................................................................9
setBackgroundColor ...................................................................9
SetWatermarkProcName .................................................................9
SetStampProcName .....................................................................9
setNewPageProcName ...................................................................9
setLeftMargin .......................................................................10
setTopMargin ........................................................................10
setRightMargin ......................................................................10
setBottomMargin .....................................................................10
setNOLastpageProcName ...............................................................10
SetPageNoStart ......................................................................11
SetPageNoEnd ........................................................................11
getPageNoAlter ......................................................................11
 PL/PDF
SetProtection .......................................................................11
setPDFA1B ...........................................................................11
setID ...............................................................................12
Navigations and formatting commands ...................................................13
checkPageBreak ......................................................................13
getCurrPageNum ......................................................................13
getNumOfPages .......................................................................13
getLeftMargin .......................................................................13
getRightMargin ......................................................................13
getTopMargin ........................................................................13
getBottomMargin .....................................................................14
getHeaderHeight .....................................................................14
getFooterHeight .....................................................................14
getCurrentX .........................................................................14
getCurrentY .........................................................................14
getPageAvailableHeight ..............................................................14
getPageAvailableWidth ...............................................................15
getPageHeight .......................................................................15
getPageRightSpace ...................................................................15
getPageLeftSpace ....................................................................15
getPageSpace ........................................................................15
getPageWidth ........................................................................15
getPageBottomSpace ..................................................................16
getPrintFontKey .....................................................................16
getPrintFontName ....................................................................16
getPrintFontStyle ...................................................................16
getPrintFontSize ....................................................................16
getScaleFactor ......................................................................16
getTextWidth ........................................................................16
getTextwidthFont ....................................................................17
removeMissingChars ..................................................................17
insertMovePage ......................................................................17
NewPage .............................................................................17
SetNoPrintFooter ....................................................................18
setNoPrintHeader ....................................................................18
setCurrentX .........................................................................18
setCurrentY .........................................................................18
setCurrentXY ........................................................................18
NewLine .............................................................................19
Content Related Commands ..............................................................20
AttachFile ..........................................................................20
crBookmark ..........................................................................20
PrintoutText ........................................................................20
Circle ..............................................................................20
Ellipse .............................................................................21
Line ................................................................................21
Polygon .............................................................................21
Path ................................................................................22
Rect ................................................................................22
RoundedRect .........................................................................22
Sector ..............................................................................23
 PL/PDF
EndOpacity ..........................................................................23
EndOptCont ..........................................................................23
putImage ............................................................................23
putImage ............................................................................24
putImage ............................................................................24
putInternalLink .....................................................................24
putExternalLink .....................................................................25
putLink .............................................................................25
setStrokingColor ....................................................................25
setNonStrokingColor .................................................................25
addJavaScript .......................................................................26
LineWidth ...........................................................................26
crInternalLink ......................................................................26
setLinkDest .........................................................................26
crInternalLinkDest ..................................................................26
setPrintFont ........................................................................27
setPrintFontSize ....................................................................27
setRotate ...........................................................................27
startClipping .......................................................................28
EndClipping .........................................................................28
isInClipping ........................................................................28
startOpacity ........................................................................28
startOptCont ........................................................................28
Template Related Commands .............................................................30
InsTemplate .........................................................................30
setPageTemplate .....................................................................30
setPageDefaultTemplate ..............................................................30
UseTemplate .........................................................................30
Digital Signature Related Commands ....................................................31
setDigSig ...........................................................................31
setNeedAppearances ..................................................................31
getCalcCurrPageNum ..................................................................31
getCalcCurrPageNum ..................................................................31
PL/PDF v2 Compatible procedures and functions .........................................33
LineBreak ...........................................................................33
setLineWidth ........................................................................33
getLineWidth ........................................................................33
DrawLine ............................................................................33
DrawRect ............................................................................33
drawRoundedRect .....................................................................34
DrawEllipse .........................................................................34
DrawCircle ..........................................................................34
drawSector ..........................................................................35
DrawPolygon .........................................................................35
PrintText ...........................................................................35
setCellMargin .......................................................................35
getCellMargin .......................................................................36
setCellBottomMargin .................................................................36
setCellLeftMargin ...................................................................36
setCellRightMargin ..................................................................36
setCellTopMargin ....................................................................36
 PL/PDF
getCellBottomMargin .................................................................36
getCellLeftMargin ...................................................................37
getCellRightMargin ..................................................................37
getCellTopMargin ....................................................................37
getTextHeight .......................................................................37
getCellMinHeight ....................................................................37
getCellMinHeightFont ................................................................37
getCellMinWidth .....................................................................38
getCellMinWidthFont .................................................................38
PrintCell ...........................................................................39
PrintMultiLineCell ..................................................................39
PrintFlowingText ....................................................................40
PrintFlowingTextLimit ...............................................................41
PrintImageCell ......................................................................41
setColor4Drawing ....................................................................42
setColor4Drawing ....................................................................42
setColor4Filling ....................................................................43
setColor4Filling ....................................................................43
setColor4Text .......................................................................43
setColor4Text .......................................................................43
getColor4Drawing ....................................................................43
getColor4Filling ....................................................................44
getColor4Text .......................................................................44
 PL/PDF
Introduction
PL/PDF is a PL/SQL based PDF document generator from Oracle databases. Use
PL/PDF to quickly and easily develop applications with dynamic content but also
quality presentation and printing capabilities.

Installation

Before using PL/PDF, make sure that the steps described in the Installation
Guide were completed.

Using PL/PDF

Essentially, PL/PDF is a series of calls to PL/PDF procedures and functions

Documentation

The PL/PDF documentation is available at: http://www.plpdf.com/downloads

Code Examples

PL/PDF code examples can be found at: http://plpdf.com/index.php/support/exampl

Contact

Contact us at: mailto:[email protected]

5
www.plpdf.com [email protected]
 PL/PDF
Certification
GetCertKey

Type: Function
Description : Generates preliminary certification key.
This function should be run once when the PL/PDF package is installed. The
function generates a string
that should be sent to mailto:[email protected] . Our representatives will send a
certificate key back that shouldbe used as the return value in the
pl_pdf_cert.SetCertKey function.
Version: v5.0
Parameters : -
Return : varchar2 : Preliminary certificate key

checkCertKey

Type: Function
Description : Checks the certification key.
Usage:
declare
l_ret boolean;
begin
l_ret := plpdf.checkCertKey;
if l_ret then
dbms_output.put_line('true');
else
dbms_output.put_line('false');
end if;
end;

Version: v3.0.0
Parameters : -
Return : boolean : validity of the key

getLicencedProductsV5

Type: Function
Description : This function returns with licence informations as a string.
Version: v4.1.0
Parameters : -
Return : varchar2 : Licence

6
www.plpdf.com [email protected]
 PL/PDF
Administrative commands

AddCJKFont

Type: Procedure
Description : Add CJK (Chinese/Japanese/Korean) font.
Version: v3.0.0
Parameters :
- p_name varchar2 : name of font
o japanese: 'HeiseiKakuGo-W5'
o korean: 'HYSMyeongJoStd-Medium-Acro'
o chinese: 'MSungStd-Light-Acro', 'STSongStd-Light-Acro'
Return : -

AddTTF

Type: Procedure
Description : Imports a TTF (True Type Font). The imported font becomes
available to the SetPrintFont procedure.
The font is stored as binary data in the PDF file.
Version: v3.0.0
Parameters :
- p_family varchar2 : TTF name
- p_style varchar2 default null : Font style
o null: Regular
o B: Bold
o I: Italic
o BI or IB: Bold and Italic
- p_data t_addfont : Data structure necessary to insert the font. It contains
the font definition binary file as well
- p_embed boolean default true : PDF containts TTF binary file or not
Return : -

init

Type: Procedure
Description : Initializes generator program variables.
Version: v3.0.0
Parameters :
- p_orientation varchar2 default 'P' : Orientation
o P: portrait
o L: landscape
- p_unit varchar2 default 'mm' : Unit of measure
- p_format varchar2 default 'A4' : Page format
Return : -

init1

Type: Procedure

7
www.plpdf.com [email protected]
 PL/PDF
Description : Initializes generator program variables.
Version: v3.0.0
Parameters :
- p_orientation varchar2 default 'P' : Orientation
o P: portrait
o L: landscape
- p_unit varchar2 default 'mm' : Unit of measure
- p_format plpdf_type.t_pageformat : see plpdf_const package for predefined
pageformats
Return : -

getVersion

Type: Function
Description : Gets the version number of pl/pldf package.
Version: v3.0.0
Parameters : -
Return : varchar2 : number of current version

setRotatePages

Type: Procedure
Description : Sets the degree of rotation for all pages. The value must be a
multiple of 90.
Version: v3.0.0
Parameters :
- p_angle number default 0 : Angle/degree of rotation
Return : -

sendDoc

Type: Procedure
Description : Returns the generated PDF document. The document is closed and
then returned in the OUT parameter.
Version: v4.8.3
Parameters :
- p_blob out nocopy blob : the generated document
- p_freetemp boolean default true : frees the temporary BLOB variable of the
PDF file in your default temporary tablespace
Return : -

setAllMargin

Type: Procedure
Description : Sets the margin size.
Version: v3.0.0
Parameters :
- p_left number : Left margin size
- p_top number : Top margin size
- p_right number default null : Right margin size. If null then the right
margin will be the same as the left margin

8
www.plpdf.com [email protected]
 PL/PDF
Return : -

setAutoNewPage

Type: Procedure
Description : Enables or disables automatic page breaks. The p_margin parameter
is
only relevant when enabling automatic page breaks. It sets the bottom
margin size under which an automatic page break is triggered.
Version: v3.0.0
Parameters :
- p_auto boolean default true : Automatic page break
o true: Enable
o false: Disable
- p_margin number default 0 : Bottom margin size, if not set, then 1 cm
Return : -

setNOCompress

Type: Procedure
Description : Disables the compression of PDF documents. By default compression
is enabled.
Version: v3.0.0
Return : -

setDocAuthor

Type: Procedure
Description : Sets the document author.
Version: v3.0.0
Parameters :
- p_author varchar2 : Document author
Return : -

setDocCreator

Type: Procedure
Description : Sets the document creator.
Version: v3.0.0
Parameters :
- p_creator varchar2 : Document creator
Return : -

setDocDisplayMode

Type: Procedure
Description : Sets how to display the document in a PDF viewer (e.g. Acrobat
Reader).
Version: v3.0.0
Parameters :
- p_zoom varchar2 : Layout view

9
www.plpdf.com [email protected]
 PL/PDF
o fullpage: fits as full page
o fullwidth: fits as full width
o real: fits in actual size
o default: displays according to the setting of the PDF viewer
- p_layout varchar2 default 'continuous' : Page layout
o single: displays single pages
o continuous: displays pages continuously
o default: displays according to the setting of the PDF viewer
- p_hidemenubar boolean default false : A flag specifying whether to hide the
viewer application's menu bar when the document is active.
- p_hidetoolbar boolean default false : A flag specifying whether to hide the
viewer application's tool bars when the document is active.
- p_hidewindowui boolean default false : A flag specifying whether to
hideuser interface elements in the document's window (such as scroll
bars and navigation controls), leaving only the document's contents
displayed.
- p_displaydoctitle boolean default false : A flag specifying whether
the window's title bar should display the document title taken from the
Title entry of the document information dictionary.
- p_centerwindow boolean default false : A flag specifying whether to position
the document's window in the center of the screen.
- p_fitwindow boolean default false : A flag specifying whether to resize the
document's window to fit the size of the first displayed page.
Return : -

setDocKeywords

Type: Procedure
Description : Sets the document keywords.
Version: v3.0.0
Parameters :
- p_keywords varchar2 : Keyword list
Return : -

setDocSubject

Type: Procedure
Description : Sets the document subject.
Version: v3.0.0
Parameters :
- p_subject varchar2 : Document subject
Return : -

SetDocTitle

Type: Procedure
Description : Sets the document title.
Version: v3.0.0
Parameters :
- p_title varchar2 : Document title
Return : -

10
www.plpdf.com [email protected]
 PL/PDF
setEncoding

Type: Procedure
Description : Sets Adobe Core character encoding (default code is cp1252).
Version: v3.0.0
Parameters :
- p_enc varchar2 : Character encoding code
o cp1250
o cp1251
o cp1252: this is the default, no need to set
o cp1253
o cp1254
o cp1255
o cp1256
o cp1257
o cp1258
o cp874
o iso-8859-1
o iso-8859-2
o iso-8859-4
o iso-8859-5
o iso-8859-7
o iso-8859-9
o iso-8859-15
o iso-8859-16
o utf16: AL32UTF8 database with unicode TTF embending
Return : -

setHeaderProcName

Type: Procedure
Description : Sets the page header procedure name. The program name passed
as a parameter executes when the page header is created. If
SetHeaderProcName is not executed before a page header is created then
the page header will be empty.
Version: v3.0.0
Parameters :
- p_proc_name varchar2 : Page header procedure name
- p_height number : height of header section
Return : -

setHeaderProcName5

Type: Procedure
Description : Sets the page header procedure name with 5 parameters. The
program name passed
as a parameter executes when the page header is created. If
SetHeaderProcName is not executed before a page header is created then
the page header will be empty.
Version: v3.0.0
Parameters :

11
www.plpdf.com [email protected]
 PL/PDF
- p_proc_name varchar2 : Page header procedure name
- p_height number : height of header section
- p_1 varchar2 default null : parameter of header procedure
- p_2 varchar2 default null : parameter of header procedure
- p_3 varchar2 default null : parameter of header procedure
- p_4 varchar2 default null : parameter of header procedure
- p_5 varchar2 default null : parameter of header procedure
Return : -

set3HeaderProcName

Type: Procedure
Description : Sets the page header procedure names. The program name passed as
a parameter executes when the page header is created.
Version: v3.0.1
Parameters :
- p_default_proc_name varchar2 default null : Specifies that this header shall
appear on every page in this section which is not overridden with a
specific even or first page header.
- p_first_proc_name varchar2 default null : Specifies that this header shall
appear on the first page in this document.
- p_even_proc_name varchar2 default null : Specifies that this header shall
appear on all even numbered pages in this document.
- p_height number : height of header section
Return : -

setFooterProcName

Type: Procedure
Description : Sets the page footer procedure name. The program name passed as a
parameter
executes when the page footer is created. If SetFooterProcName is not
executed
before a page footer is created then the page footer will be empty.
Version: v3.0.0
Parameters :
- p_proc_name varchar2 : Page header procedure name
- p_height number : height of header section
Return : -

setFooterProcName5

Type: Procedure
Description : Sets the page footer procedure name with 5 parameters. The
program name passed as a parameter
executes when the page footer is created. If SetFooterProcName is not
executed
before a page footer is created then the page footer will be empty.
Version: v3.0.0
Parameters :
- p_proc_name varchar2 : Page header procedure name

12
www.plpdf.com [email protected]
 PL/PDF
- p_height number : height of header section
- p_1 varchar2 default null : parameter of footer procedure
- p_2 varchar2 default null : parameter of footer procedure
- p_3 varchar2 default null : parameter of footer procedure
- p_4 varchar2 default null : parameter of footer procedure
- p_5 varchar2 default null : parameter of footer procedure
Return : -

set3FooterProcName

Type: Procedure
Description : Sets the page footer procedure names. The program name passed as
a parameter executes when the page footer is created.
Version: v3.0.1
Parameters :
- p_default_proc_name varchar2 default null : Specifies that this footer shall
appear on every page in this section which is not overridden with a
specific even or first page footer.
- p_first_proc_name varchar2 default null : Specifies that this footer shall
appear on the first page in this document.
- p_even_proc_name varchar2 default null : Specifies that this footer shall
appear on all even numbered pages in this document.
- p_height number : height of header section
Return : -

setBackgroundColor

Type: Procedure
Description : Sets the background color of the pages
Version: v3.0.0
Parameters :
- p_color plpdf_type.t_color : The color of the background
Return : -

SetWatermarkProcName

Type: Procedure
Description : Sets the name of the watermark creator procedure
Version: v3.0.0
Parameters :
- p_proc_name varchar2 : The name of the procedure
Return : -

SetStampProcName

Type: Procedure
Description : Sets the name of the stamp creator procedure
Version: v3.0.0
Parameters :
- p_proc_name varchar2 : The name of the procedure
Return : -

13
www.plpdf.com [email protected]
 PL/PDF
setNewPageProcName

Type: Procedure
Description : Sets the new page procedure name. The program name passed
as a parameter executes when the page is started.
Version: v4.4.0
Parameters :
- p_proc_name varchar2 : New Page procedure name
- p_height number : height of this section
Return : -

setLeftMargin

Type: Procedure
Description : Sets the left margin size.
Version: v3.0.0
Parameters :
- p_margin number : Margin size
Return : -

setTopMargin

Type: Procedure
Description : Sets the top margin size.
Version: v3.0.0
Parameters :
- p_margin number : Margin size
Return : -

setRightMargin

Type: Procedure
Description : Sets the right margin size.
Version: v3.0.0
Parameters :
- p_margin number : Margin size
Return : -

setBottomMargin

Type: Procedure
Description : Sets the bottom margin size with autonewpage.
Version: v3.6.0
Parameters :
- p_margin number : Margin size
Return : -

setNOLastpageProcName

Type: Procedure
Description : Sets the not last page procedure name. The program name passed as

14
www.plpdf.com [email protected]
 PL/PDF
a parameter
executes when the not last page closed.
Version: v3.0.0
Parameters :
- p_proc_name varchar2 : Procedure name
Return : -

SetPageNoStart

Type: Procedure
Description : Sets start of page numbering to the current page.
Version: v3.2.0
Parameters :
- p_start_num pls_integer default null : The start of the numbering, null
means 1
Return : -

SetPageNoEnd

Type: Procedure
Description : Sets end of page numbering to the current page, see SetPageNoStar
t.
Version: v3.0.0
Parameters : -
Return : -

getPageNoAlter

Type: Function
Description : Gets page altering flag, see SetPageNoStart .
Version: v3.0.0
Parameters : -
Return : boolean : Altered or not

SetProtection

Type: Procedure
Description : Allows to protect the PDF document.
Version: v3.0.0
Parameters :
- p_print_perm Boolean default false : print the PDF
- p_modify_perm Boolean default false : modify the PDF
- p_annot_forms_perm Boolean default false : add annotations and forms
- p_user_pass varchar2 default null : user password
- p_owner_pass varchar2 default null : owner password
Return : -

setPDFA1B

Type: Procedure
Description : Set PDF/A-1B support.

15
www.plpdf.com [email protected]
 PL/PDF
Version: v3.0.0
Parameters : -
Return : -

setID

Type: Procedure
Description : Sets the internal identifier of the PDF file. ID format is a 32
characters length hex string,
possible generator is the "rawtohex(SYS_GUID())" expression.
Version: v3.0.0
Parameters :
- p_id varchar2 : ID value
Return : -

16
www.plpdf.com [email protected]
 PL/PDF
Navigations and formatting commands

checkPageBreak

Type: Function
Description : If the height would cause an overflow, add a new page
immediately, and return true.
Version: v3.0.0
Parameters :
- p_h number : height for check page overflow
- p_newpage boolean default true : do NewPage procedure
Return : boolean
o true: overflow is reached
o false: don't reach overflow

getCurrPageNum

Type: Function
Description : Returns the page number of the current page.
Version: v3.0.0
Parameters : -
Return : pls_integer : Page number of the current page

getNumOfPages

Type: Function
Description : Returns the number of pages, this procedure works in header and
footer procedures only.
Version: v3.0.0
Parameters : -
Return : pls_integer : Number of pages

getLeftMargin

Type: Function
Description : Gets the page left margin size.
Version: v3.0.0
Parameters : -
Return : number : Size of left margin

getRightMargin

Type: Function
Description : Gets the page right margin size.
Version: v3.0.0
Parameters : -
Return : number : Size of right margin

getTopMargin

17
www.plpdf.com [email protected]
 PL/PDF
Type: Function
Description : Gets the page top margin size.
Version: v3.0.0
Parameters : -
Return : number : Size of top margin

getBottomMargin

Type: Function
Description : Gets the page bottom margin size.
Version: v3.0.0
Parameters : -
Return : number : Size of bottom margin

getHeaderHeight

Type: Function
Description : Gets the page header size.
Version: v3.0.0
Parameters : -
Return : number : Size of header

getFooterHeight

Type: Function
Description : Gets the page footer size.
Version: v3.0.0
Parameters : -
Return : number : Size of footer

getCurrentX

Type: Function
Description : Gets the X coordinate of the cursor.
Version: v3.0.0
Parameters : -
Return : number : X coordinate

getCurrentY

Type: Function
Description : Gets the Y coordinate of the cursor.
Version: v3.0.0
Parameters : -
Return : number : Y coordinate

getPageAvailableHeight

Type: Function
Description : Gets the available height (without margins) of actual page.
Version: v3.0.0

18
www.plpdf.com [email protected]
 PL/PDF
Parameters : -
Return : number : Available height

getPageAvailableWidth

Type: Function
Description : Gets the available width (without margins) of actual page.
Version: v3.0.0
Parameters : -
Return : number : Available width

getPageHeight

Type: Function
Description : Gets the height of actual page.
Version: v3.0.0
Parameters : -
Return : number : The height of the page

getPageRightSpace

Type: Function
Description : Gets the available width (without margins) of actual page from
current position.
Version: v3.0.0
Parameters : -
Return : number : Actual page available space

getPageLeftSpace

Type: Function
Description : Gets the available width (without margins) of actual page from
current position.
Version: v3.0.0
Parameters : -
Return : number : Actual page available space

getPageSpace

Type: Function
Description : Gets the available width (without margins) of actual page from
current position.
Version: v3.0.0
Parameters : -
Return : number : Actual page available space

getPageWidth

Type: Function
Description : Gets the width of actual page.
Version: v3.0.0

19
www.plpdf.com [email protected]
 PL/PDF
Parameters : -
Return : number : Actual page width

getPageBottomSpace

Type: Function
Description : Gets the available height (without margins) of actual page from
current position.
Version: v3.0.0
Parameters : -
Return : number : Actual page bottom space

getPrintFontKey

Type: Function
Description : Get the current font name and style. See SetPrintFont .
Version: v3.0.0
Parameters : -
Return : varchar2 : Font type

getPrintFontName

Type: Function
Description : Get the current font type. See SetPrintFont .
Version: v3.0.0
Parameters : -
Return : varchar2 : Font type

getPrintFontStyle

Type: Function
Description : Get the current font style. See SetPrintFont
Version: v3.0.0
Parameters : -
Return : varchar2 : Font style

getPrintFontSize

Type: Function
Description : Get the current font size. See SetPrintFont
Version: v3.0.0
Parameters : -
Return : varchar2 : Font size

getScaleFactor

Type: Function
Description : Get the current scale factor.
Version: v3.0.0
Parameters : -
Return : number : scale factor

20
www.plpdf.com [email protected]
 PL/PDF
getTextWidth

Type: Function
Description : Returns the width of the parameter text (uses current font).
Version: v3.0.0
Parameters :
- p_s varchar2 : Text
Return : number : The width of the text in the unit of measure specified in Init

getTextwidthFont

Type: Function
Description : Returns the width of the parameter text, font is a parameter too.
Version: v3.0.0
Parameters :
- p_family varchar2 default null : Font type, null means current font family
o Helvetica (Arial, Sans Serif)
o Courier
o Times (Serif)
o Symbol
o ZapfDingBats
o If TTF fonts were added using the AddTTF procedure then they may be used
here as well.
- p_style varchar2 default null : Font style
o null: Regular
o B: Bold
o I: Italic
o U: Underline
o The styles may be combined (i.e. BI will be Bold and Italic)
- p_size number default null : Font size, null means current font size
- p_s varchar2 : Text
Return : number : The width of the text in the unit of measure specified in Init

removeMissingChars

Type: Function
Description : Remove unknown characters from text (uses current font).
Version: v3.0.0
Parameters :
- p_s varchar2 : Text
Return : varchar2 : The text without missing characters

insertMovePage

Type: Procedure
Description : Insert a new page and move it by changing order of pages.
Version: v3.0.0
Parameters :
- p_orig_pos number : origin page position
- p_new_pos number : new page position
Return : -

21
www.plpdf.com [email protected]
 PL/PDF
NewPage

Type: Procedure
Description : Creates a new page. If no orientation is given then the
orientation specified in Init
will be used. If a page was previously open, a page break is initiated and
the
cursor is placed at the top left corner of the new page.
Version: v3.0.0
Parameters :
- p_orientation varchar2 default NULL : Page orientation
o P: Portrait
o L: Landscape
Return : -

SetNoPrintFooter

Type: Procedure
Description : Disables the footer on the specified page.
Version: v3.0.0
Parameters :
- p_page pls_integer default null : Page number
Return : -

setNoPrintHeader

Type: Procedure
Description : Disables the header on the specified page.
Version: v4.9.6
Parameters :
- p_page pls_integer default null : Page number
Return : -

setCurrentX

Type: Procedure
Description : Places the cursor at the X coordinate.
Version: v3.0.0
Parameters :
- p_x number default 0 : X coordinate
Return : -

setCurrentY

Type: Procedure
Description : Places the cursor at the Y coordinate and reset X.
Version: v3.0.0
Parameters :
- p_y number default 0 : Y coordinate
- p_cr boolean default true : X position returns to beginning of line
Return : -

22
www.plpdf.com [email protected]
 PL/PDF
setCurrentXY

Type: Procedure
Description : Places the cursor at the X and Y coordinate.
Version: v3.0.0
Parameters :
- p_x number default 0 : X coordinate
- p_y number default 0 : Y coordinate
Return : -

NewLine

Type: Procedure
Description : Line break. Cursor is placed at the start of the next line.
Version: v3.0.0
Parameters :
- p_h number default 0 : Height of the line break.
Return : -

23
www.plpdf.com [email protected]
 PL/PDF
Content Related Commands

AttachFile

Type: Procedure
Description : Attachs a file to the PDF document.
Version: v3.0.0
Parameters :
- p_filename varchar2 : name of file
- p_fileblob blob : file
- p_desc varchar2 default null : description of file
Return : -

crBookmark

Type: Procedure
Description : Create a bookmark in the PDF document. Bookmarks are displayed in
the PDF viewer program (e.g. Acrobat Reader).
Version: v3.0.0
Parameters :
- p_txt varchar2 : Text of the bookmark
- p_level number default 0 : Bookmark level, 0 is the highest level
- p_y number default null : Y coordinate of the bookmark within the current
page. Null denotes the cursor position.
Return : -

PrintoutText

Type: Procedure
Description : Prints a text starting from the specified position.
Version: v3.0.0
Parameters :
- p_x number : X coordinate for the start of the text
- p_y number default null : Y coordinate for the start of the text
- p_txt varchar2 : Text
Return : -

Circle

Type: Procedure
Description : Draws a cirle on the current page.
Version: v3.0.1
Parameters :
- p_x number : X coordinate of the center of the circle
- p_y number : Y coordinate of the center of the circle
- p_r number : the radius of the circle
- p_draw boolean default true : frame drawing
- p_fill boolean default false : filling
- p_draw_color plpdf_type.t_color default null : frame drawing color

24
www.plpdf.com [email protected]
 PL/PDF
- p_fill_color plpdf_type.t_color default null : filling color
- p_linewidth number default null : The width of the frame line of the
rectangle
- p_fill_pattern varchar2 default null : The filling pattern
Return : -

Ellipse

Type: Procedure
Description : Draws an ellipse on the current page.
Version: v3.0.1
Parameters :
- p_x number : X coordinate of the center of the ellipse
- p_y number : Y coordinate of the center of the ellipse
- p_rx number : horizontal radius of the ellipse
- p_ry number : vertical radius of the ellipse
- p_draw boolean default true : frame drawing
- p_fill boolean default false : filling
- p_draw_color plpdf_type.t_color default null : frame drawing color
- p_fill_color plpdf_type.t_color default null : filling color
- p_linewidth number default null : The width of the frame line of the
rectangle
- p_fill_pattern varchar2 default null : The filling pattern
Return : -

Line

Type: Procedure
Description : Draws a line between the two positions on the page.
Version: v3.0.0
Parameters :
- p_x1 number : X coordinate for the start of the line
- p_y1 number : Y coordinate for the start of the line
- p_x2 number : X coordinate for the end of the line
- p_y2 number : Y coordinate for the end of the line
- p_color plpdf_type.t_color default null : color of the line
- p_width number default null : width of the line
Return : -

Polygon

Type: Procedure
Description : Draws a lines (polygon) between the points on the page.
Version: v3.0.1
Parameters :
- p_points plpdf_type.t_points : set of ordered points
- p_draw boolean default true : frame drawing
- p_fill boolean default false : filling
- p_draw_color plpdf_type.t_color default null : frame drawing color
- p_fill_color plpdf_type.t_color default null : filling color
- p_linewidth number default null : The width of the frame line of the

25
www.plpdf.com [email protected]
 PL/PDF
rectangle
- p_fill_pattern varchar2 default null : The filling pattern
Return : -

Path

Type: Procedure
Description : Draws a lines between the points on the page.
Version: v3.6.0
Parameters :
- p_operators plpdf_type.t_path_operators : set of ordered operators defined
in the PDF Reference. Supported Operators: m,l,c,v,y,h,re
- p_draw boolean default true : frame drawing
- p_fill boolean default false : filling
- p_draw_color plpdf_type.t_color default null : frame drawing color
- p_fill_color plpdf_type.t_color default null : filling color
- p_linewidth number default null : The width of the frame line of the
rectangle
- p_fill_pattern varchar2 default null : The filling pattern
Return : -

Rect

Type: Procedure
Description : Draws a rectangle on the page.
Version: v3.0.0
Parameters :
- p_x number : X coordinate for the top left corner of the rectangle
- p_y number : Y coordinate for the top left corner of the rectangle
- p_w number : The width of the rectangle
- p_h number : The height of the rectangle
- p_draw boolean default true : frame drawing
- p_fill boolean default false : filling
- p_draw_color plpdf_type.t_color default null : frame drawing color
- p_fill_color plpdf_type.t_color default null : filling color
- p_linewidth number default null : The width of the frame line of the
rectangle
- p_fill_pattern varchar2 default null : The filling pattern
Return : -

RoundedRect

Type: Procedure
Description : Draws a rectangle on the page.
Version: v3.0.1
Parameters :
- p_x number : X coordinate for the top left corner of the rectangle
- p_y number : Y coordinate for the top left corner of the rectangle
- p_w number : The width of the rectangle
- p_h number : The height of the rectangle
- p_r number : The radius of the corners

26
www.plpdf.com [email protected]
 PL/PDF
-
p_draw boolean default true : frame drawing
-
p_fill boolean default false : filling
-
p_draw_color plpdf_type.t_color default null : frame drawing color
-
p_fill_color plpdf_type.t_color default null : filling color
-
p_linewidth number default null : The width of the frame line of the
rectangle
- p_fill_pattern varchar2 default null : The filling pattern
Return : -

Sector

Type: Procedure
Description : Draws a sector on the current page.
Version: v3.0.1
Parameters :
- p_xc number : X coordinate of the center of the sector
- p_yc number : Y coordinate of the center of the sector
- p_r number : Radius of the sector
- p_a number : Starting point of the sector
- p_b number : End point of the sector
- p_draw boolean default true : frame drawing
- p_fill boolean default false : filling
- p_draw_color plpdf_type.t_color default null : frame drawing color
- p_fill_color plpdf_type.t_color default null : filling color
- p_linewidth number default null : The width of the frame line of the
rectangle
- p_fill_pattern varchar2 default null : The filling pattern
- p_cw boolean default true : Draw direction
o true: Clockwise
o false: Anti-clockwise
- p_o number default 90 : origin of angles
Return : -

EndOpacity

Type: Procedure
Description : End a transparency. See StartOpacity
Version: v3.0.0
Parameters : -
Return : -

EndOptCont

Type: Procedure
Description : End an optional content. See link StartOptCont
Version: v3.0.0
Parameters : -
Return : -

putImage

27
www.plpdf.com [email protected]
 PL/PDF
Type: Procedure
Description : Inserts an image (JPG, BMP, PNG, etc.) from a BLOB variable into
the current page.
Version: v3.0.1
Parameters :
- p_name varchar2 : Image name or ID, if the name is equal with an earlier
used image name then procedure reuses the original blob
- p_data blob : Variable containing the image as binary data
- p_x number : X coordinate of the image
- p_y number : Y coordinate of the image
- p_w number default null : Image width, if null then the image is displayed
in its actual width
- p_h number default null : Image height, if null then the image is displayed
in its actual height
- p_link varchar2 default NULL : URL or internal link ID
Return : -

putImage

Type: Procedure
Description : Inserts an image (JPG, BMP, PNG, etc.) from a BLOB variable into
the current page.
Version: v3.0.1
Parameters :
- p_name varchar2 : The name is an earlier used image name and procedure reuse
this image blob.
- p_x number : X coordinate of the image
- p_y number : Y coordinate of the image
- p_w number default null : Image width, if null then the image is displayed
in its actual width
- p_h number default null : Image height, if null then the image is displayed
in its actual height
- p_link varchar2 default NULL : URL or internal link ID
Return : -

putImage

Type: Procedure
Description : Inserts an image (JPG, BMP, PNG, etc.) from a BLOB variable into
the current page.
Version: v3.0.1
Parameters :
- p_data blob : Variable containing the image as binary data
- p_x number : X coordinate of the image
- p_y number : Y coordinate of the image
- p_w number default null : Image width, if null then the image is displayed
in its actual width
- p_h number default null : Image height, if null then the image is displayed
in its actual height
- p_link varchar2 default NULL : URL or internal link ID
Return : -

28
www.plpdf.com [email protected]
 PL/PDF
putInternalLink

Type: Procedure
Description : Puts a link area on the page that point to an internal link.
Version: v3.0.0
Parameters :
- p_x number : X coordinate of the top left corner of the area
- p_y number : Y coordinate of the top left corner of the area
- p_w number : Link area width
- p_h number : Link area height
- p_link pls_integer : Internal link ID returned by crInternalLinkDest
Return : -

putExternalLink

Type: Procedure
Description : Puts a link area on the page that point to an external link.
Version: v3.0.0
Parameters :
- p_x number : X coordinate of the top left corner of the area
- p_y number : Y coordinate of the top left corner of the area
- p_w number : Link area width
- p_h number : Link area height
- p_link varchar2 : External link
Return : -

putLink

Type: Procedure
Description : Puts a link area on the page that point to an external link. If
p_link is a number then internal if string then external link.
Version: v3.0.0
Parameters :
- p_x number : X coordinate of the top left corner of the area
- p_y number : Y coordinate of the top left corner of the area
- p_w number : Link area width
- p_h number : Link area height
- p_link varchar2 : Identification of the link
Return : -

setStrokingColor

Type: Procedure
Description : Sets the color for stroking operation. Colors must be specified
according to the RGB pallet.
Version: v3.0.0
Parameters :
- p_color plpdf_type.t_color : color
Return : -

setNonStrokingColor

29
www.plpdf.com [email protected]
 PL/PDF
Type: Procedure
Description : Sets the color for non stroking operation. Colors must be
specified according to the RGB pallet.
Version: v3.0.0
Parameters :
- p_color plpdf_type.t_color : color
Return : -

addJavaScript

Type: Procedure
Description : Add JavaScript inside the PDF. See Acrobat JavaScript Reference.
Version: v3.0.0
Parameters :
- p_name varchar2 : Name of the script
- p_text varchar2 : The script
Return : -

LineWidth

Type: Procedure
Description : Sets the thickness of lines drawn after this statement.
Version: v3.0.0
Parameters :
- p_width number : Line thickness
Return : -

crInternalLink

Type: Function
Description : Creates an internal link, and returns its ID. An internal link
can be used
to take the cursor to another place within the document by clicking over it.
Version: v3.0.0
Parameters : -
Return : number : The ID of the internal link

setLinkDest

Type: Procedure
Description : Sets the destination page and position for the internal link.
Version: v3.0.0
Parameters :
- p_link number : Internal link ID returned by CrInternalLink
- p_y number default 0 : Y position on the page, if null then the current Y
coordinate, if 0 then the top of the page
- p_page number default null : Page number, if null then the current page
Return : -

crInternalLinkDest

30
www.plpdf.com [email protected]
 PL/PDF
Type: Function
Description : Create the destination page and position for the internal link.
Version: v3.0.0
Parameters :
- p_page pls_integer default null : Page number, if null then the current page
- p_y number default null : Y position on the page, if null then the current Y
coordinate, if 0 then the top of the page
Return : Internal link ID

setPrintFont

Type: Procedure
Description : Sets the font and its properties.
Version: v3.0.0
Parameters :
- p_family varchar2 default NULL : Font type
o Helvetica (Arial, Sans Serif)
o Courier
o Times (Serif)
o Symbol
o ZapfDingBats
o If TTF fonts were added using the AddTTF procedure then they may be used
here as well.
- p_style varchar2 default NULL : Font style
o null: Regular
o B: Bold
o I: Italic
o U: Underline
o The styles may be combined (i.e. BI will be Bold and Italic)
- p_size number default null : Font size, null means the current size. If no
size has been specified then value is 12.
Return : -

setPrintFontSize

Type: Procedure
Description : Sets the font size. All other font properties remain unchanged.
Version: v3.0.0
Parameters :
- p_size number : Font size
Return : -

setRotate

Type: Procedure
Description : Sets the degree of rotation. Text and images can both be rotated.
Version: v3.0.0
Parameters :
- p_angle number : Angle/degree of rotation
- p_x number default null : X coordinate of the rotation point, if null then
the X coordinate of the cursor

31
www.plpdf.com [email protected]
 PL/PDF
- p_y number default null : Y coordinate of the rotation point, if null then
the Y coordinate of the cursor
Return : -

startClipping

Type: Procedure
Description : Starts a clipping frame. The clipping limits the region that can
be paint. The clipping affects for
objects wich located between StartClipping and EndClipping.
Version: v3.0.0
Parameters :
- p_x number : X coordinate for the start of the clipping frame
- p_y number : Y coordinate for the start of the clipping frame
- p_w number : height of clipping frame
- p_h number : width of clipping frame
Return : -

EndClipping

Type: Procedure
Description : End a cliping frame. See StartClipping
Version: v3.0.0
Parameters : -
Return : -

isInClipping

Type: Function
Description : Get the state of clipping.
Version: v3.0.0
Parameters : -
Return : boolean : in clipping or not

startOpacity

Type: Procedure
Description : Starts a transparency. The transparency affects for
objects wich located between StartOpacity and EndOpacity.
Version: v3.0.0
Parameters :
- p_val number : can be a value from 0.0 - 1.0. A lower value makes the
element more transparent.
Return : -

startOptCont

Type: Procedure
Description : Start an optional content.
Version: v3.0.0
Parameters :

32
www.plpdf.com [email protected]
 PL/PDF
- p_name varchar2 : name of optional content
- p_state boolean default true : dafault state is visible or invisible
- p_ui_order boolean default true : insert into the state array
- p_print boolean default true : printed out
Return : -

33
www.plpdf.com [email protected]
 PL/PDF
Template Related Commands

InsTemplate

Type: Function
Description : Insert a template into the pdf.
Version: v3.0.0
Parameters :
- p_tpl plpdf_type.tr_tpl_data : template data
Return : pls_integer : template ID

setPageTemplate

Type: Procedure
Description : Use a template.
Version: v4.9.2
Parameters :
- p_page pls_integer default null : page, Null means current page
- p_tplidx pls_integer : template ID
- p_fittopage boolean default true : fit template to page size
- p_rotate90 boolean default false : rotate template right with 90
Return : -

setPageDefaultTemplate

Type: Procedure
Description : Set template for all new page. Remove template when p_tplidx is
null.
Version: v3.0.0
Parameters :
- p_tplidx pls_integer : template ID
- p_fittopage boolean default true : fit template to page size
Return : -

UseTemplate

Type: Procedure
Description : Use a template in the page content.
Version: v4.9.3
Parameters :
- p_tplidx pls_integer : template ID
- p_fittopage boolean default true : fit template to page size
Return : -

34
www.plpdf.com [email protected]
 PL/PDF
Digital Signature Related Commands

setDigSig

Type: Procedure
Description : Set digital signature appearances.
Version: v3.0.0
Parameters :
- p_Name varchar2 default null : The name of the person or authority signing
the document.
- p_Location varchar2 default null : The CPU host name or physical location of
the signing.
- p_Reason varchar2 default null : The reason for the signing, such as (I
agree?).
- p_ContactInfo varchar2 default null : Information provided by the signer to
allow a recipient to contact the signer to verify the signature; for
example, a phone number.
- p_access_perms : The access permissions granted for this document. Defined
values are:
o 1: No changes to the document are permitted; any change to the document
invalidates the signature.
o 2: Permitted changes are filling in forms, instantiating page templates,
and signing; other changes invalidate the signature.
o 3: Permitted changes are those allowed by 2, as well as annotation
creation, deletion, and modification; other changes invalidate the
signature.
Return : -

setNeedAppearances

Type: Procedure
Description : Set Need Appearances property for Acroform fields.
Version: v3.0.0
Parameters : -
Return : -

getCalcCurrPageNum

Type: Function
Description : Gets the calculated number of the page.
Version: v3.0.0
Parameters :
- p_page pls_integer : The page number
Return : pls_integer : page number

getCalcCurrPageNum

Type: Function
Description : Gets the calculated amount number of the pages.

35
www.plpdf.com [email protected]
 PL/PDF
Version: v3.0.0
Parameters :
- p_page pls_integer : The page number
Return : pls_integer : number of pages

36
www.plpdf.com [email protected]
 PL/PDF
PL/PDF v2 Compatible procedures and functions

LineBreak

Type: Procedure
Description : Line break. Cursor is placed at the start of the next line.
Version: v3.0.0
Parameters :
- p_h number default NULL : Height of the line break. If not set, then the
last printed cells height is the height by default.
Return : -

setLineWidth

Type: Procedure
Description : Sets the thickness of lines drawn after this statement.
Version: v3.0.0
Parameters :
- p_width number : Line thickness
Return : -

getLineWidth

Type: Function
Description : Gets the current line size.
Version: v3.0.0
Parameters : -
Return : number : Line size

DrawLine

Type: Procedure
Description : Draws a line between the two positions on the page.
Version: v3.0.0
Parameters :
- p_x1 number : X coordinate for the start of the line
- p_y1 number : Y coordinate for the start of the line
- p_x2 number : X coordinate for the end of the line
- p_y2 number : Y coordinate for the end of the line
Return : -

DrawRect

Type: Procedure
Description : Draws a rectangle on the page.
Version: v3.0.0
Parameters :
- p_x number : X coordinate for the top left corner of the rectangle
- p_y number : Y coordinate for the top left corner of the rectangle

37
www.plpdf.com [email protected]
 PL/PDF
- p_w number : The width of the rectangle
- p_h number : The height of the rectangle
- p_style varchar2 default NULL : Style
o D: No fill, border line
o F: Fill, no border line
o DF or FD: Fill and border line
Return : -

drawRoundedRect

Type: Procedure
Description : Draws a rectangle on the page.
Version: v3.0.0
Parameters :
- p_x number : X coordinate for the top left corner of the rectangle
- p_y number : Y coordinate for the top left corner of the rectangle
- p_w number : The width of the rectangle
- p_h number : The height of the rectangle
- p_r number : The radius of the corners
- p_style varchar2 default NULL : Style
o D: No fill, border line
o F: Fill, no border line
o DF or FD: Fill and border line
Return : -

DrawEllipse

Type: Procedure
Description : Draws an ellipse on the current page.
Version: v3.0.0
Parameters :
- p_x number : X coordinate of the center of the ellipse
- p_y number : Y coordinate of the center of the ellipse
- p_rx number : horizontal radius of the ellipse
- p_ry number : vertical radius of the ellipse
- p_style varchar2 default 'D' : Style
o D: No fill, border line
o F: Fill, no border line
o DF or FD: Fill and border line
Return : -

DrawCircle

Type: Procedure
Description : Draws a cirle on the current page.
Version: v3.0.0
Parameters :
- p_x number : X coordinate of the center of the circle
- p_y number : Y coordinate of the center of the circle
- p_r number : the radius of the circle
- p_style varchar2 default NULL : Style

38
www.plpdf.com [email protected]
 PL/PDF
o D: No fill, border line
o F: Fill, no border line
o DF or FD: Fill and border line
Return : -

drawSector

Type: Procedure
Description : Draws a sector on the current page.
Version: v3.0.0
Parameters :
- p_xc number : X coordinate of the center of the sector
- p_yc number : Y coordinate of the center of the sector
- p_r number : Radius of the sector
- p_a number : Starting point of the sector
- p_b number : End point of the sector
- p_style varchar2 default 'FD' : Style
o D: No fill, border line
o F: Fill, no border line
o DF vagy FD: Fill and border line
- p_cw boolean default true : Draw direction
o true: Clockwise
o false: Anti-clockwise
- p_o number default 90 : origin of angles
Return : -

DrawPolygon

Type: Procedure
Description : Draws a lines (polygon) between the points on the page.
Version: v3.0.0
Parameters :
- p_points plpdf_type.t_points : set of ordered points
- p_style varchar2 default 'D' : Style
o D: No fill, border line
o F: Fill, no border line
o DF or FD: Fill and border line
Return : -

PrintText

Type: Procedure
Description : Prints a text starting from the specified position.
Version: v3.0.0
Parameters :
- p_x number : X coordinate for the start of the text
- p_y number : Y coordinate for the start of the text
- p_txt varchar2 : Text
Return : -

setCellMargin

39
www.plpdf.com [email protected]
 PL/PDF
Type: Procedure
Description : Sets the cell margin size.
Version: v3.0.0
Parameters :
- p_margin number : Margin size
Return : -

getCellMargin

Type: Function
Description : Gets the cell margin size.
Version: v3.0.0
Parameters : -
Return : number : Margin size

setCellBottomMargin

Type: Procedure
Description : Sets the cell bottom margin size.
Version: v3.0.0
Parameters :
- p_margin number : Margin size
Return : -

setCellLeftMargin

Type: Procedure
Description : Sets the cell left margin size.
Version: v3.0.0
Parameters :
- p_margin number : Margin size
Return : -

setCellRightMargin

Type: Procedure
Description : Sets the cell right margin size.
Version: v3.0.0
Parameters :
- p_margin number : Margin size
Return : -

setCellTopMargin

Type: Procedure
Description : Sets the cell top margin size.
Version: v3.0.0
Parameters :
- p_margin number : Margin size
Return : -

40
www.plpdf.com [email protected]
 PL/PDF
getCellBottomMargin

Type: Function
Description : Gets the cell bottom margin size.
Version: v3.0.0
Parameters : -
Return : number : Size of bottom margin

getCellLeftMargin

Type: Function
Description : Gets the cell left margin size.
Version: v3.0.0
Parameters : -
Return : number : Size of left margin

getCellRightMargin

Type: Function
Description : Gets the cell right margin size.
Version: v3.0.0
Parameters : -
Return : number : Size of right margin

getCellTopMargin

Type: Function
Description : Gets the cell top margin size.
Version: v3.0.0
Parameters : -
Return : number : Size of top margin

getTextHeight

Type: Function
Description : Gets the height of the actual font.
Version: v3.4.0
Parameters : -
Return : number : The size of the actual font

getCellMinHeight

Type: Function
Description : Gets the minimum cell height (uses current font).
Version: v3.0.0
Parameters : -
Return : number

getCellMinHeightFont

Type: Function

41
www.plpdf.com [email protected]
 PL/PDF
Description : Gets the minimum cell height, font is parameter.
Version: v3.0.0
Parameters :
- p_family varchar2 default null : Font type, null means current font family
o Helvetica (Arial, Sans Serif)
o Courier
o Times (Serif)
o Symbol
o ZapfDingBats
o If TTF fonts were added using the AddTTF procedure then they may be used
here as well.
- p_style varchar2 default null : Font style
o null: Regular
o B: Bold
o I: Italic
o U: Underline
o The styles may be combined (i.e. BI will be Bold and Italic)
- p_size number default null : Font size, null means current font size
Return : number

getCellMinWidth

Type: Function
Description : Gets the minimum cell width (uses current font).
Version: v3.0.0
Parameters :
- p_txt varchar2 : Text for calculating width
Return : number

getCellMinWidthFont

Type: Function
Description : Gets the minimum cell width, font is parameter.
Version: v3.0.0
Parameters :
- p_family varchar2 default null : Font type, null means current font family
o Helvetica (Arial, Sans Serif)
o Courier
o Times (Serif)
o Symbol
o ZapfDingBats
o If TTF fonts were added using the AddTTF procedure then they may be used
here as well.
- p_style varchar2 default null : Font style
o null: Regular
o B: Bold
o I: Italic
o U: Underline
o The styles may be combined (i.e. BI will be Bold and Italic)
- p_size number default null : Font size, null means current font size
- p_txt varchar2 : Text for calculating width

42
www.plpdf.com [email protected]
 PL/PDF
Return : number

PrintCell

Type: Procedure
Description : Draws a rectangle cell with text inside. The rectangle may have a
border and fill color specified.
Version: v4.8.0
Parameters :
- p_w number default 0 : Rectangle width
o 0: the rectangle will extend till the right margin
o null: uses minimum cell width
- p_h number default 0 : Rectangle height
o null: uses minimum cell height
o -1: uses minimum cell height
o 0: uses last cell height
- p_txt varchar2 default NULL : Text
- p_border varchar2 default '0' : Rectangle border
o 0: no border
o 1: outline border
o L: left side border
o T: top side border
o R: right side border
o B: bottom side border
o or a combination of L, T, R and B
- p_ln number default plpdf_const.beside : Cursor position after the cell is
printed
o 0: Beside the cell
o 1: New line
o 2: Under the cell
- p_align varchar2 default NULL : Text alignment
o L: left
o R: right
o C:
o J: Force Justification
- p_fill boolean default false : Fill with current fill color
o false: no fill
o true: fill with current fill color
- p_link varchar2 default null : Link related to the text, can be a URL or an
internal link ID
- p_clipping boolean default true : Clipping the cell
o false: no clipping
o true: clipping
- p_vert_align varchar2 default null : Text vertical alignment in cell
o null: normal
o T: top
o B: bottom
Return : -

PrintMultiLineCell

43
www.plpdf.com [email protected]
 PL/PDF
Type: Procedure
Description : Draws a multi line cell.
Version: v3.0.0
Parameters :
- p_w number default 0 : Rectangle width, if 0 then the rectangle will extend
till the right margin
- p_h number default 0 : Rectangle height
o null: uses minimum cell height
o -1: uses minimum cell height
o 0: uses last cell height
- p_txt varchar2 default null : Text
- p_border varchar2 default '0' : Rectangle border
o 0: no border
o 1: outline border
o L: left side border
o T: top side border
o R: right side border
o B: bottom side border
o Or a combination of L, T, R and B
- p_align varchar2 default 'J' : Text alignment
o L: left
o R: right
o C: center
o J: force justification
- p_fill boolean default false : Fill with current fill color
o false: no fill
o true: fill with current fill color
- p_maxline number default 0 : Maximum number of lines displayed. If 0 then
all lines will be displayed.
- p_link varchar2 default NULL : Link related to the text, can be a URL or an
internal link ID
- p_clipping boolean default true : Clipping cell
o false: no clipping
o true: clipping
- p_indent number default 0 : First line Indent
- p_ln number default plpdf_const.newline : Cursor position after the cell is
printed
o 0: Beside the cell
o 1: New line
o 2: Under the cell
Return : -

PrintFlowingText

Type: Procedure
Description : Prints text continuously. Text is wrapped according to the right
margin.
Version: v3.0.0
Parameters :
- p_h number default 0 : Rectangle height
o null: uses minimum cell height

44
www.plpdf.com [email protected]
 PL/PDF
o -1: uses minimum cell height
o 0: uses last cell height
- p_txt varchar2 default null : Text
- p_link varchar2 default null : URL or internal link ID
- p_align varchar2 default NULL : Text alignment
o L: left
o R: right
o C:
o J: Force Justification
- p_clipping boolean default true : Clipping text
o false: no clipping
o false: clipping
- p_lastline_j varchar2 default 'L' : justified text last line alignment
o L: left
o R: right
o C: center
o J: Force Justification
Return : -

PrintFlowingTextLimit

Type: Procedure
Description : Prints text continuously. Text is wrapped according to the
p_min_x and p_max_x.
Version: v3.0.0
Parameters :
- p_h number default 0 : Rectangle height
o null: uses minimum cell height
o -1: uses minimum cell height
o 0: uses last cell height
- p_txt varchar2 default null : Text
- p_link varchar2 default null : URL or internal link ID
- p_min_x number default 0 : min X position, 0 means the limit is the left
margin
- p_max_x number default 0 : max X position, 0 means the limit is the right
margin
- p_align varchar2 default NULL : Text alignment
o L: left
o R: right
o C:
o J: Force Justification
- p_clipping boolean default true : Clipping text
o false: no clipping
o true: clipping
- p_lastline_j varchar2 default 'L' : justified text last line alignment
o L: left
o R: right
o C:
o J: Force Justification
Return : -

46
www.plpdf.com [email protected]
 PL/PDF
PrintImageCell

Type: Procedure
Description : Print an image with frame.
Version: v3.0.0
Parameters :
- p_w number : Width of frame
- p_h number : Height of frame
- p_name varchar2 : name of image
- p_data blob : image
- p_margin number default 0 : margin size of frame
- p_border varchar2 default '0' : Rectangle border
o 0: no border
o 1: outline border
o L: left side border
o T: top side border
o R: right side border
o B: bottom side border
o Or a combination of L, T, R and B
- p_ln number default plpdf_const.beside : Cursor position after the cell is
printed
o 0: Beside the cell
o 1: New line
o 2: Under the cell
- p_fill boolean default false : Fill with current fill color
o false: no fill
o true: fill with current fill color
- p_link varchar2 default NULL : URL or internal link ID
- p_type varchar2 default null : when use Oracle InterMedia then ignore this
param,when does not use Oracle InterMedia then JPG or PNG, null means JPG
Return : -

setColor4Drawing

Type: Procedure
Description : Sets the line color for objects (line, rectangle, circle etc.)
inserted after this statement.
Colors must be specified according to the RGB pallet.
Version: v3.0.0
Parameters :
- p_r number : Red component code, can be between 0 and 255
- p_g number : Green component code, can be between 0 and 255
- p_b number : Blue component code, can be between 0 and 255
Return : -

setColor4Drawing

Type: Procedure
Description : Sets the line color for objects (line, rectangle, circle etc.)
inserted after this statement.
Colors must be specified according to the RGB pallet.

47
www.plpdf.com [email protected]
 PL/PDF
Version: v3.0.0
Parameters :
- p_color plpdf_type.t_color : color
Return : -

setColor4Filling

Type: Procedure
Description : Sets the fill color for objects inserted after this statement.
Colors must be specified according to the RGB pallet.
Version: v3.0.0
Parameters :
- p_r number : Red component code, can be between 0 and 255
- p_g number : Green component code, can be between 0 and 255
- p_b number : Blue component code, can be between 0 and 255
Return : -

setColor4Filling

Type: Procedure
Description : Sets the fill color for objects inserted after this statement.
Colors must be specified according to the RGB pallet.
Version: v3.0.0
Parameters :
- p_color plpdf_type.t_color : color
Return : -

setColor4Text

Type: Procedure
Description : Sets the text color for objects inserted after this statement.
Colors must be specified according to the RGB pallet.
Version: v3.0.0
Parameters :
- p_r number : Red component code, can be between 0 and 255
- p_g number : Green component code, can be between 0 and 255
- p_b number : Blue component code, can be between 0 and 255
Return : -

setColor4Text

Type: Procedure
Description : Sets the text color for objects inserted after this statement.
Colors must be specified according to the RGB pallet.
Version: v3.0.0
Parameters :
- p_color plpdf_type.t_color : color
Return : -

getColor4Drawing

48
www.plpdf.com [email protected]
 PL/PDF
Type: Function
Description : Gets the line color for objects.
Version: v3.0.0
Parameters : -
Return : plpdf_type.t_color : Drawing color

getColor4Filling

Type: Function
Description : Gets the filling color for objects.
Version: v3.0.0
Parameters : -
Return : plpdf_type.t_color : Filling color

getColor4Text

Type: Function
Description : Gets the color of text.
Version: v3.0.0
Parameters : -
Return : plpdf_type.t_color : Color of text

49
www.plpdf.com [email protected]