Specifications

Recommended forEncodingStorage formStorage type
short data streamsBinaryBase64 encoded
stream
base64
longer data streamsBinaryPDF object data stream
(i.e. outside of the XMP
packet)
ref
Note: The scripting API fully supports the “ref” storage type; it implements the appropriate
methods to read and write data from and to PDF objects and registers these methods with the
C++ toolkit.
Getters [R]
Returns true if the collection is empty, false otherwise. The
collection is empty if the underlying property is absent or if no
private data items are listed for the property.
isEmpty( ) : Boolean
Returns an unordered list of tags used to identify private data
items in this collection. The list is empty if the collection is
empty.
getTags( ) : String[]
Returns true if the collection contains a private data item with
the specified tag, false otherwise.
hasTag( tag : String ) :
Boolean
Returns true if the collection contains a private data item with
the specified tag, and that item has storage type “text”.
Otherwise the function returns false.
isString( tag : String ) :
Boolean
Returns true if the collection contains a private data item with
the specified tag, and that item has storage type “base64” or
“ref”. Otherwise the function returns false.
isBinary( tag : String ) :
Boolean
Returns true if the collection contains a private data item with
the specified tag, and that item has storage type “ref”. Otherwise
the function returns false.
isPDFObject( tag : String ) :
Boolean
Returns the contents of the private data item with the specified
tag as a string, or null if there is no such item or if the item does
not have storage type “text”.
getString( tag : String ) :
String
Returns the contents of the private data item with the specified
tag as a byte array, or null if there is no such item or if the item
getBinary( tag : String ) :
ByteArray
does not have storage type “base64” or “ref”. If the private data
has storage type “base64” it is decoded to binary form before
returning.
Setters [W]
These functions may be invoked only on data maps associated with the active session or with a
certificate in the active session. Invoking them on any other data map is a programming error
and has unpredictable results.
Places a private data item of storage type “text” in the collection
with the specified tag and contents. If an item with the same tag
already existed, it is replaced by this new item.
put( tag : String,
contents : String )
510
Enfocus Switch 10