GdPicture.NET.14~GdPicture14.GdPicturePDF~GetTitle - GetTitle Method (GdPicturePDF) -

GetTitle Method (GdPicturePDF)

In This Topic

Returns the title of the currently loaded PDF document, if any is set in the document information dictionary.

Syntax

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

'Declaration
 
Public Function GetTitle() As String

public string GetTitle()

public function GetTitle(): String;

public function GetTitle() : String;

public: string* GetTitle();

public:
String^ GetTitle();

Return Value

The value of the document's Title property as a string. The GdPicturePDF.GetStat method can be subsequently used to determine if this method has been successful.

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.

Example

How to find out the title of the PDF document.

VB.NET
C#

Using gdpicturePDF As New GdPicturePDF()
    If gdpicturePDF.LoadFromFile("test.pdf", False) = GdPictureStatus.OK Then
        Dim title As String = gdpicturePDF.GetTitle()
        Dim status As GdPictureStatus = gdpicturePDF.GetStat()
        If status = GdPictureStatus.OK Then
            MessageBox.Show("The title of this PDF is: " + title, "Example: GetTitle")
        Else
            MessageBox.Show("The GetTitle() method has failed with the status: " + status.ToString(), "Example: GetTitle")
        End If
    Else
        MessageBox.Show("The file can't be loaded.", "Example: GetTitle")
    End If
End Using

using (GdPicturePDF gdpicturePDF = new GdPicturePDF())
{
    if (gdpicturePDF.LoadFromFile("test.pdf", false) == GdPictureStatus.OK)
    {
        string title = gdpicturePDF.GetTitle();
        GdPictureStatus status = gdpicturePDF.GetStat();
        if (status == GdPictureStatus.OK)
        {
            MessageBox.Show("The title of this PDF is: " + title, "Example: GetTitle");
        }
        else
        {
            MessageBox.Show("The GetTitle() method has failed with the status: " + status.ToString(), "Example: GetTitle");
        }
    }
    else
    {
        MessageBox.Show("The file can't be loaded.", "Example: GetTitle");
    }
}

Example

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

Reference

GdPicturePDF Class
GdPicturePDF Members
GetStat Method
GetStat Method
LoadFromFile Method
SetTitle Method
GetAuthor Method
GetSubject Method