The 0-based index of the required annotation within the current page. It must be a value from 0 to GdPicturePDF.GetAnnotationCount-1.
A bitwise combination of values of the PdfAnnotationFlag enumeration.
Example





In This Topic
GdPicture14 Namespace / GdPicturePDF Class / SetAnnotationFlags Method

SetAnnotationFlags Method (GdPicturePDF)

In This Topic
Sets the flags of a required annotation object specified by its index related to the currently selected page of the loaded PDF document. These flags define various characteristics of the specified annotation.
Syntax
'Declaration

 


Public Function SetAnnotationFlags( _

   ByVal AnnotationIdx As Integer, _

   ByVal Flags As PdfAnnotationFlag _

) As GdPictureStatus
public GdPictureStatus SetAnnotationFlags( 

   int AnnotationIdx,

   PdfAnnotationFlag Flags

)
public function SetAnnotationFlags( 

    AnnotationIdx: Integer;

    Flags: PdfAnnotationFlag

): GdPictureStatus; 
public function SetAnnotationFlags( 

   AnnotationIdx : int,

   Flags : PdfAnnotationFlag

) : GdPictureStatus;
public: GdPictureStatus SetAnnotationFlags( 

   int AnnotationIdx,

   PdfAnnotationFlag Flags

) 
public:

GdPictureStatus SetAnnotationFlags( 

   int AnnotationIdx,

   PdfAnnotationFlag Flags

)

Parameters

AnnotationIdx
The 0-based index of the required annotation within the current page. It must be a value from 0 to GdPicturePDF.GetAnnotationCount-1.
Flags
A bitwise combination of values of the PdfAnnotationFlag enumeration.

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 GdPicturePDF.SelectPage method before applying an annotation index.

Example
How to ensure that all annotations in the loaded PDF document will be printed. The example shows you how to set the annotation's flag for printing. 
Dim caption As String = "Example: SetAnnotationFlags"

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()

                    For annotID As Integer = 0 To annotCount - 1

                        Dim flags As PdfAnnotationFlag = gdpicturePDF.GetAnnotationFlags(annotID)

                        status = gdpicturePDF.GetStat()

                        If status = GdPictureStatus.OK Then

                            status = gdpicturePDF.SetAnnotationFlags(annotID, flags Or PdfAnnotationFlag.PdfAnnotationFlagPrint)

                        End If

                        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_flags.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: SetAnnotationFlags";

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();

                    for (int annotID = 0; annotID < annotCount; annotID++)

                    {

                        PdfAnnotationFlag flags = gdpicturePDF.GetAnnotationFlags(annotID);

                        status = gdpicturePDF.GetStat();

                        if (status == GdPictureStatus.OK)

                        {

                            status = gdpicturePDF.SetAnnotationFlags(annotID, flags | PdfAnnotationFlag.PdfAnnotationFlagPrint);

                        }

                        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_flags.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();
Example
How to ensure that all annotations in the loaded PDF document will be printed. The example shows you how to set the annotation's flag for printing. Dim caption As String = "Example: SetAnnotationFlags" 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() For annotID As Integer = 0 To annotCount - 1 Dim flags As PdfAnnotationFlag = gdpicturePDF.GetAnnotationFlags(annotID) status = gdpicturePDF.GetStat() If status = GdPictureStatus.OK Then status = gdpicturePDF.SetAnnotationFlags(annotID, flags Or PdfAnnotationFlag.PdfAnnotationFlagPrint) End If 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_flags.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: SetAnnotationFlags"; 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(); for (int annotID = 0; annotID < annotCount; annotID++) { PdfAnnotationFlag flags = gdpicturePDF.GetAnnotationFlags(annotID); status = gdpicturePDF.GetStat(); if (status == GdPictureStatus.OK) { status = gdpicturePDF.SetAnnotationFlags(annotID, flags | PdfAnnotationFlag.PdfAnnotationFlagPrint); } 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_flags.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

Reference

GdPicturePDF Class
GdPicturePDF Members
GetAnnotationCount Method
SelectPage Method
GetAnnotationCount Method
GetAnnotationSubType Method
GetAnnotationFlags Method