pdfDocument (Variable type)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Standard functions / PDF functions

Properties specific to pdfDocument variables
Manipulating a pdfDocument variable
WLanguage functions that use pdfDocument variables

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

pdfDocument (Variable type)

In french: pdfDocument

The pdfDocument type is used to get all the characteristics of a PDF file, including author, date created, page content, etc. Some characteristics of the PDF document can be changed using different WLanguage properties. You can add or delete pages.

Note: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.

Starting with version 28, the pdfDocument type and the PDFReaderxxx functions are not supported by 32-bit ARM processors. The new PDF features in version 28 require a 64-bit execution mode. If an application is intended for devices with 32-bit processors, it must be generated with WINDEV Mobile 27.

Example

MyPDF is pdfDocument = "test.pdf"
FOR EACH DocumentPage OF MyPDF.Page
	Trace(DocumentPage.Height)
END
PDFSave(MyPDF, "passwordtest.pdf")
// It is also possible to use prefix syntax
// MyPDF.Save("passwordtest.pdf")

MyPDFDoc is pdfDocument = PDFOpen("C:\temp\Myguide.pdf")
Trace(MyPDFDoc.PDFVersion)
Trace(MyPDFDoc.Author)
Trace(MyPDFDoc.Page.Count)
Trace(MyPDFDoc.Page[1].Width)
Trace(MyPDFDoc.Page[36].Height)
FOR EACH ATextElement OF MyPDFDoc.Page[2].TextElement
	Trace(ATextElement.Text + " X = " + 
	ATextElement.X + " Y = " + ATextElement.Y + " L = " + 
	ATextElement.Width + " H = " + ATextElement.Height)
END
MyPDFDoc2 is pdfDocument = "C:\temp\plan.pdf"
// Add pages
Add(MyPDFDoc2.Page, MyPDFDoc.Page[5])
// Insert pages
Insert(MyPDFDoc2.Page, 1, MyPDFDoc.Page[32])
// Save modified PDF
PDFSave(MyPDFDoc2, "MyPDFDoc2.pdf")
ShellExecute("MyPDFDoc2.pdf")

Properties

Properties specific to pdfDocument variables

The following properties can be used to handle a PDF document:

Property name	Type used	Effect

Attachment	Array of pdfAttachment	Attachments of the PDF document. It is possible to delete or add attachments to a document using array functions (Add, Delete, etc. on the array of pdfAttachment variables). Attachments are not supported.
Author	Character string	Author of the document (only if this information is available in the PDF document). This property is read-only.
Bookmark	Array of pdfBookmark	Bookmarks of the PDF document. Bookmarks are not available.
DateCreated	DateTime	Date and time the document was created (only if this information is available in the PDF document). This property is read-only.
DateModified	DateTime	Date and time the document was last modified (only if this information is available in the PDF document). This property is read-only. In previous versions, this property corresponds to "ModificationDate".
Generator	Character string	Name of the program that generated the document (only if this information is available in the PDF document). This property is read-only.
Keyword	Character string	Document keyword (only if this information is available in the PDF document). If several keywords are specified, the separator used depends on the generator. This property is read-only.
Page	Array of pdfPage	Pages of the PDF document. It is possible to delete or add pages to a document using array functions (Add, Delete, etc. on the array of pdfPage variables).
PDFVersion	Character string	Version of the PDF standard used in the PDF document. This property is read-only.
New in SaaS Protection	pdfProtection variable	PDF document protection options. This property is read-only. Note: This feature is only available from WINDEV Suite SaaS 2025 - Update 3. For more details, see Using new features exclusive to WINDEV Suite SaaS 2025.
Title	Character string	Document title (only if this information is available in the PDF document). This property is read-only.
Value	Character string or Buffer	PDF document. This property can correspond to: the path of the PDF document, the buffer containing the PDF document.

Remarks

Manipulating a pdfDocument variable

To initialize the pdfDocument variable, simply assign a string or (buffer) containing a PDF file. It is then possible to modify the document (by adding attachments or setting a password, for example) and then save it again by calling PDFSave.
It is possible to delete or add pages to a document using array functions (Add, Delete, etc. on the array of pdfPage variables). Similarly, it is possible to add or delete attachments.

WLanguage functions that use pdfDocument variables


PDFAddWatermark	Adds a watermark to all or some pages of an existing PDF file.
PDFClose	Closes the PDF file loaded in memory in a pdfDocument variable.
PDFGetSignature	Gets the signature of a PDF document as a buffer.
PDFGetSignatureDate	Gets the date of one of the signatures of a PDF document.
PDFNbSignatures	Gets the number of signatures in a PDF document.
PDFOpen	Opens a PDF document and loads it in a pdfDocument variable.
PDFSave	Saves the content of a pdfDocument variable in a ".PDF" file.

Related Examples:

Unit examples (WINDEV): PDFDocument type

[ + ] This example shows how to use the pdfDocument WLanguage type.
This type is used to handle PDF files by programming.
You can:
- Retrieve the details of the PDF file (Created, Modified, Author, etc.)
- Retrieve the text of the PDF file (page by page and line by line)
- List / Add / Delete attachments