PDBookmarkFlags. kPDBookmarkFontNormal=0x00 | |
kPDBookmarkFontItalic=0x01 | |
kPDBookmarkFontBold=0x02 | |
kPDBookmarkFontBoldItalic=0x03 |
typedef OPAQUE_64_BITS PDBookmark; PDBookmarkFontOptions. typedef ASEnum8 PDBookmarkFlags; aBookmark as the last child of parent, adjusting the tree containing parent appropriately. If parent previously had no children, it is open after the child is added. void PDBookmarkAddChild(PDBookmark parent, PDBookmark aBookmark); parent | The parent of the bookmark being added.
|
aBookmark | The bookmark that will become the last child of
aBookmark. aBookmark must have been previously unlinked. |
aBookmark, as the new last child of aBookmark. If aBookmark previously had no children, it will be open after the child is added. PDBookmark PDBookmarkAddNewChild(PDBookmark aBookmark, const char *initialText); aBookmark | The bookmark to which a new last child is added.
|
initialText | The new bookmark's title.
|
aBookmark, as the new last child of aBookmark. If aBookmark previously had no children, it will be open after the child is added. PDBookmark PDBookmarkAddNewChildASText(PDBookmark aBookmark, const ASText initialText); aBookmark | The bookmark to which a new last child is added.
|
initialText | The text object containing the new bookmark's title.
|
aBookmark, as the new right sibling. PDBookmark PDBookmarkAddNewSibling(PDBookmark aBookmark, char *initialText); aBookmark | The bookmark that will be the left sibling of the new bookmark.
|
initialText | The new bookmark's title.
|
aBookmark, as the new right sibling. PDBookmark PDBookmarkAddNewSiblingASText(PDBookmark aBookmark, const ASText initialText); aBookmark | The bookmark that will be the left sibling of the new bookmark.
|
initialText | The text object containing the new bookmark's title.
|
newNext as the new right sibling to aBookmark. void PDBookmarkAddNext(PDBookmark aBookmark, PDBookmark newNext); aBookmark | IN/OUT The bookmark that will receive a new right sibling.
|
newNext | IN/OUT The bookmark to become the new right sibling of
aBookmark. newNext must have been previously unlinked. |
newPrev as the new left sibling to aBookmark, adjusting the tree containing aBookmark appropriately. void PDBookmarkAddPrev(PDBookmark aBookmark, PDBookmark newPrev); aBookmark | The bookmark that will receive a new left sibling
newPrev. |
newPrev | The bookmark to become the new left sibling of
aBookmark. newPrev must have been previously unlinked. |
aBookmark, as a new last child of aBookmark. This new item will have the text value sourceTitle, will be open, and will have no destination attribute. source must have been previously unlinked. If aBookmark previously had no children, it will be open after the subtree is added. void PDBookmarkAddSubtree(PDBookmark aBookmark, PDBookmark source, char *sourceTitle); aBookmark | IN/OUT The bookmark to which the subtree source will be added as a new last child.
|
source | IN/OUT The bookmark subtree to add.
|
sourceTitle | IN/OUT The new bookmark's title.
|
aBookmark, as a new last child of aBookmark. This new item will have the text value sourceTitle, will be open, and will have no destination attribute. source must have been previously unlinked. If aBookmark previously had no children, it will be open after the subtree is added. void PDBookmarkAddSubtreeASText(PDBookmark aBookmark, PDBookmark source, const ASText sourceTitle); aBookmark | The bookmark to which the subtree source will be added as a new last child.
|
source | The bookmark subtree to add.
|
sourceTitle | The text object containing the new bookmark's title.
|
void PDBookmarkDestroy(PDBookmark aBookmark); aBookmark | IN/OUT The root bookmark of the subtree to remove.
|
ASBool PDBookmarkEqual(PDBookmark aBookmark, PDBookmark bookmark2); aBookmark | The first bookmark to compare.
|
bookmark2 | The second bookmark to compare.
|
PDBookmark PDBookmarkFromCosObj(CosObj obj); obj | The dictionary Cos object whose bookmark is obtained.
|
is raised if the bookmark is not valid as determined by PDBookmarkIsValid().
|
PDAction PDBookmarkGetAction(PDBookmark aBookmark); aBookmark | IN/OUT The bookmark whose action is obtained.
|
aName. Note: This text is stored in either PDFDocEncoding or in Unicode. If it is stored in Unicode, a valid Byte Order Mark must be present.
PDBookmark PDBookmarkGetByTitle(PDBookmark aBookmark, const char *aname, ASInt32 nameLen, ASInt32 maxdepth); aBookmark | IN/OUT The root of the bookmark subtree to search.
| ||||||||
aname | IN/OUT The text value to search for. Character codes in
aName are interpreted using the PDFDocEncoding. | ||||||||
nameLen | IN/OUT The length of
aName. | ||||||||
maxdepth | IN/OUT The number of subtree levels to search, not counting the root level:
|
NULL Cos object if there is no such bookmark. PDBookmark PDBookmarkGetByTitleASText(PDBookmark aBookmark, const ASText title, ASInt32 maxDepth); aBookmark | The root of the bookmark subtree to search.
| ||||||||
title | The text object containing the title value to search for.
| ||||||||
maxDepth | The number of subtree levels to search, not counting the root level.
|
NULL Cos object if there is no such bookmark. Retrieves the color of the specified bookmark.
An exception is thrown if the bookmark is invalid or the existing color is malformed in the PDF file.
ASBool PDBookmarkGetColor(PDBookmark bm, PDColorValue pdcvOut); bm | The bookmark in question.
|
pdcvOut | (Filled by the method) The color of the bookmark in PDColorValue format.
|
CosObj PDBookmarkGetCosObj(PDBookmark aBookmark); aBookmark | IN/OUT The bookmark whose Cos object is obtained.
|
ASInt32 PDBookmarkGetCount(PDBookmark aBookmark); aBookmark | The root bookmark of a subtree to count.
|
aBookmark). PDBookmark PDBookmarkGetFirstChild(PDBookmark aBookmark); aBookmark | IN/OUT The bookmark whose first child is obtained.
|
Retrieves the flags of the specified bookmark.
An exception is thrown if the bookmark is invalid or the existing style is malformed in the PDF file.
ASInt32 PDBookmarkGetFlags(PDBookmark bm); bm | The bookmark whose flags are obtained.
|
ASInt32 PDBookmarkGetIndent(PDBookmark aBookmark); aBookmark | IN/OUT The bookmark whose indentation level is obtained.
|
aBookmark in its containing tree. The root and its direct children have an indentation level of zero. PDBookmark PDBookmarkGetLastChild(PDBookmark aBookmark); aBookmark | IN/OUT The bookmark whose last child is obtained.
|
PDBookmark PDBookmarkGetNext(PDBookmark aBookmark); aBookmark | The bookmark whose right sibling is obtained.
|
aBookmark object's next (right) sibling. It returns a NULL Cos object if aBookmark has no next sibling (that is, it is its parent's last child). PDBookmark PDBookmarkGetParent(PDBookmark aBookmark); aBookmark | The bookmark whose parent is obtained.
|
PDBookmark PDBookmarkGetPrev(PDBookmark aBookmark); aBookmark | IN/OUT The bookmark whose left sibling is obtained.
|
aBookmark, or a NULL Cos object if aBookmark has no previous sibling (it is its parent's first child). Note: This text is stored in either PDFDocEncoding or in Unicode. If it is stored in Unicode, a valid Byte Order Mark must be present.
ASInt32 PDBookmarkGetTitle(PDBookmark aBookmark, char *buffer, ASInt32 bufSize); aBookmark | The bookmark whose title is obtained.
|
buffer | (Filled by the method) The buffer into which the title will be written. If
buffer is non- NULL, its length is assumed to be bufSize + 1, because a NULL byte is appended to the title. The returned text remains valid only until the next PDModel method call. The text may be converted to a platform's native encoding using PDXlateToHost() or PDXlateToHostEx(). |
bufSize | The size of the buffer.
|
void PDBookmarkGetTitleASText(PDBookmark aBookmark, ASText title); aBookmark | The bookmark whose title is obtained.
|
title | (Filled by the method) The text object containing the title. The client must pass a valid ASText object title. The routine does not allocate it.
|
ASBool PDBookmarkHasChildren(PDBookmark aBookmark); aBookmark | The bookmark to test.
|
ASBool PDBookmarkIsOpen(PDBookmark aBookmark); aBookmark | The bookmark to test.
|
ASBool PDBookmarkIsValid(PDBookmark aBookmark); aBookmark | The bookmark whose validity is tested.
|
void PDBookmarkRemoveAction(PDBookmark aBookmark); aBookmark | The bookmark whose action is removed.
|
void PDBookmarkSetAction(PDBookmark aBookmark, PDAction action); aBookmark | IN/OUT The bookmark whose action is set.
|
action | IN/OUT The bookmark's action.
|
void PDBookmarkSetColor(PDBookmark bm, PDColorValue pdcvIn); bm | The bookmark whose color is set.
|
pdcvIn | The new color. It must be in
DeviceRGB. |
If
| color is
NULL or not in DeviceRGB, the bookmark is invalid or the existing bookmark color is malformed. |
Sets the flags of the specified bookmark.
An exception is thrown if the bookmark is invalid or the existing style is malformed in the PDF file.
void PDBookmarkSetFlags(PDBookmark bm, ASInt32 nFlags); bm | The bookmark whose flags are set.
|
nFlags | The new bookmark flags. Bit 1 (the least significant bit) indicates an italic font; bit 2 indicates a bold font.
|
void PDBookmarkSetOpen(PDBookmark aBookmark, ASBool isOpen); aBookmark | IN/OUT The bookmark to open or close.
|
isOpen |
Note: This text is stored in either PDFDocEncoding or in Unicode. If it is stored in Unicode, a valid Byte Order Mark must be present.
void PDBookmarkSetTitle(PDBookmark aBookmark, const char *str, ASInt32 nBytes); aBookmark | The bookmark whose title is set.
|
str | A read-only string containing the bookmark's new title. The text must be encoded using
PDFDocEncoding. Strings encoded using a platform's native encoding can be converted to PDFDocEncoding using PDXlateToPDFDocEnc() or PDXlateToPDFDocEncEx(). |
nBytes | The number of bytes of
str to copy. |
is raised if there is an error setting the title.
|
void PDBookmarkSetTitleASText(PDBookmark aBookmark, const ASText title); aBookmark | The bookmark whose title is set.
|
title | The text object containing the bookmark's new title.
|
is raised if there is an error setting the title.
|
void PDBookmarkUnlink(PDBookmark aBookmark); aBookmark | IN/OUT The bookmark to unlink.
|