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

DynaPDF Manual - Page 382

Previous Page 381   Index   Next Page 383

Function Reference
Page 382 of 750
}
}
pdfEndPage(PDF);
pdfCloseFile(PDF);
}
GetGoToAction
LBOOL pdfGetGoToAction(
const PPDF* IPDF,
// Instance pointer
UI32 Handle,
// Action handle
struct TPDFGoToAction* Action) // see below
struct TPDFGoToAction
{
UI32
StructSize;
// Must be set to sizeof(TPDFGoToAction).
SI32
DestPage;
// Destination page (the first page is denoted by 1).
float*
DestPos;
// Array of 4 floating point values if set.
TDestType
DestType;
// Destination type.
// GoToR (Go To Remote) actions only:
IFSR*
DestFile;
// see GetFileSpec().
const char* DestNameA;
// Optional named destination that shall be loaded when
// opening the file.
const UI16* DestNameW;
// Either the Ansi or Unicode string is set but never both.
SI32
NewWindow;
// Meaningful only if DestFile points to a PDF file.
// -1 = viewer default, 0 = false, 1 = true.
SI32
NextAction;
// -1 or next action handle to be executed if any.
TActionType NextActionType; // Only set if NextAction is >= 0.
};
The function retrieves the properties of a GoTo or GoTo Remote action. The member StructSize must
be set to sizeof(TPDFGoToAction) before the function can be called. The members DestPos and
DestType are not meaningful for GoTo Remote actions.
Return values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
GetGoToRAction
Syntax:
LBOOL pdfGetGoToRAction(
const PPDF* IPDF,
// Instance pointer
UI32 Handle,
// Action handle
struct TPDFGoToAction* Action) // see below
The functions GetGoToAction() and GetGoToRAction() are identically. Both functions can be called
for GoTo and GoTo Remote actions. See GetGoToAction() for further information.
Return values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
 

Previous topic: Outline format

Next topic: GetImageBuffer