Components for Developers
© 2000-2012, Two Pilots

PDF Library Download Features Manual Tutorials FAQ Pricing HTML2PDF-X Pilot History In the Lab

PDF Creator Pilot documentation

Download CHM version of this manual.
PDF page methods
PDFPAGE_Arc
PDFPAGE_Arc2
PDFPAGE_ArcTo
PDFPAGE_BeginText
PDFPAGE_CanvasCurrentPointX
PDFPAGE_CanvasCurrentPointY
PDFPAGE_CanvasOver
PDFPAGE_Circle
PDFPAGE_Clip
PDFPAGE_ClosePath
PDFPAGE_Comment
PDFPAGE_Concat
PDFPAGE_CurrentTextPositionX
PDFPAGE_CurrentTextPositionY
PDFPAGE_CurveTo
PDFPAGE_DrawWatermark
PDFPAGE_Ellipse
PDFPAGE_EndText
PDFPAGE_EoClip
PDFPAGE_EoFill
PDFPAGE_EoFillAndStroke
PDFPAGE_Fill
PDFPAGE_FillAndStroke
PDFPAGE_GetColorSpace
PDFPAGE_GetColorSpaceType
PDFPAGE_GetTextHeight
PDFPAGE_GetTextWidth
PDFPAGE_GetUnicodeTextHeight
PDFPAGE_GetUnicodeTextWidth
PDFPAGE_GStateRestore
PDFPAGE_GStateSave
PDFPAGE_Height
PDFPAGE_InPath
PDFPAGE_LineTo
PDFPAGE_MoveTo
PDFPAGE_NewPath
PDFPAGE_NoDash
PDFPAGE_Orientation
PDFPAGE_PageRotate
PDFPAGE_Pie
PDFPAGE_Pie2
PDFPAGE_PlayMetaFile
PDFPAGE_PlayMetaFileEx
PDFPAGE_PlayMetaFileExFromFileName
PDFPAGE_PlayMetaFileFromFileName
PDFPAGE_Rectangle
PDFPAGE_RectRotated
PDFPAGE_Resolution
PDFPAGE_Rotate
PDFPAGE_RotateText
PDFPAGE_RoundRect
PDFPAGE_Scale
PDFPAGE_SetActiveFont
PDFPAGE_SetCharacterSpacing
PDFPAGE_SetCMYKColor
PDFPAGE_SetCMYKColorFill
PDFPAGE_SetCMYKColorStroke
PDFPAGE_SetColor
PDFPAGE_SetColorFill
PDFPAGE_SetColorSpace
PDFPAGE_SetColorStroke
PDFPAGE_SetDash
PDFPAGE_SetDefaultCMYKColorSpace
PDFPAGE_SetDefaultGrayColorSpace
PDFPAGE_SetDefaultRGBColorSpace
PDFPAGE_SetFlat
PDFPAGE_SetGray
PDFPAGE_SetGrayFill
PDFPAGE_SetGrayStroke
PDFPAGE_SetHorizontalScaling
PDFPAGE_SetLineCap
PDFPAGE_SetLineJoin
PDFPAGE_SetLineWidth
PDFPAGE_SetLinkToPage
PDFPAGE_SetMiterLimit
PDFPAGE_SetPixel
PDFPAGE_SetRGBColor
PDFPAGE_SetRGBColorFill
PDFPAGE_SetRGBColorStroke
PDFPAGE_SetTextPosition
PDFPAGE_SetTextRenderingMode
PDFPAGE_SetTextRise
PDFPAGE_SetURL
PDFPAGE_SetWordSpacing
PDFPAGE_ShowImage
PDFPAGE_Size
PDFPAGE_SkewText
PDFPAGE_Stroke
PDFPAGE_TextBox
PDFPAGE_TextInitiated
PDFPAGE_TextOut
PDFPAGE_TextOutBox
PDFPAGE_TextOutBox2
PDFPAGE_TextShow
PDFPAGE_Thumbnail
PDFPAGE_Translate
PDFPAGE_UnicodeTextBox
PDFPAGE_UnicodeTextOut
PDFPAGE_UnicodeTextOutBox
PDFPAGE_UnicodeTextOutBox2
PDFPAGE_UnicodeTextShow
PDFPAGE_Watermark
PDFPAGE_Width
Collapse All

This method creates a hyperlink in a PDF document.

Syntax

HRESULT PDFPAGE_SetLinkToPage (
DOUBLE left,
DOUBLE bottom,
DOUBLE right,
DOUBLE top,
LONG pageIndex,
LONG topOffset
)
Parameters
left
X coordinate of the top-left corner of the bounding rectangle.

