Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

DynaPDF Manual - Page 219

Previous Page 218   Index   Next Page 220

Function Reference
Page 219 of 750
CreateColItemString
Syntax:
LBOOL pdfCreateColItemString(
const PPDF* IPDF,
// Instance pointer
UI32 EmbFile,
// Handle of an embedded file
const char* Key,
// The key defined in the collection field
const char* Value,
// The value for the key
const char* Prefix) // Optional prefix to be added to the value
The function creates a user defined collection item which accepts an arbitrary string as value.
The parameter Key must be the key that was used in the related collection field in which the value
should be shown. The parameter Value can be an arbitrary string. However, the string should be
human readable because it is displayed in the user interface.
The parameter Prefix is optional. If set, it is concatenated with the text string presented to the user.
This entry is ignored when a PDF viewer application sorts the items in the collection.
Remarks:
This function is implemented in an Ansi and Unicode compatible version.
Return values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
CreateCollection
LBOOL pdfCreateCollection(
const PPDF* IPDF, // Instance pointer
TColView View)
// Initial view
typedef enum
{
civNotSet,
// Internal, not usable
civDetails,
civTile,
civHidden,
civCustom
// Not usable. The view is presented by a SWF file.
}TColView;
The function marks the current PDF file in memory as PDF collection, also known as PDF Package.
Beginning with PDF 1.7, PDF documents can specify how a viewer application’s user interface
presents collections of file attachments, where the attachments are related in structure or content.
Such a presentation is called a portable collection.
The intent of portable collections is to present, sort, and search collections of related documents, such
as email achieves, photo collections, and engineering bid sets. There is no requirement that files in a
collection have an implicit relationship or even a similarity; however, showing differentiating
characteristics of related documents can be helpful for document navigation.
 

Previous topic: CreateColItemNumber

Next topic: CreateCollectionField