best pdf library c# : Extract pdf data to excel SDK software API .net winforms azure sharepoint PDFlib-manual20-part1878

7.8  Block Filling Functions (PPS) 201
7.8 Block Filling Functions (PPS)
The PDFlib Personalization Server (PPS) offers dedicated functions for processing vari-
able data blocks of type Text, Image, and PDF. These blocks must be contained in the im-
ported PDF page, but will not be retained in the generated output. The imported page 
must have been placed on the output page before using any of the block filling func-
tions. When calculating the block position on the page, the block functions will take 
into account the scaling options provided to the most recent call to PDF_fit_pdi_page( ) 
with the respective PDF page handle.
If only block processing is desired without actually placing the contents of the page 
on the output (i.e., the imported page is only used as a container of blocks) the blind op-
tion of PDF_fit_pdi_page( ) can be used. This is useful if you want to place blocks below 
the contents of the original page. To achieve this, use PDF_fit_pdi_page( ) with the blind 
option, fill the blocks as desired, and call PDF_fit_pdi_page( ) again, this time without the 
blind option.
Note The block processing functions discussed in this section require the PDFlib Personalization 
Server (PPS). The PDFlib Block plugin for Adobe Acrobat is required for creating blocks in PDF 
templates. See Chapter 6 for more information about the PDFlib Block plugin.
int PDF_fill_textblock(PDF *p,
int page, const char *blockname, const char *text, int len, const char *optlist)
Fill a text block with variable data according to its properties.
page A valid PDF page handle for a page containing blocks.
blockname The name of the block.
text The text to be filled into the block, or an empty string if the default text is to be 
used.
len (C binding only) Length of text (in bytes) for strings which may contain null char-
acters. If len = 0 a null-terminated string must be provided.
optlist An option list (see Section 3.1.4, »Option Lists«, page 44) specifying filling de-
tails according to Table 7.30.
Returns -1 (in PHP: 0) if the named block doesn’t exist on the page, the block cannot be filled (e.g., 
due to font problems), or the block requires a newer PDFlib version for processing; 1 if 
the block could be processed successfully. Use the pdiwarning option to get more infor-
mation about the nature of the problem.
Details The supplied text will be formatted into the block, subject to the block’s properties. If 
text is empty the function will use the block’s default text if available, and silently re-
turn otherwise. This may be useful to take advantage of other block properties, such as 
fill or stroke color.
If the PDF document is found to be corrupt, this function will either throw an excep-
tion or return -1 subject to the pdiwarning parameter or option.
Scope page, template
Note This function is only available in the PDFlib Personalization Server (PPS).
Extract pdf data to excel - extract form data from PDF in C#.net, ASP.NET, MVC, Ajax, WPF
Help to Read and Extract Field Data from PDF with a Convenient C# Solution
how to extract data from pdf to excel; export pdf form data to excel
Extract pdf data to excel - VB.NET PDF Form Data Read library: extract form data from PDF in vb.net, ASP.NET, MVC, Ajax, WPF
Convenient VB.NET Solution to Read and Extract Field Data from PDF
make pdf form editable in reader; pdf data extraction to excel
202
Chapter 7:  API Reference for PDFlib, PDI, and PPS
int PDF_fill_imageblock(PDF *p,
int page, const char *blockname, int image, const char *optlist)
Fill an image block with variable data according to its properties.
page A valid PDF page handle for a page containing blocks.
blockname The name of the block.
image A valid image handle for the image to be filled into the block, or -1 if the default 
image is to be used.
optlist An option list (see Section 3.1.4, »Option Lists«, page 44) specifying filling de-
tails according to Table 7.30.
Returns -1 (in PHP: 0) if the named block doesn’t exist on the page, the block cannot be filled, or 
the block requires a newer PDFlib version for processing; 1 if the block could be pro-
cessed successfully. Use the pdiwarning option to get more information about the na-
ture of the problem.
Details The image referred to by the supplied image handle will be placed in the block, subject 
to the block’s properties. If image is -1 (in PHP: 0) the function will use the block’s default 
image if available, and silently return otherwise. 
If the PDF document is found to be corrupt, this function will either throw an excep-
tion or return -1 subject to the pdiwarning parameter or option.
Scope page, template
Note This function is only available in the PDFlib Personalization Server (PPS).
int PDF_fill_pdfblock(PDF *p,
int page, const char *blockname, int contents, const char *optlist)
Fill a PDF block with variable data according to its properties.
page A valid PDF page handle for a page containing blocks.
blockname The name of the block.
contents A valid PDF page handle for the PDF page to be filled into the block, or -1 if the 
default PDF page is to be used.
optlist An option list (see Section 3.1.4, »Option Lists«, page 44) specifying filling de-
tails according to Table 7.30.
Returns -1 (in PHP: 0) if the named block doesn’t exist on the page, the block cannot be filled, or 
the block requires a newer PDFlib version for processing; 1 if the block could be pro-
cessed successfully. Use the pdiwarning option to get more information about the na-
ture of the problem.
Details The PDF page referred to by the supplied page handle contents will be placed in the 
block, subject to the block’s properties. If contents is -1 (in PHP: 0) the function will use 
the block’s default PDF page if available, and silently return otherwise. 
If the PDF document is found to be corrupt, this function will either throw an excep-
tion or return -1 subject to the pdiwarning parameter or option.
VB.NET Create PDF from Excel Library to convert xlsx, xls to PDF
Image: Insert Image to PDF. Image: Remove Image from PDF Page. Image: Copy, Paste, Cut Image in Page. Data: Read, Extract Field Data. Data: Auto Fill-in Field
extract data from pdf file; exporting pdf form to excel
C# PDF Image Extract Library: Select, copy, paste PDF images in C#
Image: Extract Image from PDF. |. Home ›› XDoc.PDF ›› C# PDF: Extract PDF Image. How to C#: Extract Image from PDF Document.
extract data from pdf c#; java read pdf form fields
7.8  Block Filling Functions (PPS) 203
Scope page, template
Note This function is only available in the PDFlib Personalization Server (PPS).
Table 7.30 Options for the PDF_fill_*block( ) functions
key
type
explanation
embedding
boolean
(Only for PDF_fill_textblock( )) The embedding option for the font. Default: false.
encoding
string
(Required for PDF_fill_textblock( ) unless no text is supplied and the defaulttext 
property is used) Encoding for the font as required by PDF_load_font( ).
fontwarning boolean
(Only for PDF_fill_textblock( )) Specifies whether or not this function will throw an 
exception in case of font-related problems. Default is the value of the pdiwarning 
option
.
imagewarning
boolean
(Only for PDF_fill_imageblock( )) Specifies whether or not this function will throw 
an exception in case of image-related problems. Default is the value of the 
pdiwarning option.
pdiwarning
boolean
Specifies whether or not this function will throw an exception in case of an error 
in the PDF page containing the block or the page to be used as block contents. 
Default is the value of the pdiwarning parameter (see Table 7.29
).
textformat
string
(Only for PDF_fill_textblock( ) unless the defaulttext property is used) The format 
used to interpret the supplied text (see Section 4.5.2, »Unicode Text Formats«, 
page 92). Default: auto
almost any 
property 
name
various
Block property names and values (see Section 6.3, »Standard Properties for 
automated Processing«, page 137) which will be used to override those in the block 
definition. See Section 6.1.2, »Block Properties«, page 128, for details. The following 
block properties can not be overridden:
Name, Description, Locked, Subtype, Type
defaulttext, defaultimage, defaultpdf, defaultpdfpage
As an alternative to supplying the fontname property the font option can be used 
to supply a font handle (fontname will be ignored in this case).
Color properties support the following color space keywords: none, gray, rgb, 
cmyk, spot, spotname.
VB.NET PDF Text Extract Library: extract text content from PDF
PDF ›› VB.NET PDF: Extract PDF Text. VB.NET PDF - Extract Text from PDF Using VB. How to Extract Text from PDF with VB.NET Sample Codes in .NET Application.
save pdf forms in reader; how to make pdf editable form reader
C# PDF Text Extract Library: extract text content from PDF file in
XDoc.PDF ›› C# PDF: Extract PDF Text. C# PDF - Extract Text from PDF in C#.NET. Feel Free to Extract Text from PDF Page, Page Region or the Whole PDF File.
fill in pdf form reader; cannot save pdf form in reader
204
Chapter 7:  API Reference for PDFlib, PDI, and PPS
7.9 Hypertext Functions
Strings for hypertext functions may contain 8-bit-encoded text or Unicode. The string 
will be converted according to the hypertextencoding parameter unless it contains Uni-
code.
Table 7.31 lists relevant parameters and values for this section.
7.9.1 Document Open Action and Open Mode
Table 7.32 lists relevant parameters and values for this section.
7.9.2 Viewer Preferences
Table 7.33 lists relevant parameters and values for this section.
Table 7.31 Parameters for hypertext functions (see Section 7.2.3, »Parameter Handling«, page 153)
function
key
explanation
set_parameter
get_parameter
hypertextencoding
Specifies the encoding in which hypertext functions will expect the client-
supplied strings (see Section 4.5.3, »Unicode for Hypertext Elements«, page 
93). An empty string is equivalent to unicode. Default: empty string for 
Unicode-capable language bindings, otherwise auto. Scope: any.
set_parameter
get_parameter
hypertextformat
Set the format in which the hypertext functions will expect the client-
supplied strings. Possible values are bytes, utf8, utf16, utf16le, utf16be, and 
auto . Default: auto. Scope: any.
set_parameter usercoordinates
If false, coordinates for hypertext rectangles will be expected in the de-
fault coordinate system (see Section 3.2.1, »Coordinate Systems«, page 53); 
otherwise the current user coordinate system will be used. Default: false. 
Scope: any.
Table 7.32 Parameters for document open action and open mode (see Section 7.2.3, »Parameter Handling«, page 
153). Scope: document.
function
key
explanation
set_parameter openaction
Set the open action, i.e., the page number and zoom factor which will be 
visible upon opening the document. The value is an option list according 
to Table 7.40. Default: »type fitwindow«.
set_parameter
openmode
Set the appearance when the document is opened.Default: bookmarks if 
the document contains any bookmarks, and otherwise none.
none
Neither bookmarks nor thumbnails are visible
bookmarks
Open the document with bookmarks visible.
thumbnails
Open document with thumbnails visible
fullscreen
Open in fullscreen mode (does not work in the browser).
Table 7.33 Parameters for viewer preferences (see Section 7.2.3, »Parameter Handling«, page 153). Scope: document
function
key
explanation
set_parameter hidetoolbar
1
Boolean specifying whether to hide Acrobat’s tool bar. Default: false.
set_parameter
hidemenubar
Boolean specifying whether to hide Acrobat’s menu bar. Default: false.
set_parameter hidewindowui
Boolean specifying whether to hide Acrobat’s window controls. Default: 
false.
set_parameter
fitwindow
Boolean specifying whether to resize the document’s window to the size of 
the first page. Default false.
VB.NET PDF Image Extract Library: Select, copy, paste PDF images
Image: Extract Image from PDF. |. Home ›› XDoc.PDF ›› VB.NET PDF: Extract PDF Image. VB.NET PDF - Extract Image from PDF Document in VB.NET.
how to fill in a pdf form in reader; exporting pdf data to excel
C# Create PDF from Excel Library to convert xlsx, xls to PDF in C#
Create PDF from Excel. |. Home ›› XDoc.PDF ›› C# PDF: Create PDF from Excel. Export PDF from Excel with cell border or no border.
c# read pdf form fields; change font size pdf form reader
7.9  Hypertext Functions 205
7.9.3 Bookmarks
Table 7.34 lists relevant parameters for this section.
Note Adding bookmarks sets the open mode (see Section 7.9.1, »Document Open Action and Open 
Mode«, page 204) to bookmarks unless another mode has explicitly been set.
int PDF_add_bookmark(PDF *p, const char *text, int parent, int open)
int PDF_add_bookmark2(PDF *p, const char *text, int len, int parent, int open)
Add a nested bookmark under parent, or a new top-level bookmark.
text Contains the text of the bookmark. It may contain Unicode. The maximum 
length of text is 255 single-byte characters (8-bit encodings), or 126 Unicode characters. 
However, a practical limit of 32 characters for text is advised.
len (Only for PDF_add_bookmark2( ), and only for the C binding.)  Length of text (in 
bytes) for strings which may contain null characters. If len = 0 a null-terminated string 
must be provided.
set_parameter centerwindow
Boolean specifying whether to position the document’s window in the 
center of the screen. Default: false.
set_parameter
displaydoctitle
Boolean specifying whether to display the Title document info field in 
Acrobat’s title bar (true) or the file name (false). Default: false.
set_parameter nonfullscreen-
pagemode
Specifies how to display the document on exiting full-screen mode (only 
relevant if the openmode parameter is set to fullscreen). Default: usenone.
useoutlines
display page and document outline (bookmarks)
usethumbs
display page and thumbnails
usenone
neither document outline nor thumbnails, only page
set_parameter
direction
The reading order of the document. Default l2r.
l2r
Left to right
r2l
Right to left (including vertical writing systems)
This parameter affects the scroll ordering in double-page view.
set_parameter viewarea
viewclip
printarea
printclip
The value of the page boundary box representing the area of a page to be 
displayed or clipped when viewing the document on screen or printing it. 
Acrobat ignores this setting. Default crop:
art
Use the ArtBox
bleed
Use the BleedBox
crop
Use the CropBox
media
Use the MediaBox
trim
Use the TrimBox
1. Acrobat ignores this setting when viewing PDFs in a browser.
Table 7.34 Parameters for bookmarks (see Section 7.2.3, »Parameter Handling«, page 153)
function
key
explanation
set_parameter bookmark-
dest
Set the the page number and zoom factor for subsequently generated bookmarks. 
The value is an option list according to Table 7.40. This parameter can be changed 
an arbitrary number of times. Default: »type fitwindow«.
Table 7.33 Parameters for viewer preferences (see Section 7.2.3, »Parameter Handling«, page 153). Scope: document
function
key
explanation
C# PDF Page Extract Library: copy, paste, cut PDF pages in C#.net
Page: Extract, Copy and Paste PDF Pages. Easy to Use C# Code to Extract PDF Pages, Copy Pages from One PDF File and Paste into Others in C#.NET Program.
extract data from pdf to excel; pdf data extractor
VB.NET PDF Page Extract Library: copy, paste, cut PDF pages in vb.
VB.NET: Extract PDF Pages and Save into a New PDF File. You VB.NET: Extract PDF Pages and Overwrite the Original PDF File. Instead
filling out pdf forms with reader; extract pdf data into excel
206
Chapter 7:  API Reference for PDFlib, PDI, and PPS
parent If parent contains a valid bookmark handle returned by a previous call to PDF_
add_bookmark( ), a new bookmark will be generated which is a subordinate of the given 
parent. In this way, arbitrarily nested bookmarks can be generated. If parent = 0 a new 
top-level bookmark will be generated. 
open If 0, child bookmarks will not be visible. If open = 1, all children will be folded out.
Returns An identifier for the bookmark just generated. This identifier may be used as the parent 
parameter in subsequent calls.
Details This function adds a PDF bookmark with the supplied text. The bookmark appearance 
(font style and color) and target can be controlled with the bookmarkdest parameter (see 
Table 7.34). If the page option in the bookmarkdest parameter has been set to 0 the book-
mark will point to the current page.
Scope page
Params openmode, bookmarkdest
7.9.4 Document Information Fields
void PDF_set_info(PDF *p, const char *key, const char *value)
void PDF_set_info2(PDF *p, const char *key, const char *value, int len)
Fill document information field key with value. 
key The name of the document info field, which may be any of the standard names, or 
an arbitrary custom name (see Table 7.35). There is no limit for the number of custom 
fields. Regarding the use and semantics of custom document information fields, PDFlib 
users are encouraged to take a look at the Dublin Core Metadata element set.
1
value The string to which the key parameter will be set. It may contain Unicode. Acro-
bat imposes a maximum length of value of 255 bytes. Note that due to a bug in Adobe 
Reader 6 for Windows the & character does not display properly in some info strings.
len (Only for PDF_set_info2( ), and only for the C binding.)  Length of value (in bytes) for 
strings which may contain null characters. If len = 0 a null-terminated string must be 
provided.
Scope object, document, page
1. See http://dublincore.org 
Table 7.35 Values for the document information field key
key
explanation
Subject
Subject of the document
Title
Title of the document
Creator
Software used to create the document (as opposed to the Producer of the PDF 
output, which is always PDFlib). Acrobat 6 will display this entry as »Application«.
Author
Author of the document
Keywords
Keywords describing the contents of the document
7.9  Hypertext Functions 207
7.9.5 Page Transitions
PDF files may specify a page transition in order to achieve special effects which may be 
useful for presentations or »slide shows«. In Acrobat, these effects cannot be set docu-
ment-specific or on a page-by-page basis, but only for the full screen mode. PDFlib, how-
ever, allows setting the page transition mode and duration for each page separately. Ta-
ble 7.36 lists relevant parameters and values for this section.
7.9.6 File Attachments
void PDF_attach_file(PDF *p, float llx, float lly, float urx, float ury, const char *filename,
const char *description, const char *author, const char *mimetype, const char *icon)
void PDF_attach_file2(PDF *p, float llx, float lly, float urx, float ury, const char *filename,
int reserved, const char *description, int desc_len, const char *author, int author_len,
const char *mimetype, const char *icon)
Add a file attachment annotation.
llx, lly, urx, ury x and y coordinates of the lower left and upper right corners of the an-
notation rectangle in default coordinates (if the usercoordinates parameter is false) or 
user coordinates (if it is true). Acrobat will align the upper left corner of the icon at the 
upper left corner of the specified rectangle.
filename The name of the file which will be attached to the PDF document. If the file 
cannot be opened PDFlib will throw an exception.
reserved (C language binding only.) Reserved, must be 0.
Trapped
Indicates whether trapping has been applied to the document. Allowed values are 
True, False, and Unknown.
any name other than 
CreationDate, Producer, and 
ModDate
User-defined field. PDFlib supports an arbitrary number of fields.
Table 7.36 Parameters and values for page transitions (see Section 7.2.3, »Parameter Handling«, page 153)
function
key
explanation
set_parameter transition
Set the page transition effect for the current and subsequent pages until the 
transition is changed again. The transition types below are supported. type may 
also be empty to reset the transition effect. Default is replace. Scope: any.
split
Two lines sweeping across the screen reveal the page
blinds
Multiple lines sweeping across the screen reveal the page
box
A box reveals the page
wipe
A single line sweeping across the screen reveals the page
dissolve The old page dissolves to reveal the page
glitter
The dissolve effect moves from one screen edge to another
replace The old page is simply replaced by the new page (default)
set_value
duration
Set the page display duration in seconds for the current page. Default is one 
second. Scope: any
Table 7.35 Values for the document information field key
key
explanation
208
Chapter 7:  API Reference for PDFlib, PDI, and PPS
description A string with some explanation of the attachment. It may contain Uni-
code.
desc_len (Only for PDF_attach_file2( ), and only for the C binding.)  Length of description 
(in bytes) for strings which may contain null characters. If len = 0 a null-terminated 
string must be provided.
author A string with the author’s name or function. It may contain Unicode. 
author_len (Only for PDF_attach_file2( ), and only for the C binding.)  Length of author 
(in bytes) for strings which may contain null characters. If len = 0 a null-terminated 
string must be provided.
mimetype The MIME type of the file. It will be used by Acrobat for launching the ap-
propriate program when the file attachment annotation is activated.
icon Controls the display of the unopened file attachment in Acrobat (see Table 7.37).
Details This function adds a file attachment annotation at the specified rectangle. Acrobat 
Reader is unable to deal with file attachments and will display a question mark instead. 
File attachments only work in the full Acrobat software. The color of the attachment 
icon can be controlled with PDF_set_border_color( ).
Scope page
7.9.7 Note Annotations
Note All annotation coordinates are different from the parameters of the PDF_rect( ) function. While 
all annotation functions expect parameters for two corners directly, PDF_rect( ) expects the co-
ordinates of one corner, plus width and height values.
void PDF_add_note(PDF *p, float llx, float lly, float urx, float ury,
const char *contents, const char *title, const char *icon, int open)
void PDF_add_note2(PDF *p, float llx, float lly, float urx, float ury, const char *contents,
int contents_len, const char *title, int len_title, const char *icon, int open)
Add a note annotation.
llx, lly, urx, ury x and y coordinates of the lower left and upper right corners of the 
note rectangle in default coordinates (if the usercoordinates parameter is false) or user 
coordinates (if it is true). Acrobat will align the upper left corner of the icon at the upper 
left corner of the specified rectangle.
contents Text content of the note. It may contain Unicode. The maximum length of 
contents is 65535 bytes.
Table 7.37 Icon names for file attachments
icon name
icon appearance
icon name
icon appearance
graph
pushpin
paperclip
tag
7.9  Hypertext Functions 209
contents_len (Only for PDF_add_note2( ), and only for the C binding.)  Length of 
contents (in bytes) for strings which may contain null characters. If len = 0 a null-termi-
nated string must be provided.
title Heading text of the note. It may contain Unicode. The maximum length of title is 
255 single-byte characters or 126 Unicode characters. However, a practical limit of 32 
characters for title is advised.
title_len (Only for PDF_add_note2( ), and only for the C binding.)  Length of title (in 
bytes) for strings which may contain null characters. If len = 0 a null-terminated string 
must be provided.
icon Controls the display of the unopened note annotation in Acrobat (see Table 7.38).
open The annotation will be displayed in open state if open = 1, and closed if open = 0.
Details This function adds a note annotation at the specified rectangle. The color of the note 
icon can be controlled with PDF_set_border_color( ).
Scope page
7.9.8 Link Annotations and Named Destinations
Table 7.39 lists relevant parameters for this section.
Note PDF doesn’t support links with shapes other than rectangles.
Table 7.38 Icon names for note annotations
icon name
icon appearance
icon name
icon appearance
comment
newparagraph
insert
key
note
help
paragraph
Table 7.39 Parameters for links (see Section 7.2.3, »Parameter Handling«, page 153)
function
key
explanation
set_parameter base
Set the document’s base URL. This is useful when a document with relative Web 
links to other documents is moved to a different location. Setting the base URL to 
the »old« location makes sure that relative links will still work. Scope: page, 
pattern, template, document.
set_parameter
launchlink:
parameters
Set additional parameters which will be passed to an application launched via 
PDF_add_launchlink( ). This is only supported by Acrobat on Windows. Multiple 
parameters can be separated with a space character, but individual parameters 
must not contain any space characters. Scope: any
1
210
Chapter 7:  API Reference for PDFlib, PDI, and PPS
void PDF_add_pdflink(PDF *p, float llx, float lly, float urx, float ury,
const char *filename, int page, const char *optlist)
Add a file link annotation (to a PDF target).
llx, lly, urx, ury x and y coordinates of the lower left and upper right corners of the link 
rectangle in default coordinates (if the usercoordinates parameter is false) or user coordi-
nates (if it is true).
filename The name of the target PDF file.
page The physical page number of the target page, which must be greater than 0. This 
parameter will be ignored if the page option is present in optlist. Note that due to a bug 
Acrobat 6.0 will ignore the page number, and will always jump to page 1. This bug has 
been fixed in Acrobat 6.0.1, and is not present in older versions.
optlist An option list (see Section 3.1.4, »Option Lists«, page 44) specifying the destina-
tion according to Table 7.40.
Scope page
void PDF_add_locallink(PDF *p,
float llx, float lly, float urx, float ury, int page, const char *optlist)
Add a link annotation to a target within the current PDF file.
llx, lly, urx, ury x and y coordinates of the lower left and upper right corners of the link 
rectangle in default coordinates (if the usercoordinates parameter is false) or user coordi-
nates (if it is true).
page The physical page number of the target page, which must be greater than 0. This 
may be a previously generated page, or a page in the same document that will be gener-
ated later (after the current page). However, the application must make sure that the 
target page will actually be generated; PDFlib will issue a warning message otherwise. 
The value 0 can be used for the current page. This parameter will be ignored if the page 
option is present in optlist.
optlist An option list (see Section 3.1.4, »Option Lists«, page 44) specifying the destina-
tion according to Table 7.40.
Scope page
set_parameter launchlink:
operation
Specify an operation which will be applied to a document launched via PDF_add_
launchlink( ). This must be either »open« or »print«. In the latter case the launched 
file must be a document (not an application). It is only supported by Acrobat on 
Windows. Scope: any
set_parameter
launchlink:
defaultdir
Set an additional default directory for an application launched via PDF_add_
launchlink( ). This is only supported by Acrobat on Windows. Scope: any
1. The next call to PDF_add_launchlink() will use any of the launchlink parameters which have been set, and reset it after use.
For subsequent function calls the parameters must be set again.
Table 7.39 Parameters for links (see Section 7.2.3, »Parameter Handling«, page 153)
function
key
explanation
Documents you may be interested
Documents you may be interested