| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
PDFKit.GetPDFAttribute
Queries a PDF attribute.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| PDFKit | 2.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes, on macOS | ✅ Yes |
Parameters
| Parameter | Description | Example |
|---|---|---|
| A container value with the PDF content from a media field. Or a text with an URL. Or a PDF reference from PDFKit.Open. | ||
| Key | Which information to query. This can be one of the following: Title, Subject, Author, Creator, Producer, Keywords, CreationDate or ModificationDate. | "Title" |
Result
Returns the text or date value requested.
Description
Queries a PDF attribute.New keys in v5.4: OwnerPassword, UserPassword, EncryptionKeyLength, AllowsPrinting and AllowsCopying.
| Key | Description |
| Title | The document's title. Optional; if present, the value of this key must be a text. |
| Author | The name of the person who created this document. Optional; if present, the value of this key must be a text. |
| Subject | The subject of a document. Optional; if present, the value of this key must be a text. |
| Keywords | The keywords for this document. This key is optional. Must be the keywords with comma separated. |
| Creator | The name of the application that created the original data used to create this document. Optional; if present, the value of this key must be a text. |
| OwnerPassword | The "owner password" of the PDF document. If this key is specified, the document will be encrypted using the value as the owner password; otherwise, the document will not be encrypted. The value of this key must be a text which can be represented in ASCII encoding; only the first 32 bytes will be used for the password. There is no default value for this key. If the value of this key cannot be represented in ASCII, the document will not be created and the creation function will fail. |
| UserPassword | The "user password" of the PDF document. If the document is encrypted, then the value of this key will be the user password for the document; if unspecified, the user password will be the empty string. The value of this key must be a text which can be represented in ASCII encoding; only the first 32 bytes will be used for the password. If the value of this key cannot be represented in ASCII, the document will not be created and the creation function will fail. |
| EncryptionKeyLength | Specifies the encryption key length in bits; see Table 3.18 "Entries common to all encryption dictionaries", PDF Reference: Adobe PDF version 1.5 (4th ed.) for more info. Optional; if present, the value of this key must be a number with value which is a multiple of 8 between 40 and 128, inclusive. If this key is absent or invalid, the encryption key length defaults to 40 bits. |
| AllowsPrinting | Used to specify whether the document allows printing when unlocked with the user password. The value of this key must be a boolean. The default value of this key is 1 (true). |
| AllowsCopying | Used to specify whether the document allows copying when unlocked with the user password. The value of this key must be a boolean. The default value of this key is 1 (true). |
| CreationDate | The creation date of PDF. |
| ModificationDate | The modification date of PDF. |
If you need more control about encryption, restrictions or metadata, you may want to checkout our DynaPDF functions in the plugin.
Added "json" as key to get all values in the document attributes as JSON.
Examples
Get all the information values for a PDF in a container:
"Title: " & MBS("PDFKit.GetPDFAttribute"; combine pdf::test1; "Title") & "¶" &
"Subject: " & MBS("PDFKit.GetPDFAttribute"; combine pdf::test1; "Subject") & "¶" &
"Author: " & MBS("PDFKit.GetPDFAttribute"; combine pdf::test1; "Author") & "¶" &
"Creator: " & MBS("PDFKit.GetPDFAttribute"; combine pdf::test1; "Creator") & "¶" &
"Producer: " & MBS("PDFKit.GetPDFAttribute"; combine pdf::test1; "Producer") & "¶" &
"Keywords: " & MBS("PDFKit.GetPDFAttribute"; combine pdf::test1; "Keywords") & "¶" &
"CreationDate: " & MBS("PDFKit.GetPDFAttribute"; combine pdf::test1; "CreationDate") & "¶" &
"ModificationDate: " & MBS("PDFKit.GetPDFAttribute"; combine pdf::test1; "ModificationDate")
Query all values as JSON:
MBS( "PDFKit.GetPDFAttribute"; combine pdf::test1; "json" )
Example result:
{
"Author" : "Christian Schmitz",
"Creator" : "Pages",
"CreationDate" : "2011-04-18 13:18:54 +0000",
"Producer" : "Mac OS X 10.6.7 Quartz PDFContext",
"ModDate" : "2011-04-18 13:18:54 +0000",
"Title" : "Ohne Titel"
}
See also
Release notes
- Version 12.4
- Added json key for PDFKit.GetPDFAttribute function.
- Version 11.4
- Fixed problem in PDFKit.GetPDFAttribute returning an error when no keywords are available.
Example Databases
Blog Entries
- Neues MBS Plugin 12.4 für Claris FileMaker
- MBS Plugin 12.4 for Claris FileMaker
- MBS FileMaker Plugin, version 12.4pr2
- MBS FileMaker Plugin, version 11.4pr3
- MBS FileMaker Plugin, version 5.4pr2
- MBS Filemaker Plugin, version 3.2pr8
This function checks for a license.
Created 18th August 2014, last changed 11st August 2022
