Each of the desired conversion modes for the links is set separately for the document, view and databank links using the function N2PDFSetOption. These settings apply only to links which are taken directly from Notes documents.
You can choose from the following function parameters:
N2PDFOPTION_NOTES_LINK_DOC_MODE |
Conversion mode for links to documents |
N2PDFOPTION_NOTES_LINK_VIEW_MODE |
Conversion mode for links to views |
N2PDFOPTION_NOTES_LINK_DB_MODE |
Conversion mode for links to databases |
The value <OptionStr> sets the mode for the conversion when activating the function. The following modes are available:
N2PDFVALUE_NOTES_LINK_MODE_NONE |
The PDF file accepts no links. All links to documents, views and databases are eliminated. |
N2PDFVALUE_NOTES_LINK_MODE_IMAGE |
The PDF file accepts all links in the form of graphic symbols (as in Notes). These links are not clickable. |
N2PDFVALUE_NOTES_LINK_MODE_IMAGE_LINK |
The PDF file accepts all links in the form of graphic symbols (as in Notes). These links are clickable and make the associated jumps. |
N2PDFVALUE_NOTES_LINK_MODE_IMAGE_NDL |
The PDF file accepts all links in the form of graphic symbols (as in Notes). These links are clickable and execute jumps (outside the PDF file) to the relevant original targets. |
N2PDFVALUE_NOTES_LINK_MODE_TEXT |
The PDF accepts all links as text tags. These links are not clickable. Defining text tags is discussed further on in this document. |
N2PDFVALUE_NOTES_LINK_MODE_TEXT_LINK |
The PDF accepts all links as text tags. These links are clickable. Defining text tags is discussed further on in this document. |
N2PDFOPTION_NOTES_LINK_DOC_INTERNAL
With these parameters, you can force the creation of internal jump markers (inside the PDF file) provided that the targets for this jump are located inside the document. This option is associated with the option N2PDFVALUE_NOTES_LINK_MODE_IMAGE_NDL which links all jumps externally.
N2PDFVALUE_TRUE |
Enabling of internal jump markers for achievable objectives |
N2PDFVALUE_FALSE |
no internal jump markers |
Example for accepting document links as clickable graphics in the PDF file:
Call N2PDFSetOption ( JobID, N2PDFOPTION_NOTES_LINK_DOC_MODE,_
N2PDFVALUE_NOTES_LINK_MODE_IMAGE_LINK, "" )
Example for disabling database links in the PDF file:
Call N2PDFSetOption ( JobID, N2PDFOPTION_NOTES_LINK_DB_MODE,_
N2PDFVALUE_NOTES_LINK_MODE_NONE, "" )
Text tags
If links are included in the PDF file, they can be displayed as text (except NDL links), as well as icons. You have the possibility to use the command N2PDFSetOption with the following parameters, to define a text tag which is then included in the PDF file in place of the link:
N2PDFOPTION_NOTES_LINK_DOC_TEXT_TAG
N2PDFOPTION_NOTES_LINK_VIEW_TEXT_TAG
N2PDFOPTION_NOTES_LINK_DB_TEXT_TAG
Example for a document link to be displayed as a clickable text tag with the value "(LINK)":
Call N2PDFSetOption ( JobID, N2PDFOPTION_NOTES_LINK_DOC_MODE,_
N2PDFVALUE_NOTES_LINK_MODE_Text_LINK, "" )
Call N2PDFSetOption ( JobID, N2PDFOPTION_NOTES_LINK_DOC_Text_TAG,_
"(LINK)" , "" )
Defining URLs for External Links
Links to views or databases are converted to URLs. You can both designate the basis, or host name, for such URLs along with the syntax for how the URL will be set up. You can make these two configurations separately for any type of link.
You can even convert document links to "external links" the same way. By default, document links are made as "internal links", but can be turned into "external links" by designating a host name and URL syntax.
The host name and URL syntax is set using the function N2PDFSetOption with the following parameters:
Host name:
N2PDFOPTION_NOTES_LINK_DOC_HOST
N2PDFOPTION_NOTES_LINK_VIEW_HOST
N2PDFOPTION_NOTES_LINK_DB_HOST
URL syntax:
N2PDFOPTION_NOTES_LINK_DOC_COMMAND
N2PDFOPTION_NOTES_LINK_VIEW_COMMAND
N2PDFOPTION_NOTES_LINK_DB_COMMAND
You can choose from variables that contain information about the link when defining the URL:
%DOC = Document ID
%DB = Database ID
%VIEW = View ID
|
Please keep in mind that not all variables are filled for all types of links. The view link, for example, has no document ID. |
Example for an external document link:
Call N2PDFSetOption ( JobID, N2PDFOPTION_NOTES_LINK_DOC_HOST,_
"http://www.n2pdf.com" , "" )
Call N2PDFSetOption ( JobID, N2PDFOPTION_NOTES_LINK_DOC_COMMAND,_
"/%DB/%VIEW/%DOC?OpenDocument" , "" )
Example for an external database link on a local host (e.g. intranet):
Call N2PDFSetOption ( JobID, N2PDFOPTION_NOTES_LINK_DB_HOST,_
"http://localhost" , "" )
Call N2PDFSetOption ( JobID, N2PDFOPTION_NOTES_LINK_DB_COMMAND,_
"/%DB?OpenDatabase" , "" )