DynaPDF Manual - Page 374
Previous Page 373 Index Next Page 375
Function Reference
Page 374 of 839
GetBookmark (obsolete)
Syntax:
LBOOL pdfGetBookmark(
const PPDF* IPDF,
// Instance pointer
SI32 AHandle,
// Bookmark handle
struct TBookmark ADDR Bmk) // see below
struct TBookmark
{
UI32 Color;
// Bookmark color (PDF 1.4)
SI32 DestPage;
// Destination page
struct TPDFRect DestPos; // Destination position
TDestType DestType;
// Destination type (see SetBookmarkDest())
LBOOL Open;
// True if the bookmark appears open
SI32 Parent;
// Parent bookmark if any or -1
TBmkStyle Style;
// Text style, see below (PDF 1.4)
const void* Title;
// Pointer to text string
UI32 TitleLen;
// Title length in characters
LBOOL Unicode;
// If true, Title is a pointer to UI16*
};
typedef enum
{
bmsNormal = 0,
bmsItalic = 1,
bmsBold
= 2
}TBmkStyle;
This function returns the properties of a bookmark. This function is marked as obsolete. Please use
GetBookmarkEx() if possible.
GetBookmarkEx
Syntax:
LBOOL pdfGetBookmarkEx(
const PPDF* IPDF,
// Instance pointer
SI32 Handle,
// Bookmark handle
struct TPDFBookmark* Bmk) // Structure to be filled
struct TPDFBookmark
{
UI32
StructSize;
// Must be set to sizeof(TPDFBookmark)
SI32
Action;
// Action handle or -1 if not set.
UI32
Color;
// Optional text color. Black is the default value (0).
SI32
DestPage;
// Destination page.
struct TPDFRect DestPos;
// Destination position.
TDestType
DestType;
// Destination type.
const char*
NamedDestA;
// If set, DestPage, DestPos, and DestType were already taken from
// the destination if it was found in the file.
const UI16*
NamedDestW;
// Either the Unicode or Ansi string is set but never both.
LBOOL
Open;
// If true, child nodes should be visible.
SI32
Parent;
// The immediate parent node or -1 for a root node.
const void*
StructElem;
// Bookmarks can contain a reference to a structure element. There
// is no API to access structure elements yet.
TBmkStyle
Style;
// The font style that should be used to render this node.
const char*
TitleA;
// The bookmark title.
const UI16*
TitleW;
// Either the Unicode or Ansi string is set but never both.
UI32
TitleLen;
// String length in characters.
};
Previous topic: Bounding boxes:, GetBidiMode
Next topic: GetBookmarkCount, GetBorderStyle, GetBuffer