GetAnnotationSubject Method (GdPicturePDF)

In This Topic

Returns the subject of a required annotation object specified by its index related to the currently selected page of the loaded PDF document. It is a short text description of the subject being addressed by the specified annotation.

Syntax

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

'Declaration
 
Public Function GetAnnotationSubject( _
   ByVal AnnotationIdx As Integer _
) As String

public string GetAnnotationSubject( 
   int AnnotationIdx
)

public function GetAnnotationSubject( 
    AnnotationIdx: Integer
): String;

public function GetAnnotationSubject( 
   AnnotationIdx : int
) : String;

public: string* GetAnnotationSubject( 
   int AnnotationIdx
)

public:
String^ GetAnnotationSubject( 
   int AnnotationIdx
)

Parameters

AnnotationIdx: The 0-based index of the required annotation within the current page. It must be a value from 0 to GetAnnotationCount-1.

Return Value

The subject of the specified annotation object. The 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 GetStat method to identify the specific reason for the method's failure, if any.

Please always ensure that you have selected the correct page using the SelectPage method before applying an annotation index.

Example

How to retrieve the title, the subject and the content of all text annotation objects within the PDF document.

VB.NET
C#

Dim caption As String = "Example: GetAnnotationSubject"
Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF()
Dim status As GdPictureStatus = gdpicturePDF.LoadFromFile("test.pdf", False)
If status = GdPictureStatus.OK Then
    Dim message As String = ""
    Dim pageCount As Integer = gdpicturePDF.GetPageCount()
    For i As Integer = 1 To pageCount
        status = gdpicturePDF.SelectPage(i)
        If status = GdPictureStatus.OK Then
            message = message + "The page nr." + i.ToString()
            Dim annotCount As Integer = gdpicturePDF.GetAnnotationCount()
            status = gdpicturePDF.GetStat()
            If status = GdPictureStatus.OK Then
                If annotCount = 0 Then
                    message = message + " does not contain any annotations."
                Else
                    Dim annotSubType As String = "", title As String = "", subject As String = "", content As String = ""
                    For j As Integer = 0 To annotCount - 1
                        annotSubType = gdpicturePDF.GetAnnotationSubType(j)
                        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                            If annotSubType.Equals("Text") Then
                                message = message + vbCrLf + "AnnotID: " + j.ToString()
                                message = message + vbCrLf + "    title: "
                                title = gdpicturePDF.GetAnnotationTitle(j)
                                status = gdpicturePDF.GetStat()
                                If status = GdPictureStatus.OK Then message = message + title Else message = message + status.ToString()
                                message = message + "    subject: "
                                subject = gdpicturePDF.GetAnnotationSubject(j)
                                status = gdpicturePDF.GetStat()
                                If status = GdPictureStatus.OK Then message = message + subject Else message = message + status.ToString()
                                message = message + "    content: "
                                content = gdpicturePDF.GetAnnotationContents(j)
                                status = gdpicturePDF.GetStat()
                                If status = GdPictureStatus.OK Then message = message + content Else message = message + status.ToString()
                            End If
                        Else
                            message = message + vbCrLf + "The GetAnnotationSubType() method has failed with the status: " + status.ToString()
                        End If
                    Next
                End If
            Else
                message = message + ": the GetAnnotationCount() method has failed with the status: " + status.ToString()
            End If
            message = message + vbCrLf
        Else
            message = message + "The SelectPage(" + i.ToString() + ") method has failed with the status: " + status.ToString() + vbCrLf
        End If
    Next
    MessageBox.Show(message, caption)
Else
    MessageBox.Show("The file can't be loaded.", caption)
End If
gdpicturePDF.Dispose()

string caption = "Example: GetAnnotationSubject";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
GdPictureStatus status = gdpicturePDF.LoadFromFile("test.pdf", false);
if (status == GdPictureStatus.OK)
{
    string message = "";
    int pageCount = gdpicturePDF.GetPageCount();
    for (int i = 1; i <= pageCount; i++)
    {
        status = gdpicturePDF.SelectPage(i);
        if (status == GdPictureStatus.OK)
        {
            message = message + "The page nr." + i.ToString();
            int annotCount = gdpicturePDF.GetAnnotationCount();
            status = gdpicturePDF.GetStat();
            if (status == GdPictureStatus.OK)
            {
                if (annotCount == 0)
                {
                    message = message + " does not contain any annotations.";
                }
                else
                {
                    string annotSubType = "", title = "", subject = "", content = "";
                    for (int j = 0; j < annotCount; j++)
                    {
                        annotSubType = gdpicturePDF.GetAnnotationSubType(j);
                        if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
                        {
                            if (annotSubType.Equals("Text"))
                            {
                                message = message + "\nAnnotID: " + j.ToString();
            
                                message = message + "\n    title: ";
                                title = gdpicturePDF.GetAnnotationTitle(j);
                                status = gdpicturePDF.GetStat();
                                if (status == GdPictureStatus.OK) message = message + title;
                                else message = message + status.ToString();
            
                                message = message + "    subject: ";
                                subject = gdpicturePDF.GetAnnotationSubject(j);
                                status = gdpicturePDF.GetStat();
                                if (status == GdPictureStatus.OK) message = message + subject;
                                else message = message + status.ToString();
            
                                message = message + "    content: ";
                                content = gdpicturePDF.GetAnnotationContents(j);
                                status = gdpicturePDF.GetStat();
                                if (status == GdPictureStatus.OK) message = message + content;
                                else message = message + status.ToString();
                            }
                        }
                        else
                        {
                            message = message + "\nThe GetAnnotationSubType() method has failed with the status: " + status.ToString();
                        }
                    }
                }
            }
            else
                message = message + ": the GetAnnotationCount() method has failed with the status: " + status.ToString();
            
            message = message + "\n";
        }
        else
            message = message + "The SelectPage(" + i.ToString() + ") method has failed with the status: " + status.ToString() + "\n";
    }
    MessageBox.Show(message, caption);
}
else
{
    MessageBox.Show("The file can't be loaded.", caption);
}
gdpicturePDF.Dispose();

Reference

GdPicturePDF Class
GdPicturePDF Members
GetAnnotationCount Method
GetAnnotationSubType Method
SetAnnotationSubject Method