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.
Example





In This Topic
GdPicture14 Namespace / GdPicturePDF Class / SetFormFieldNoBorderColor Method / SetFormFieldNoBorderColor(Int32) Method

SetFormFieldNoBorderColor(Int32) Method

In This Topic
Removes the border color attribute 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. Be aware that the border color attribute becomes undefined using this method, which causes the form field border not to appear on the page.
Syntax
'Declaration

 

Public Overloads Function SetFormFieldNoBorderColor( _

   ByVal FieldId As Integer _

) As GdPictureStatus
public GdPictureStatus SetFormFieldNoBorderColor( 

   int FieldId

)
public function SetFormFieldNoBorderColor( 

    FieldId: Integer

): GdPictureStatus; 
public function SetFormFieldNoBorderColor( 

   FieldId : int

) : GdPictureStatus;
public: GdPictureStatus SetFormFieldNoBorderColor( 

   int FieldId

) 
public:

GdPictureStatus SetFormFieldNoBorderColor( 

   int FieldId

) 

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.

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.

Be aware that the border color attribute becomes undefined using this method.

Example
How to remove the border of all push buttons in the current document.
Dim caption As String = "Example: SetFormFieldNoBorderColor"

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 message As String = ""

        If count = 0 Then

            message = "This document does not contain any forms."

        Else

            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.PdfFormFieldTypePushButton Then

                            If gdpicturePDF.SetFormFieldNoBorderColor(formID) <> GdPictureStatus.OK Then

                                message = message + i.ToString() + ": The SetFormFieldNoBorderColor() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + vbCrLf

                            End If

                        End If

                    Else

                        message = message + i.ToString() + ": The GetFormFieldType() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + vbCrLf

                    End If

                Else

                    message = message + i.ToString() + ": The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + vbCrLf

                End If

            Next

        End If

        If message.Equals("") Then message = "The example has been followed successfully." + vbCrLf

        If gdpicturePDF.SaveToFile("forms_updated.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 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: SetFormFieldNoBorderColor";

GdPicturePDF gdpicturePDF = new GdPicturePDF();

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

{

    int count = gdpicturePDF.GetFormFieldsCount();

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

    {

        string message = "";

        if (count == 0)

            message = "This document does not contain any forms.";

        else

        {

            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.PdfFormFieldTypePushButton)

                        {

                            if (gdpicturePDF.SetFormFieldNoBorderColor(formID) != GdPictureStatus.OK)

                                message = message + i.ToString() + ": The SetFormFieldNoBorderColor() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + "\n";

                        }

                    }

                    else

                        message = message + i.ToString() + ": The GetFormFieldType() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + "\n";

                }

                else

                    message = message + i.ToString() + ": The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + "\n";

            }

            if (message.Equals("")) message = "The example has been followed successfully.\n";

            if (gdpicturePDF.SaveToFile("forms_updated.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 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