PInsertToken

Inserts an invisible token, or place-holder into a story. The tokens that this command creates are used by the Hypercontent Manager to mark hyperlinks and private data storage within the text.


Command constructor

This command requires that the text cursor is in a textblock. The command inserts the token at the location indicated in the constructor, not at the cursor position.

PInsertToken(unsigned long nCharPos, short nContentType);
usigned long nCharPos

Character postion (from the begining of the story) to insert the new token.

short nContentType

Type of token to insert. There are a full set of token types listed in HCMDefs.h, the following three are the only ones of interest from a plug-in (The rest are included in the header file for consistency.)
TYPE_HYPERLINK_END or 8 to end a hyperlink range
TYPE_PRIVATE_HYPERLINK or 9 to begin a hyperlink range
TYPE_PRIVATE_ANCHOR or 10 to specify an anchor point

Data will be lost in any publication where the TYPE_PRIVATE_HYPERLINK and TYPE_HYPERLINK_END tokens are not matched pairs (nesting is permitted.)
If there is a mismatched set of hyperlink tokens, the next time the publication is opened in PageMaker, all of the hyperlink tokens (and thus the hyperlinks) will be removed from the publication. For this reason, care should be taken in using the hyperlink tokens, and preference should be given to using the TYPE_PRIVATE_ANCHOR token.

The hyperlink tokens are very useful in creating pdfmarks, because the area is defined by PageMaker.


See also

The PGetHyperlinkInfo query

Adobe PageMaker 7.0 Help > Palettes > Hyperlinks


Comments or suggestions? Contact Adobe Developer Support
Copyright © 1997 - 2001 Adobe Systems Incorporated. All rights reserved.
Legal notices and trademark attributions