Adding custom document properties

Have you looked at the 'info' property of the 'doc' object in the Acrobat JS API Reference. Look closely at example 2.

Thank you for the response (and so quick too). The example you referenced is helpful to extract the value of the property. But I was needing to add a custom property to the document. Any help with that - what method to use?

Look at the doc.metadata property, which gives you direct access into the XMP stack Adding entries takes a bit of code as you need to build the XML manually, but it's easy enough once you've got the function laid out. The custom properties entries from the UI tab appear in the pdfx: namespace, but the quickest way to find where a property needs to be put in is to add it manually to a PDF and run a report on the stack, by running this in the console:

var r = new Report();
r.writeText(this.metadata);
r.open("MetadataReportFile");

Actually that example add the "ISBN" and 'PublishDate" custom data.

The result when run from the JavaScript console:


And if you look at the Properties 'Custom' tab, you will see the 'ISBN' and 'PublishDate' fields have been added with values.

Thank so much for the assitance. I have created a function that adds the custom document property. The simplifed code is below:

Function SetPDFDocProperty(sFileName As String, sPropName As String, sPropValue As String) As Boolean

Dim oPDFDoc As New Acrobat.AcroAVDoc
Dim oPDDoc As New Acrobat.AcroPDDoc
Dim sPropField As String
Dim bSuccess As Boolean

SetPDFDocProperty = False
Set oPDFDoc = New Acrobat.AcroAVDoc
oPDFDoc.Open sFileName, "Temp"
Set oPDDoc = oPDFDoc.GetPDDoc()
bSuccess = oPDDoc.SetInfo(sPropField, sPropValue)
If bSuccess Then
bSuccess = oPDDoc.Save(33, sFileName) '... 33 = PDSaveFull (1) OR PDSaveCollectGarbage (32)
End If

oPDDoc.Close
oPDFDoc.Close (True)
Set oPDDoc = Nothing
Set oPDFDoc = Nothing

If bSuccess = True Then
SetPDFDocProperty = True
Else
SetPDFDocProperty = True
End If

Exit Function

This is working great.
Just because I am curious, is there a method to get the ID (not text) for a custom property (enumerate through the items) by the name and delete one?

Again, thanks for the replies and pointing me in the right direction.

Cammy

Using the 'info' property of the 'doc' object, I do not think so, but if you want to process the 'meta data' property contents then you probably could. The format the 'meta data' is an XMP file and is more complex than creating a name and setting a value. There is an example in the Acrobat JS API Reference, but that example only shows setting a copyright and copyright status and indicates there is significant coding in working with this data.