ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / WLanguage functions / Standard functions / PDF functions
  • Properties specific to pdfDocument variables
  • Remarks
  • WLanguage functions that use pdfDocument variables
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
The pdfDocument type gets all the characteristics of a PDF file: author, date created, page content, etc. Some characteristics of the PDF document can be changed using different WLanguage properties. It is possible to add or delete pages.
Remark: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.
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")
Remarks

Properties specific to pdfDocument variables

The following properties can be used to handle a PDF document:
Property nameType usedEffect
AttachmentArray of pdfAttachmentAttachments of PDF document.
It is possible to delete or add attachments to a document using array management functions (Add, Delete, ... on the array of pdfAttachment variables).
AuthorCharacter stringAuthor of the document (only if this information is available in the PDF document).
This property is read-only.
BookmarkArray of pdfBookmarkBookmarks of the PDF document.
DateCreatedDateTimeDate and time the document was created (only if this information is available in the PDF document).
This property is read-only.
DateModifiedDateTimeDate and time the document was last modified (only if this information is available in the PDF document).
This property is read-only.
This property corresponds to "ModificationDate" in previous versions.
GeneratorCharacter stringName of the program that generated the document (only if this information is available in the PDF document).
This property is read-only.
KeywordCharacter stringDocument 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.
PageArray of pdfPagePages of the PDF document.
It is possible to delete or add pages to a document using array management functions (Add, Delete, ... on the array of pdfPage variables).
PDFVersionCharacter stringVersion of the PDF standard used in the PDF document.
This property is read-only.
TitleCharacter stringDocument title (only if this information is available in the PDF document).
This property is read-only.
ValueCharacter string or BufferPDF document. This property can correspond to:
  • the path of the PDF document,
  • the buffer containing the PDF document.

Remarks

  • 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, ... on the array of pdfPage variables). Similarly, it is possible to add or delete attachments.

WLanguage functions that use pdfDocument variables

PDFAddWatermarkAdds a watermark to all or some pages of an existing PDF file.
PDFCloseCloses the PDF file loaded in memory in a pdfDocument variable.
PDFGetSignatureGets the signature of a PDF document as a buffer.
PDFGetSignatureDateGets the date of one of the signatures of a PDF document.
PDFNbSignaturesGets the number of signatures in a PDF document.
PDFOpenOpens a PDF document and loads it in a pdfDocument variable.
PDFSaveSaves the content of a pdfDocument variable in a ".PDF" file.
Related Examples:
PDFDocument type 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
Minimum version required
  • Version 25
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 07/06/2023

Send a report | Local help