DeletePagePrivateTag Method (GdPicturePDF)

In This Topic

Deletes a private tag linked to the currently selected page, previously defined by the SetPagePrivateTag method, specified by its name.

Syntax

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

'Declaration
 
Public Function DeletePagePrivateTag( _
   ByVal Tag As String _
) As GdPictureStatus

public GdPictureStatus DeletePagePrivateTag( 
   string Tag
)

public function DeletePagePrivateTag( 
    Tag: String
): GdPictureStatus;

public function DeletePagePrivateTag( 
   Tag : String
) : GdPictureStatus;

public: GdPictureStatus DeletePagePrivateTag( 
   string* Tag
)

public:
GdPictureStatus DeletePagePrivateTag( 
   String^ Tag
)

Parameters

Tag: The name of the private page tag to delete, for example "Origin".

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 delete the private tag named MyTag linked to each page of your document.

VB.NET
C#

Dim gdpicturePDF As New GdPicturePDF()
If gdpicturePDF.LoadFromFile("test.pdf", False) = GdPictureStatus.OK Then
    Dim count As Integer = gdpicturePDF.GetPageCount()
    Dim status As GdPictureStatus = gdpicturePDF.GetStat()
    If status = GdPictureStatus.OK Then
        Dim message As String = ""
        For i As Integer = 1 To count
            status = gdpicturePDF.SelectPage(i)
            If status = GdPictureStatus.OK Then
                status = gdpicturePDF.DeletePagePrivateTag("MyTag")
                If status = GdPictureStatus.OK Then
                    message = message + "The MyTag for the page nr." + i.ToString() + " has been successfully deleted." + vbCrLf
                Else
                    message = message + "The DeletePagePrivateTag() method has failed for the page nr." + i.ToString() + " with the status: " + status.ToString() + vbCrLf
                End If
            Else
                message = message + "The SelectPage() method has failed for the page nr." + i.ToString() + " with the status: " + status.ToString() + vbCrLf
            End If
        Next
        If gdpicturePDF.SaveToFile("test_DeletePagePrivateTag.pdf") = GdPictureStatus.OK Then
            message = message + "The file has been saved."
        Else
            message = message + "The file can't be saved."
        End If
        MessageBox.Show(message, "Example: DeletePagePrivateTag")
    Else
        MessageBox.Show("The GetPageCount() method has failed with the status: " + status.ToString(), "Example: DeletePagePrivateTag")
    End If
Else
    MessageBox.Show("The file can't be loaded.", "Example: DeletePagePrivateTag")
End If
gdpicturePDF.Dispose()

GdPicturePDF gdpicturePDF = new GdPicturePDF();
if (gdpicturePDF.LoadFromFile("test.pdf", false) == GdPictureStatus.OK)
{
    int count = gdpicturePDF.GetPageCount();
    GdPictureStatus status = gdpicturePDF.GetStat();
    if (status == GdPictureStatus.OK)
    {
        string message = "";
        for (int i = 1; i <= count; i++)
        {
            status = gdpicturePDF.SelectPage(i);
            if (status == GdPictureStatus.OK)
            {
                status = gdpicturePDF.DeletePagePrivateTag("MyTag");
                if (status == GdPictureStatus.OK)
                    message = message + "The MyTag for the page nr." + i.ToString() + " has been successfully deleted.\n";
                else
                    message = message + "The DeletePagePrivateTag() method has failed for the page nr." + i.ToString() + " with the status: " + status.ToString() + "\n";
            }
            else
                message = message + "The SelectPage() method has failed for the page nr." + i.ToString() + " with the status: " + status.ToString() + "\n";
        }
        if (gdpicturePDF.SaveToFile("test_DeletePagePrivateTag.pdf") == GdPictureStatus.OK)
            message = message + "The file has been saved.";
        else
            message = message + "The file can't be saved.";
        MessageBox.Show(message, "Example: DeletePagePrivateTag");
    }
    else
        MessageBox.Show("The GetPageCount() method has failed with the status: " + status.ToString(), "Example: DeletePagePrivateTag");
}
else
    MessageBox.Show("The file can't be loaded.", "Example: DeletePagePrivateTag");
gdpicturePDF.Dispose();

Reference

GdPicturePDF Class
GdPicturePDF Members
GetPageCount Method
SelectPage Method
GetCurrentPage Method
SetPagePrivateTag Method
GetPagePrivateTag Method