DynaPDF Manual - Page 241

Previous Page 240   Index   Next Page 242

Function Reference
Page 241 of 818
CreateColItemNumber
Syntax:
LBOOL pdfCreateColItemNumber(
const PPDF* IPDF,
// Instance pointer
UI32 EmbFile,
// Handle of an embedded file
const char* Key,
// The key defined in the collection field
double 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 number 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 any positive or negative number. 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.
Return values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
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.
 

Previous topic: CreateColItemDate

Next topic: CreateCollection


Start Chat