SetSubject Method (GdPicturePDF)

In This Topic

Sets up a new subject of the currently loaded PDF document into the document information dictionary and in 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 Subject 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 SetSubject( _
   ByVal Subject As String _
)

public void SetSubject( 
   string Subject
)

public procedure SetSubject( 
    Subject: String
);

public function SetSubject( 
   Subject : String
);

public: void SetSubject( 
   string* Subject
)

public:
void SetSubject( 
   String^ Subject
)

Parameters

Subject: A new value of the Subject 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 Subject property is synchronized with existing metadata, if any are included in the loaded PDF document.

Example

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

VB.NET
C#

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

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

Reference

GdPicturePDF Class
GdPicturePDF Members
LoadFromFile Method
GetSubject Method
SaveToFile(String) Method
Dispose Method