SetAnnotationColor(Int32,Byte,Byte,Byte,Byte) Method

In This Topic

Sets the color of a required annotation object specified by its index related to the currently selected page of the loaded PDF document.

This color is used for the following purposes:

The background of the annotation's icon when closed.
The title bar of the annotation's pop-up window.
The border of a link annotation.

This method uses the CMYK color space for specifying the required color.

Syntax

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

'Declaration
 
Public Overloads Function SetAnnotationColor( _
   ByVal AnnotationIdx As Integer, _
   ByVal Cyan As Byte, _
   ByVal Magenta As Byte, _
   ByVal Yellow As Byte, _
   ByVal Black As Byte _
) As GdPictureStatus

public GdPictureStatus SetAnnotationColor( 
   int AnnotationIdx,
   byte Cyan,
   byte Magenta,
   byte Yellow,
   byte Black
)

public function SetAnnotationColor( 
    AnnotationIdx: Integer;
    Cyan: Byte;
    Magenta: Byte;
    Yellow: Byte;
    Black: Byte
): GdPictureStatus;

public function SetAnnotationColor( 
   AnnotationIdx : int,
   Cyan : byte,
   Magenta : byte,
   Yellow : byte,
   Black : byte
) : GdPictureStatus;

public: GdPictureStatus SetAnnotationColor( 
   int AnnotationIdx,
   byte Cyan,
   byte Magenta,
   byte Yellow,
   byte Black
)

public:
GdPictureStatus SetAnnotationColor( 
   int AnnotationIdx,
   byte Cyan,
   byte Magenta,
   byte Yellow,
   byte Black
)

Parameters

AnnotationIdx: The 0-based index of the required annotation within the current page. It must be a value from 0 to GetAnnotationCount-1.
Cyan: The amount of cyan color to be used for the resulting color. Use the value between 0 and 255.
Magenta: The amount of magenta color to be used for the resulting color. Use the value between 0 and 255.
Yellow: The amount of yellow color to be used for the resulting color. Use the value between 0 and 255.
Black: The amount of black color to be used for the resulting color. Use the value between 0 and 255.

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 (background) color of all annotations in the loaded PDF document.

VB.NET
C#

Dim caption As String = "Example: SetAnnotationColor"
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
                        status = gdpicturePDF.SetAnnotationColor(annotID, 0, 186, 255, 0)
                        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_color.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: SetAnnotationColor";
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++)
                    {
                        status = gdpicturePDF.SetAnnotationColor(annotID, 0, 186, 255, 0);
                        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_color.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();

Reference

GdPicturePDF Class
GdPicturePDF Members
Overload List
GetAnnotationCount Method
GetAnnotationSubType Method
GetAnnotationColor Method
GetAnnotationFillColor Method
SetAnnotationFillColor(Int32,Byte,Byte,Byte) Method