SetFormFieldBackgroundColor(Int32,Byte,Byte,Byte) Method

In This Topic

Sets the background (fill) color of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. This method uses the RGB color space for specifying the required color.

Please use this method right after adding the required form field on the page, as the form field's background (fill) color attribute is not assigned automatically. Otherwise, the form field may display invisible.

Syntax

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

'Declaration
 
Public Overloads Function SetFormFieldBackgroundColor( _
   ByVal FieldId As Integer, _
   ByVal Red As Byte, _
   ByVal Green As Byte, _
   ByVal Blue As Byte _
) As GdPictureStatus

public GdPictureStatus SetFormFieldBackgroundColor( 
   int FieldId,
   byte Red,
   byte Green,
   byte Blue
)

public function SetFormFieldBackgroundColor( 
    FieldId: Integer;
    Red: Byte;
    Green: Byte;
    Blue: Byte
): GdPictureStatus;

public function SetFormFieldBackgroundColor( 
   FieldId : int,
   Red : byte,
   Green : byte,
   Blue : byte
) : GdPictureStatus;

public: GdPictureStatus SetFormFieldBackgroundColor( 
   int FieldId,
   byte Red,
   byte Green,
   byte Blue
)

public:
GdPictureStatus SetFormFieldBackgroundColor( 
   int FieldId,
   byte Red,
   byte Green,
   byte Blue
)

Parameters

FieldId: A unique form field identifier specifying a required form field object. You can obtain this identifier using methods like GetFormFieldId, GetFormFieldChildID or methods intended to add form fields.
Red: The amount of red color to be used for the resulting color. Use the value between 0 and 255.
Green: The amount of green color to be used for the resulting color. Use the value between 0 and 255.
Blue: The amount of blue 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 remind you, that the form field's background (fill) color attribute is not assigned automatically when creating the form field.

Example

How to specify the background color for the newly added text form field.

VB.NET
C#

Dim caption As String = "Example: SetFormFieldBackgroundColor"
Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF()
If (gdpicturePDF.NewPDF() = GdPictureStatus.OK) AndAlso
   (gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) = GdPictureStatus.OK) Then
    gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft)
    gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitCentimeter)
    'Please always select the required page before adding a form field.
    If gdpicturePDF.SelectPage(1) = GdPictureStatus.OK Then
        Dim fontResName As String = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontHelvetica)
        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
            If (gdpicturePDF.SetTextSize(16) = GdPictureStatus.OK) AndAlso
                (gdpicturePDF.DrawText(fontResName, 1, 1, "Write your story here ...") = GdPictureStatus.OK) Then
                Dim formID As Integer = gdpicturePDF.AddTextFormField(1, 2, 19, 15, "TextField_Story", "", False, fontResName, 16, 165, 42, 42)
                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                    If (gdpicturePDF.SetFormFieldBackgroundColor(formID, 173, 216, 230) = GdPictureStatus.OK) AndAlso
                       (gdpicturePDF.SetFormFieldBorderColor(formID, 0, 0, 139) = GdPictureStatus.OK) AndAlso
                       (gdpicturePDF.SetFormFieldTextAlignment(formID, TextAlignment.TextAlignmentNear) = GdPictureStatus.OK) AndAlso
                       (gdpicturePDF.SetFormFieldMultiLine(formID, True) = GdPictureStatus.OK) Then
                        Dim message As String = "The text form field has been created."
                        If gdpicturePDF.SaveToFile("forms_textfield.pdf") = GdPictureStatus.OK Then
                            message = message + vbCrLf + "The file has been saved successfully."
                        Else
                            message = message + vbCrLf + "The file can't be saved. Status: " + gdpicturePDF.GetStat().ToString()
                        End If
                        MessageBox.Show(message, caption)
                    Else
                        MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
                    End If
                Else
                    MessageBox.Show("The AddTextFormField() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
                End If
            Else
                MessageBox.Show("The SetTextSize()/DrawText() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
            End If
        Else
            MessageBox.Show("The AddStandardFont() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
        End If
    Else
        MessageBox.Show("The SelectPage() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
    End If
Else
    MessageBox.Show("The file can't be created.", caption)
End If
gdpicturePDF.Dispose()

string caption = "Example: SetFormFieldBackgroundColor";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
if ((gdpicturePDF.NewPDF() == GdPictureStatus.OK) &&
    (gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) == GdPictureStatus.OK))
{
    gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft);
    gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitCentimeter);
    //Please always select the required page before adding a form field.
    if (gdpicturePDF.SelectPage(1) == GdPictureStatus.OK)
    {
        string fontResName = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontHelvetica);
        if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
        {
            if ((gdpicturePDF.SetTextSize(16) == GdPictureStatus.OK) &&
                (gdpicturePDF.DrawText(fontResName, 1, 1, "Write your story here ...") == GdPictureStatus.OK))
            {
                int formID = gdpicturePDF.AddTextFormField(1, 2, 19, 15, "TextField_Story", "", false, fontResName, 16, 165, 42, 42);
                if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
                {
                    if ((gdpicturePDF.SetFormFieldBackgroundColor(formID, 173, 216, 230) == GdPictureStatus.OK) &&
                        (gdpicturePDF.SetFormFieldBorderColor(formID, 0, 0, 139) == GdPictureStatus.OK) &&
                        (gdpicturePDF.SetFormFieldTextAlignment(formID, TextAlignment.TextAlignmentNear) == GdPictureStatus.OK) &&
                        (gdpicturePDF.SetFormFieldMultiLine(formID, true) == GdPictureStatus.OK))
                    {
                        string message = "The text form field has been created.";
                        if (gdpicturePDF.SaveToFile("forms_textfield.pdf") == GdPictureStatus.OK)
                            message = message + "\nThe file has been saved successfully.";
                        else
                            message = message + "\nThe file can't be saved. Status: " + gdpicturePDF.GetStat().ToString();
                        MessageBox.Show(message, caption);
                    }
                    else
                        MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
                }
                else
                    MessageBox.Show("The AddTextFormField() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
            }
            else
                MessageBox.Show("The SetTextSize()/DrawText() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
        }
        else
            MessageBox.Show("The AddStandardFont() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
    }
    else
        MessageBox.Show("The SelectPage() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
}
else
    MessageBox.Show("The file can't be created.", caption);
gdpicturePDF.Dispose();

Reference

GdPicturePDF Class
GdPicturePDF Members
Overload List
FormFieldHasBackgroundColor(Int32) Method
SetFormFieldNoBackgroundColor(Int32) Method
GetFormFieldBackgroundColor(Int32) Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
AddTextFormField(Single,Single,Single,Single,String,String,Boolean,String,Single,Byte,Byte,Byte) Method
AddPushButtonFormField(Single,Single,Single,Single,String,String,String,Single,Byte,Byte,Byte) Method