bottom
Y coordinate of the bottom-righ corner of the bounding rectangle.

right
X coordinate of the bottom-righ corner of the bounding rectangle.

top
Y coordinate of the top-left corner of the bounding rectangle.

pageIndex
Index (zero-based) of the existing page

topOffset
Offset from the top of the page.

Return value
If successful, this method returns S_OK. If it fails, this method should return one of the error values.

Remarks

This method places an active hyperlink area for the rectangle with left-top corner at (left, top) and right-bottom corner at (right, bottom). The destination is a page in the current PDF document with the pageIndex index. The topOffset parameter depends on the location of the display window for that page, offset from top of the page.

Equivalent in new interface: IPDFDocument4::AddLinkToPage.

Example

Linking to a Page

Delphi
[copy to clipboard]
{ PDF object is supposed to be created }
PDF.BeginDoc;
txt := 'Link to page''s bottom.';
for i := 1 to 3 do
begin
    PDF.PDFPAGE_SetActiveFont('Helvetica', false, false, false, false, 12.0, 0);
    r := 100 + PDF.PDFPAGE_GetTextWidth(txt);
    b := 100 + PDF.PDFPAGE_GetTextHeight(txt);
    PDF.PDFPAGE_TextOut(100, 100, 0.0, txt);
    PDF.PDFPAGE_Rectangle(100, 100, r, b);
    PDF.PDFPAGE_Stroke;
    PDF.PDFPAGE_SetLinkToPage(100, b, r, 100, PDF.PageNumber, 20);
    if i < 2 then do
      PDF.NewPage;
end;
PDF.EndDoc;
C/C++
[copy to clipboard]
// PDF object is supposed to be created
PDF->BeginDoc();
string txt = "Link to page's bottom.";
for (int i = 0; i < 3; i++)
{
    PDF->PDFPAGE_SetActiveFont("Helvetica", FALSE, FALSE, FALSE, FALSE, 12.0, 0);
    DOUBLE r = 100 + PDF->PDFPAGE_GetTextWidth(txt);
    DOUBLE b = 100 + PDF->PDFPAGE_GetTextHeight(txt);
    PDF->PDFPAGE_TextOut(100, 100, 0.0, txt);
    PDF->PDFPAGE_Rectangle(100, 100, r, b);
    PDF->PDFPAGE_Stroke();
    PDF->PDFPAGE_SetLinkToPage(100, b, r, 100, PDF.PageNumber, 20);
    if (i < 2)
      PDF->NewPage();
}
PDF->EndDoc();
C#
[copy to clipboard]
// PDF object is supposed to be created
PDF.BeginDoc();
string txt = "Link to page's bottom.";
for (int i = 0; i < 3; i++)
{
    PDF.PDFPAGE_SetActiveFont("Helvetica", false, false, false, false, 12.0, 0);
    double r = 100 + PDF.PDFPAGE_GetTextWidth(txt);
    double b = 100 + PDF.PDFPAGE_GetTextHeight(txt);
    PDF.PDFPAGE_TextOut(100, 100, 0.0, txt);
    PDF.PDFPAGE_Rectangle(100, 100, r, b);
    PDF.PDFPAGE_Stroke();
    PDF.PDFPAGE_SetLinkToPage(100, b, r, 100, PDF.PageNumber, 20);
    if (i < 2)
      PDF.NewPage();
}
PDF.EndDoc();
Visual Basic
[copy to clipboard]
' PDF object is supposed to be created
PDF.BeginDoc
txt = "Link to page's bottom."
For i=1 To 3
    PDF.PDFPAGE_SetActiveFont "Helvetica", False, False, False, False, 12.0, 0
    r = 100 + PDF.PDFPAGE_GetTextWidth(txt)
    b = 100 + PDF.PDFPAGE_GetTextHeight(txt)
    PDF.PDFPAGE_TextOut 100, 100, 0.0, txt
    PDF.PDFPAGE_Rectangle 100, 100, r, b
    PDF.PDFPAGE_Stroke
    PDF.PDFPAGE_SetLinkToPage 100, b, r, 100, PDF.PageNumber, 20
    If i<3 Then PDF.NewPage
Next
PDF.EndDoc

See Also

PDF Library Download Features Manual Tutorials FAQ Pricing HTML2PDF-X Pilot History In the Lab

 

 

PDF Library | Virtual Printer | Converters to PDF

Support | Blog | Forum | Contacts

© 2000-2012, Two Pilots