Meet us at at Real World in Orlando, Florida.

All functions   Mac OS X   Windows   Crossplatform   Components   Guides  
New in version: 2.0   2.1   2.2   2.3   2.4   2.5   2.6   2.7   2.8  

PDFKit.SetPDFAttribute

Component: PDFKit
Version: 2.3
Mac OS X: Works
Windows: Not implemented.

MBS( "PDFKit.SetPDFAttribute"; PDF; Key; Value )

Parameters

Parameter Description Example value
PDF A PDF reference from PDFKit.Open or other functions. $ref
Key Which information to set. This can be one of the following: Title, Subject, Author, Creator, Producer, Keywords, CreationDate or ModificationDate. "Title"
Value The new value for this key. Either a text for text value or a timestamp for a date. "new value"

Result

Returns "OK" on success or an error message.

Description

Sets a PDF attribute.
While you can pass here a container value or an URL to a PDF file, you should really pass a reference value. Because once you changed the PDF attribute, you want to save the PDF with a call to PDFKit.GetDocument.

Examples

Set title to a PDF:

MBS("PDFKit.SetPDFAttribute"; $ref; "title"; "The new title for this PDF file." )

Feedback: Report problem or ask question.




Links
MBS Realbasic Plugins - Pfarrgemeinde Messdiener Nickenich