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

DynaPDF Manual - Page 218

Previous Page 217   Index   Next Page 219

Function Reference
Page 218 of 750
CreateColItemDate
Syntax:
LBOOL pdfCreateColItemDate(
const PPDF* IPDF,
// Instance pointer
UI32 EmbFile,
// Handle of an embedded file
const char* Key,
// The key defined in the collection field
long Date,
// The date time value as integer
const char* Prefix) // Optional prefix to be added to the value
The function creates a user defined collection item which accepts a date time 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 Date is passed to the Ansi function localtime() or gmtime() to create a PDF compatible
date time value. Therefore, the value must be defined in the format which these functions accept. It is
usually defined as the number of seconds elapsed since midnight (00:00:00), January 1, 1970.
However, depending on the operating system, the base date can be different.
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.
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.
 

Previous topic: How to define Lab colors?

Next topic: CreateCollection