DynaPDF Manual - Page 315

Previous Page 314   Index   Next Page 316

Function Reference
Page 315 of 818
DeleteNamedDestByIndex
Syntax:
LBOOL pdfDeleteNamedDestByIndex(
const PPDF* IPDF, // Instance pointer
SI32 Index)
// Array index of the named destination or -1
The function deletes a named destination. If Index is set to a negative value all named destinations
will be deleted.
Return values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
DeleteOCGFromDisplayTree
Syntax:
LBOOL pdfDeleteOCGFromDisplayTree(
const PPDF* IPDF, // Instance pointer
UI32 OCGHandle,
// OCG handle
LBOOL Recursive)
// Delete all occurrences?
The function deletes a layer or OCG (Optional Content Group) from the display tree of the currently
active layer configuration.
Notice:
If the PDF file was not imported with ImportPDFFile() the function ImportOCProperties() must
be called in order to import the global Optional Content Properties.
It is also required to load a layer configuration with LoadLayerConfig() before the function can
be called.
The display tree is a linked list that contains UI nodes. UI stands for User Interface. Every node in
this tree can contain an OCG or an array of OCGs with an optional label.
This function can be used to delete an OCG from the display tree without traversing every node of it
with GetOCUINode() beforehand. Therefore, the function is suitable for console applications but
GUI based applications should use DeleteOCUINode() instead. DeleteOCUINode() can also be used
to delete the entire display tree with just one function call.
Return values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
 

Previous topic: DeleteOCGFromAppEvent, DeleteNamedDest

Next topic: DeleteOCUINode, DeleteOutputIntent


Start Chat