PGetHyperlinkInfo

This query retrieves information about a Hypercontent text token. The tokens are created either through the Hyperlink palette, imported HTML pages, or the Hypercontent manager (CHcmPlugInContentHandler::Create). This query is used to retrieve information about the text token that is required by the Hypercontent Manager, allowing you to test the token for hypercontent and to manipulate the hypercontent attached to the token.
For more information on Hypercontent, see the documentation for the Hypercontent Manager in HCMPlugs.html.


Query constructor

PGetHyperlinkInfo requires that the text cursor is in a text block (any text block that is a part of the story that contains the token.
Warning: This query will not return an error if the character at the position passed in is not a hypercontent token. The character should be checked first (the character is 0x12).

PGetHyperlinkInfo(const long tokenCharPos)
tokenCharPos:

The character position of the hypercontent text token. The character position is the number of characters from the beginning of the selected story, not the selected text block.

Query result

long		pageRefRID

This is an identifier for the token. The pageRefRID is used by the Hypercontent Manager.

short		pageRefType

This is the type of token selected, a list of all of the possible returns can be found in HCMDefs.h.




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