A unique form field identifier specifying a required form field object. You can obtain this identifier using methods like GdPicturePDF.GetFormFieldId, GdPicturePDF.GetFormFieldChildID or methods intended to add form fields.
The amount of cyan color to be used for the resulting color. Use the value between 0 and 255.
The amount of magenta color to be used for the resulting color. Use the value between 0 and 255.
The amount of yellow color to be used for the resulting color. Use the value between 0 and 255.
The amount of black color to be used for the resulting color. Use the value between 0 and 255.
Example





In This Topic
GdPicture14 Namespace / GdPicturePDF Class / SetFormFieldFontColor Method / SetFormFieldFontColor(Int32,Byte,Byte,Byte,Byte) Method

SetFormFieldFontColor(Int32,Byte,Byte,Byte,Byte) Method

In This Topic
Sets the color used to display text or the checkmark in a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. The usage of this attribute is not restricted to any form fields, even if the form field's appearance doesn't display text. In other words, you are allowed to set the color of the checkmark in a required form field using this method.

For further assistance, please refer to the PDF Reference, Section "Interactive Forms".

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

Syntax
'Declaration

 

Public Overloads Function SetFormFieldFontColor( _

   ByVal FieldId As Integer, _

   ByVal Cyan As Byte, _

   ByVal Magenta As Byte, _

   ByVal Yellow As Byte, _

   ByVal Black As Byte _

) As GdPictureStatus
public GdPictureStatus SetFormFieldFontColor( 

   int FieldId,

   byte Cyan,

   byte Magenta,

   byte Yellow,

   byte Black

)
public function SetFormFieldFontColor( 

    FieldId: Integer;

    Cyan: Byte;

    Magenta: Byte;

    Yellow: Byte;

    Black: Byte

): GdPictureStatus; 
public function SetFormFieldFontColor( 

   FieldId : int,

   Cyan : byte,

   Magenta : byte,

   Yellow : byte,

   Black : byte

) : GdPictureStatus;
public: GdPictureStatus SetFormFieldFontColor( 

   int FieldId,

   byte Cyan,

   byte Magenta,

   byte Yellow,

   byte Black

) 
public:

GdPictureStatus SetFormFieldFontColor( 

   int FieldId,

   byte Cyan,

   byte Magenta,

   byte Yellow,

   byte Black

) 

Parameters

FieldId
A unique form field identifier specifying a required form field object. You can obtain this identifier using methods like GdPicturePDF.GetFormFieldId, GdPicturePDF.GetFormFieldChildID or methods intended to add form fields.
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.

Just to inform you, that the attributes representing the font and its resources are defined for all form field objects by default. For further assistance, please refer to the PDF Reference, Section "Interactive Forms".

Example
How to change the font color for all text fields in the currently loaded PDF document.
Dim caption As String = "Example: SetFormFieldFontColor"

Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF()

If gdpicturePDF.LoadFromFile("forms.pdf", False) = GdPictureStatus.OK Then

    Dim count As Integer = gdpicturePDF.GetFormFieldsCount()

    If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

        Dim formID As Integer = 0

        Dim type As PdfFormFieldType = PdfFormFieldType.PdfFormFieldTypeUnknown

        For i As Integer = 0 To count - 1

            formID = gdpicturePDF.GetFormFieldId(i)

            If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                type = gdpicturePDF.GetFormFieldType(formID)

                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                    If type = PdfFormFieldType.PdfFormFieldTypeText Then

                        If gdpicturePDF.SetFormFieldFontColor(formID, 45, 150, 225, 45) <> GdPictureStatus.OK Then

                            MessageBox.Show("The SetFormFieldFontColor() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)

                            Exit For

                        End If

                    End If

                Else

                    MessageBox.Show("The GetFormFieldType() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)

                    Exit For

                End If

            Else

                MessageBox.Show("The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)

                Exit For

            End If

        Next

        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

            If count = 0 Then

                MessageBox.Show("This file doesn't include forms.", caption)

            Else

                If gdpicturePDF.SaveToFile("forms_updated.pdf") = GdPictureStatus.OK Then

                    MessageBox.Show("The example has been followed successfully and the file has been saved.", caption)

                Else

                    MessageBox.Show("The example has been followed successfully, but the file can't be saved.", caption)

                End If

            End If

        End If

    Else

        MessageBox.Show("The GetFormFieldsCount() 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: SetFormFieldFontColor";

GdPicturePDF gdpicturePDF = new GdPicturePDF();

if (gdpicturePDF.LoadFromFile("forms.pdf", false) == GdPictureStatus.OK)

{

    int count = gdpicturePDF.GetFormFieldsCount();

    if (gdpicturePDF.GetStat() == GdPictureStatus.OK)

    {

        int formID = 0;

        PdfFormFieldType type = PdfFormFieldType.PdfFormFieldTypeUnknown;

        for (int i = 0; i < count; i++)

        {

            formID = gdpicturePDF.GetFormFieldId(i);

            if (gdpicturePDF.GetStat() == GdPictureStatus.OK)

            {

                type = gdpicturePDF.GetFormFieldType(formID);

                if (gdpicturePDF.GetStat() == GdPictureStatus.OK)

                {

                    if (type == PdfFormFieldType.PdfFormFieldTypeText)

                    {

                        if (gdpicturePDF.SetFormFieldFontColor(formID, 45, 150, 225, 45) != GdPictureStatus.OK)

                        {

                            MessageBox.Show("The SetFormFieldFontColor() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);

                            break;

                        }

                    }

                }

                else

                {

                    MessageBox.Show("The GetFormFieldType() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);

                    break;

                }

            

            }

            else

            {

                MessageBox.Show("The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);

                break;

            }

        }

        if (gdpicturePDF.GetStat() == GdPictureStatus.OK)

        {

            if (count == 0)

                MessageBox.Show("This file doesn't include forms.", caption);

            else

            {

                if (gdpicturePDF.SaveToFile("forms_updated.pdf") == GdPictureStatus.OK)

                    MessageBox.Show("The example has been followed successfully and the file has been saved.", caption);

                else

                    MessageBox.Show("The example has been followed successfully, but the file can't be saved.", caption);

            }

        }

    }

    else

        MessageBox.Show("The GetFormFieldsCount() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);

}

else

    MessageBox.Show("The file can't be loaded.", caption);

gdpicturePDF.Dispose();
See Also