PdfGetTitle Method (GdViewer)

In This Topic

Returns the title of the currently displayed PDF document, if any is set in the document information dictionary. If the document currently displayed in the GdViewer control is not the PDF file, the method will fail.

Syntax

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

'Declaration
 
Public Function PdfGetTitle() As String

public string PdfGetTitle()

public function PdfGetTitle(): String;

public function PdfGetTitle() : String;

public: string* PdfGetTitle();

public:
String^ PdfGetTitle();

Return Value

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

Remarks

This method is only meaningful for PDF documents, otherwise it returns an empty string. It is recommend to use the GetStat method to identify the specific reason for the method's failure, if any.

Example

How to get the title of the displayed PDF document.

VB.NET
C#

'We assume that the GdViewer1 control has been properly integrated.
If GdViewer1.DisplayFromFile("") = GdPictureStatus.OK Then
    Dim message As String = "The current file is: " + GdViewer1.GetLastPath()
    If GdViewer1.GetDocumentType() = DocumentType.DocumentTypePDF Then
        message += vbCrLf + "Author: " + GdViewer1.PdfGetAuthor() +
                   vbCrLf + "Title: " + GdViewer1.PdfGetTitle() +
                   vbCrLf + "Subject: " + GdViewer1.PdfGetSubject() +
                   vbCrLf + "PDF Version: " + GdViewer1.PdfGetVersion()
    Else
        message += vbCrLf + "This file is not a PDF document, its format is: " + GdViewer1.GetDocumentType().ToString()
    End If
    MessageBox.Show(message, "GdViewer.PdfGetTitle")
Else
    MessageBox.Show("The file can't be loaded. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.PdfGetTitle")
End If

//We assume that the GdViewer1 control has been properly integrated.
if (GdViewer1.DisplayFromFile("") == GdPictureStatus.OK)
{
    string message = "The current file is: " + GdViewer1.GetLastPath();
    if (GdViewer1.GetDocumentType() == DocumentType.DocumentTypePDF)
    {
        message += "\nAuthor: " + GdViewer1.PdfGetAuthor() +
                   "\nTitle: " + GdViewer1.PdfGetTitle() +
                   "\nSubject: " + GdViewer1.PdfGetSubject() +
                   "\nPDF Version: " + GdViewer1.PdfGetVersion();
    }
    else
    {
        message += "\nThis file is not a PDF document, its format is: " + GdViewer1.GetDocumentType().ToString();
    }
    MessageBox.Show(message, "GdViewer.PdfGetTitle");
}
else
    MessageBox.Show("The file can't be loaded. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.PdfGetTitle");

Reference

GdViewer Class
GdViewer Members
GetLastPath Method
GetDocumentType Method
PdfGetSubject Method
PdfGetAuthor Method
PdfGetCreator Method
PdfGetProducer Method