BCL easyPDF SDK
easyPDF SDK Usermanual
PDF Creator Programming API  |  Download Free Trial  |  Contact Us to Purchase

AppendBookmark Method

Append a bookmark to a PDF file.

void AppendBookmark(string InputFileName,
                    string OutputFileName,
                    string Title,
                    int Depth,
                    int Page,
                    prcZoomType Zoom,
                    bool Expanded)

Sub AppendBookmark(InputFileName As String, _
                   OutputFileName As String, _
                   Title As String, _
                   Depth As Integer, _
                   Page As Integer, _
                   Zoom As prcZoomType, _
                   Expanded As Boolean)

def AppendBookmark(self,
                   InputFileName,
                   OutputFileName,
                   Title,
                   Depth,
                   Page,
                   Zoom,
                   Expanded)
void AppendBookmark(String InputFileName,
                    String OutputFileName,
                    String Title,
                    int Depth,
                    int Page,
                    prcZoomType Zoom,
                    boolean Expanded) throws PDFProcessorException

function AppendBookmark($InputFileName,
                        $OutputFileName,
                        $Title,
                        $Depth,
                        $Page,
                        $Zoom,
                        $Expanded) 

BclPrcResult AppendBookmark(const BclPDFProcessorSettings* pSettings,
                            const wchar_t* InputFileName,
                            const wchar_t* OutputFileName,
                            const wchar_t* Title,
                            int Depth,
                            int Page,
                            BclPrcZoomType Zoom,
                            BclBool Expanded);
Sub AppendBookmark(InputFileName As String, _
                   OutputFileName As String, _
                   Title As String, _
                   Depth As Long, _
                   Page As Long, _
                   Zoom As prcZoomType, _
                   Expanded As Boolean)

bepproc +Bookmark -caption <string>
                  [-depth <int>]
                  [-page <int>]
                  [-zoom actual|fitPage|fitHeight|fitWidth|inherit]
                  [-expanded [on|off]]



Parameters

Return Values

N/A.

Remarks

  1. The bookmark depth uses zero-based index, meaning that depth starts from 0.
  2. The page number uses zero-based index, meaning that page number starts from 0.

Example Usage

Set oProcessor = CreateObject("easyPDF.PDFProcessor.8")
 
oProcessor.AppendBookmark "C:\test\input.pdf", _
                          "C:\test\output.pdf", _
                          "Depth 0 linking to first page", _
                          0, _
                          0, _
                          PRC_ZOOMTYPE_FIT_PAGE, _
                          True
 
oProcessor.AppendBookmark "C:\test\output.pdf", _
                          "C:\test\output.pdf", _
                          "Depth 1 linking to first page", _
                          1, _
                          0, _
                          PRC_ZOOMTYPE_FIT_PAGE, _
                          True