GdPicture.NET.14
GdPicture14 Namespace / GdPicturePDF Class / SetAnnotationContents Method
The 0-based index of the required annotation within the current page. It must be a value from 0 to GetAnnotationCount-1.
The new content of the specified annotation object in a meaning described in the Summary section.
Example





In This Topic
SetAnnotationContents Method (GdPicturePDF)
In This Topic
Sets the content (text or description) of a required annotation object specified by its index related to the currently selected page of the loaded PDF document.

It can be displayed text for the annotations, that support displaying text (like free text annotations) or an additional description for the other annotations in readable form. If the specified annotation is associated with an auxiliary pop-up window, it is the content of this pop-up window.

Syntax
'Declaration
 
Public Function SetAnnotationContents( _
   ByVal AnnotationIdx As Integer, _
   ByVal Contents As String _
) As GdPictureStatus
public GdPictureStatus SetAnnotationContents( 
   int AnnotationIdx,
   string Contents
)
public function SetAnnotationContents( 
    AnnotationIdx: Integer;
    Contents: String
): GdPictureStatus; 
public function SetAnnotationContents( 
   AnnotationIdx : int,
   Contents : String
) : GdPictureStatus;
public: GdPictureStatus SetAnnotationContents( 
   int AnnotationIdx,
   string* Contents
) 
public:
GdPictureStatus SetAnnotationContents( 
   int AnnotationIdx,
   String^ Contents
) 

Parameters

AnnotationIdx
The 0-based index of the required annotation within the current page. It must be a value from 0 to GetAnnotationCount-1.
Contents
The new content of the specified annotation object in a meaning described in the Summary section.

Return Value

A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK.

We strongly recommend always checking this status first.

Remarks
This method is only allowed for use with non-encrypted documents.

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

Example
How to change the content of all annotations in the loaded PDF document.
Dim caption As String = "Example: SetAnnotationContents"
Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF()
If gdpicturePDF.LoadFromFile("test.pdf", False) = GdPictureStatus.OK Then
    Dim pageCount As Integer = gdpicturePDF.GetPageCount()
    If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
        Dim message As String = ""
        Dim status As GdPictureStatus = GdPictureStatus.OK
        For page As Integer = 1 To pageCount
            message = message + "Page nr." + page.ToString()
            status = gdpicturePDF.SelectPage(page)
            If status = GdPictureStatus.OK Then
                Dim annotCount As Integer = gdpicturePDF.GetAnnotationCount()
                status = gdpicturePDF.GetStat()
                If status = GdPictureStatus.OK Then
                    message = message + "  Annots: " + annotCount.ToString()
                    Dim content As String = ""
                    For annotID As Integer = 0 To annotCount - 1
                        content = gdpicturePDF.GetAnnotationContents(annotID)
                        status = gdpicturePDF.SetAnnotationContents(annotID, content + vbCrLf + "Added by GdPicture/Orpalis.")
                        If status <> GdPictureStatus.OK Then Exit For
                    Next
                    message = message + "  status: " + status.ToString()
                Else
                    message = message + "GetAnnotationCount - status: " + status.ToString()
                End If
            Else
                message = message + "SelectPage - status: " + status.ToString()
            End If
            message += vbCrLf
        Next
        If gdpicturePDF.SaveToFile("test_content.pdf") = GdPictureStatus.OK Then
            message = message + "The file has been saved."
        Else
            message = message + "The file can't be saved. Status: " + gdpicturePDF.GetStat().ToString()
        End If
        MessageBox.Show(message, caption)
    Else
        MessageBox.Show("The GetPageCount() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
    End If
Else
    MessageBox.Show("The file can't be loaded.", caption)
End If
gdpicturePDF.Dispose()
string caption = "Example: SetAnnotationContents";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
if (gdpicturePDF.LoadFromFile("test.pdf", false) == GdPictureStatus.OK)
{
    int pageCount = gdpicturePDF.GetPageCount();
    if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
    {
        string message = "";
        GdPictureStatus status = GdPictureStatus.OK;
        for (int page = 1; page <= pageCount; page++)
        {
            message = message + "Page nr." + page.ToString();
            status = gdpicturePDF.SelectPage(page);
            if (status == GdPictureStatus.OK)
            {
                int annotCount = gdpicturePDF.GetAnnotationCount();
                status = gdpicturePDF.GetStat();
                if (status == GdPictureStatus.OK)
                {
                    message = message + "  Annots: " + annotCount.ToString();
                    string content = "";
                    for (int annotID = 0; annotID < annotCount; annotID++)
                    {
                        content = gdpicturePDF.GetAnnotationContents(annotID);
                        status = gdpicturePDF.SetAnnotationContents(annotID, content + "\nAdded by GdPicture/Orpalis.");
                        if (status != GdPictureStatus.OK) break;
                    }
                    message = message + "  status: " + status.ToString();
                }
                else
                    message = message + "GetAnnotationCount - status: " + status.ToString();
            }
            else
                message = message + "SelectPage - status: " + status.ToString();
            message += "\n";
        }
        if (gdpicturePDF.SaveToFile("test_content.pdf") == GdPictureStatus.OK)
            message = message + "The file has been saved.";
        else
            message = message + "The file can't be saved. Status: " + gdpicturePDF.GetStat().ToString();
        MessageBox.Show(message, caption);
    }
    else
        MessageBox.Show("The GetPageCount() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
}
else
    MessageBox.Show("The file can't be loaded.", caption);
gdpicturePDF.Dispose();
See Also