MoveBookmarkDown Method (GdPicturePDF)

In This Topic

Moves a specified bookmark item down one item within the current level in the bookmark's hierarchy.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Function MoveBookmarkDown( _
   ByVal BookmarkID As Integer _
) As GdPictureStatus

public GdPictureStatus MoveBookmarkDown( 
   int BookmarkID
)

public function MoveBookmarkDown( 
    BookmarkID: Integer
): GdPictureStatus;

public function MoveBookmarkDown( 
   BookmarkID : int
) : GdPictureStatus;

public: GdPictureStatus MoveBookmarkDown( 
   int BookmarkID
)

public:
GdPictureStatus MoveBookmarkDown( 
   int BookmarkID
)

Parameters

BookmarkID: A unique bookmark identifier specifying a required bookmark object.
You can obtain this identifier using these methods: NewBookmark, GetBookmarkRootID, GetBookmarkFirstChildID, GetBookmarkNextID, GetBookmarkPrevID or GetBookmarkParentID.

Return Value

A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK.

We strongly recommend always checking this status first.

Remarks

This method is only allowed for use with non-encrypted documents.

Example

How to move the root bookmark item one item down on the same level. The root bookmark will "change" its position with its nearest sibling item.

VB.NET
C#

Dim caption As String = "Example: MoveBookmarkDown"
Dim gdpicturePDF As New GdPicturePDF()
Dim status As GdPictureStatus = gdpicturePDF.LoadFromFile("bookmarks.pdf", False)
If status = GdPictureStatus.OK Then
    Dim rootID As Integer = gdpicturePDF.GetBookmarkRootID()
    status = gdpicturePDF.GetStat()
    If status = GdPictureStatus.OK Then
        status = gdpicturePDF.MoveBookmarkDown(rootID)
        If status = GdPictureStatus.OK Then
            status = gdpicturePDF.SaveToFile("bookmarks_MoveDown.pdf", False)
            If status = GdPictureStatus.OK Then
                MessageBox.Show("The example has been followed successfully.", caption)
            Else
                MessageBox.Show("The file can't be saved. Status: " + status.ToString(), caption)
            End If
        Else
            MessageBox.Show("The MoveBookmarkDown() method has failed with the status: " + status.ToString(), caption)
        End If
    Else
        If status = GdPictureStatus.PropertyNotFound Then
            MessageBox.Show("This PDF document doesn't contain any bookmarks.", caption)
        Else
            MessageBox.Show("The GetBookmarkRootID() method has failed with the status: " + status.ToString(), caption)
        End If
    End If
Else
    MessageBox.Show("The file can't be loaded. Status: " + status.ToString(), caption)
End If
gdpicturePDF.Dispose()

string caption = "Example: MoveBookmarkDown";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
GdPictureStatus status = gdpicturePDF.LoadFromFile("bookmarks.pdf", false);
if (status == GdPictureStatus.OK)
{
    int rootID = gdpicturePDF.GetBookmarkRootID();
    status = gdpicturePDF.GetStat();
    if (status == GdPictureStatus.OK)
    {
        status = gdpicturePDF.MoveBookmarkDown(rootID);
        if (status == GdPictureStatus.OK)
        {
            status = gdpicturePDF.SaveToFile("bookmarks_MoveDown.pdf", false);
            if (status == GdPictureStatus.OK)
                MessageBox.Show("The example has been followed successfully.", caption);
            else
                MessageBox.Show("The file can't be saved. Status: " + status.ToString(), caption);
        }
        else
            MessageBox.Show("The MoveBookmarkDown() method has failed with the status: " + status.ToString(), caption);
    }
    else
    {
        if (status == GdPictureStatus.PropertyNotFound)
            MessageBox.Show("This PDF document doesn't contain any bookmarks.", caption);
        else
            MessageBox.Show("The GetBookmarkRootID() method has failed with the status: " + status.ToString(), caption);
    }
}
else
{
    MessageBox.Show("The file can't be loaded. Status: " + status.ToString(), caption);
}
gdpicturePDF.Dispose();

Reference

GdPicturePDF Class
GdPicturePDF Members
MoveBookmark Method
MoveBookmarkUp Method
NewBookmark Method
GetBookmarkCount Method
GetBookmarkRootID Method
GetBookmarkFirstChildID Method
GetBookmarkChildCount Method
GetBookmarkNextID Method
GetBookmarkPrevID Method
GetBookmarkParentID Method