GetSubject Method (GdPicturePDF)

In This Topic

Returns the subject 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 GetSubject() As String

public string GetSubject()

public function GetSubject(): String;

public function GetSubject() : String;

public: string* GetSubject();

public:
String^ GetSubject();

Return Value

The value of the document's Subject 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 subject of the PDF document.

VB.NET
C#

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

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

Reference

GdPicturePDF Class
GdPicturePDF Members
LoadFromFile Method
SetSubject Method
GetAuthor Method
GetTitle Method