SetTitle Method (GdPicturePDF)

In This Topic

Sets up a new title of the currently loaded PDF document into the document information dictionary and into the document catalog's metadata as well.

If the loaded PDF document contains metadata stored in the Metadata entry in the document catalog, the newly specified Title property is synchronized with those metadata. That means, you will be able to see the changed value of this property using the Acrobat's Document Properties dialogue box.

Syntax

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

'Declaration

 

Public Sub SetTitle( _

   ByVal Title As String _

)

public void SetTitle( 

   string Title

)

public procedure SetTitle( 

    Title: String

);

public function SetTitle( 

   Title : String

);

public: void SetTitle( 

   string* Title

)

public:

void SetTitle( 

   String^ Title

)

Parameters

Title: A new value of the Title property as a string.

Remarks

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

It is recommend to use the GdPicturePDF.GetStat method to identify the specific reason for the method's failure, if any.

Just to remind you that the newly specified Title property is synchronized with existing metadata, if any are included in the loaded PDF document.

Example

How to set up a new title of the PDF document.

VB.NET
C#

Using gdpicturePDF As New GdPicturePDF()

    If gdpicturePDF.LoadFromFile("test.pdf", True) = GdPictureStatus.OK Then

        Dim title As String = gdpicturePDF.GetTitle()

        Dim status As GdPictureStatus = gdpicturePDF.GetStat()

        If status = GdPictureStatus.OK Then

            MessageBox.Show("The original title of this PDF is: " + title, "Example: SetTitle")

            gdpicturePDF.SetTitle("This is a new title.")

            status = gdpicturePDF.GetStat()

            If status = GdPictureStatus.OK Then

                If gdpicturePDF.SaveToFile("test.pdf") = GdPictureStatus.OK Then

                    title = gdpicturePDF.GetTitle()

                    If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                        MessageBox.Show("The new title of this PDF is: " + title, "Example: SetTitle")

                    End If

                Else

                    MessageBox.Show("The file can't be saved.", "Example: SetTitle")

                End If

            Else

                MessageBox.Show("The SetTitle() method has failed with the status: " + status.ToString(), "Example: SetTitle")

            End If

        Else

            MessageBox.Show("The GetTitle() method has failed with the status: " + status.ToString(), "Example: SetTitle")

        End If

    Else

        MessageBox.Show("The file can't be loaded.", "Example: SetTitle")

    End If

End Using

using (GdPicturePDF gdpicturePDF = new GdPicturePDF())

{

    if (gdpicturePDF.LoadFromFile("test.pdf", true) == GdPictureStatus.OK)

    {

        string title = gdpicturePDF.GetTitle();

        GdPictureStatus status = gdpicturePDF.GetStat();

        if (status == GdPictureStatus.OK)

        {

            MessageBox.Show("The original title of this PDF is: " + title, "Example: SetTitle");

            gdpicturePDF.SetTitle("This is a new title.");

            status = gdpicturePDF.GetStat();

            if (status == GdPictureStatus.OK)

            {

                if (gdpicturePDF.SaveToFile("test.pdf") == GdPictureStatus.OK)

                {

                    title = gdpicturePDF.GetTitle();

                    if (gdpicturePDF.GetStat() == GdPictureStatus.OK)

                    {

                        MessageBox.Show("The new title of this PDF is: " + title, "Example: SetTitle");

                    }

                }

                else

                {

                    MessageBox.Show("The file can't be saved.", "Example: SetTitle");

                }

            }

            else

            {

                MessageBox.Show("The SetTitle() method has failed with the status: " + status.ToString(), "Example: SetTitle");

            }

        }

        else

        {

            MessageBox.Show("The GetTitle() method has failed with the status: " + status.ToString(), "Example: SetTitle");

        }

    }

    else

    {

        MessageBox.Show("The file can't be loaded.", "Example: SetTitle");

    }

}

Example

How to set up a new title of the PDF document. Using gdpicturePDF As New GdPicturePDF() If gdpicturePDF.LoadFromFile("test.pdf", True) = GdPictureStatus.OK Then Dim title As String = gdpicturePDF.GetTitle() Dim status As GdPictureStatus = gdpicturePDF.GetStat() If status = GdPictureStatus.OK Then MessageBox.Show("The original title of this PDF is: " + title, "Example: SetTitle") gdpicturePDF.SetTitle("This is a new title.") status = gdpicturePDF.GetStat() If status = GdPictureStatus.OK Then If gdpicturePDF.SaveToFile("test.pdf") = GdPictureStatus.OK Then title = gdpicturePDF.GetTitle() If gdpicturePDF.GetStat() = GdPictureStatus.OK Then MessageBox.Show("The new title of this PDF is: " + title, "Example: SetTitle") End If Else MessageBox.Show("The file can't be saved.", "Example: SetTitle") End If Else MessageBox.Show("The SetTitle() method has failed with the status: " + status.ToString(), "Example: SetTitle") End If Else MessageBox.Show("The GetTitle() method has failed with the status: " + status.ToString(), "Example: SetTitle") End If Else MessageBox.Show("The file can't be loaded.", "Example: SetTitle") End If End Using using (GdPicturePDF gdpicturePDF = new GdPicturePDF()) { if (gdpicturePDF.LoadFromFile("test.pdf", true) == GdPictureStatus.OK) { string title = gdpicturePDF.GetTitle(); GdPictureStatus status = gdpicturePDF.GetStat(); if (status == GdPictureStatus.OK) { MessageBox.Show("The original title of this PDF is: " + title, "Example: SetTitle"); gdpicturePDF.SetTitle("This is a new title."); status = gdpicturePDF.GetStat(); if (status == GdPictureStatus.OK) { if (gdpicturePDF.SaveToFile("test.pdf") == GdPictureStatus.OK) { title = gdpicturePDF.GetTitle(); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) { MessageBox.Show("The new title of this PDF is: " + title, "Example: SetTitle"); } } else { MessageBox.Show("The file can't be saved.", "Example: SetTitle"); } } else { MessageBox.Show("The SetTitle() method has failed with the status: " + status.ToString(), "Example: SetTitle"); } } else { MessageBox.Show("The GetTitle() method has failed with the status: " + status.ToString(), "Example: SetTitle"); } } else { MessageBox.Show("The file can't be loaded.", "Example: SetTitle"); } }

Reference

GdPicturePDF Class
GdPicturePDF Members
GetStat Method
LoadFromFile Method
GetTitle Method
SaveToFile(String) Method
Dispose Method