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 width of the line used to draw the form field's border, expressed in the current units specified by the SetMeasurementUnit method.
A member of the PdfAnnotationBorderStyle enumeration. The style of the line used to draw the form field's border.
If the style of the border's line (the BorderStyle parameter) is dashed, this value defines the width of the dashes in the dash pattern used to draw the border's line. Otherwise, this parameter is ignored. The value is expressed in the current units specified by the SetMeasurementUnit method.
If the style of the border's line (the BorderStyle parameter) is dashed, this value defines the width of the gaps in the dash pattern used to draw the border's line. Otherwise, this parameter is ignored. The value is expressed in the current units specified by the SetMeasurementUnit method.
Example





In This Topic
GdPicture14 Namespace / GdPicturePDF Class / SetFormFieldBorderStyle Method / SetFormFieldBorderStyle(Int32,Single,PdfAnnotationBorderStyle,Single,Single) Method

SetFormFieldBorderStyle(Int32,Single,PdfAnnotationBorderStyle,Single,Single) Method

In This Topic
Sets the style of the line used to draw the border 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.

The border's line dimensions need to be set in the current units defined in the PDF document. You can use the GdPicturePDF.GetMeasurementUnit method to determine the currently defined units and you can use the GdPicturePDF.SetMeasurementUnit method to reset the units according to your preference.

Syntax
'Declaration

 


Public Overloads Function SetFormFieldBorderStyle( _

   ByVal FieldId As Integer, _

   ByVal BorderWidth As Single, _

   ByVal BorderStyle As PdfAnnotationBorderStyle, _

   ByVal DashOn As Single, _

   ByVal DashOff As Single _

) As GdPictureStatus
public GdPictureStatus SetFormFieldBorderStyle( 

   int FieldId,

   float BorderWidth,

   PdfAnnotationBorderStyle BorderStyle,

   float DashOn,

   float DashOff

)
public function SetFormFieldBorderStyle( 

    FieldId: Integer;

    BorderWidth: Single;

    BorderStyle: PdfAnnotationBorderStyle;

    DashOn: Single;

    DashOff: Single

): GdPictureStatus; 
public function SetFormFieldBorderStyle( 

   FieldId : int,

   BorderWidth : float,

   BorderStyle : PdfAnnotationBorderStyle,

   DashOn : float,

   DashOff : float

) : GdPictureStatus;
public: GdPictureStatus SetFormFieldBorderStyle( 

   int FieldId,

   float BorderWidth,

   PdfAnnotationBorderStyle BorderStyle,

   float DashOn,

   float DashOff

) 
public:

GdPictureStatus SetFormFieldBorderStyle( 

   int FieldId,

   float BorderWidth,

   PdfAnnotationBorderStyle BorderStyle,

   float DashOn,

   float DashOff

)

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.
BorderWidth
The width of the line used to draw the form field's border, expressed in the current units specified by the SetMeasurementUnit method.
BorderStyle
A member of the PdfAnnotationBorderStyle enumeration. The style of the line used to draw the form field's border.
DashOn
If the style of the border's line (the BorderStyle parameter) is dashed, this value defines the width of the dashes in the dash pattern used to draw the border's line. Otherwise, this parameter is ignored. The value is expressed in the current units specified by the SetMeasurementUnit method.
DashOff
If the style of the border's line (the BorderStyle parameter) is dashed, this value defines the width of the gaps in the dash pattern used to draw the border's line. Otherwise, this parameter is ignored. The value is expressed in the current units specified by the SetMeasurementUnit method.

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, be aware that both DashOn and DashOff parameters are valid only if the specified value of the BorderStyle parameter is PdfAnnotationBorderStyle.PdfAnnotationBorderStyleDashed, otherwise they are ignored.

Just to remind you that the values of dimensions need to be set in the current units defined by the GdPicturePDF.SetMeasurementUnit method.

Example
How to set the dashed border for the newly added push button. 
Dim caption As String = "Example: SetFormFieldBorderStyle"

Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF()

If gdpicturePDF.LoadFromFile("forms.pdf", False) = 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

            Dim formID As Integer = gdpicturePDF.AddPushButtonFormField(1, 1, 6, 2, "PushButton", "GO!", fontResName, 20, 255, 69, 0)

            If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                Dim formType As PdfFormFieldType = gdpicturePDF.GetFormFieldType(formID)

                If (gdpicturePDF.GetStat() = GdPictureStatus.OK) AndAlso

                   (gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) = GdPictureStatus.OK) AndAlso

                   (gdpicturePDF.SetFormFieldBorderColor(formID, 0, 0, 0) = GdPictureStatus.OK) AndAlso

                   (gdpicturePDF.SetFormFieldBorderStyle(formID, 0.2F, PdfAnnotationBorderStyle.PdfAnnotationBorderStyleDashed, 0.4F, 0.2F) = GdPictureStatus.OK) Then

                    Dim actionID As Integer = gdpicturePDF.NewActionURI("http://www.gdpicture.com", False)

                    If (gdpicturePDF.GetStat() = GdPictureStatus.OK) AndAlso

                       (gdpicturePDF.SetFormFieldAction(formID, actionID) = GdPictureStatus.OK) Then

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

                            MessageBox.Show("The file has been saved successfully.", caption)

                        Else

                            MessageBox.Show("The file can't be saved. Status: " + gdpicturePDF.GetStat().ToString(), caption)

                        End If

                    Else

                        MessageBox.Show("Creating an action has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)

                    End If

                Else

                    MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)

                End If

            Else

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

GdPicturePDF gdpicturePDF = new GdPicturePDF();

if (gdpicturePDF.LoadFromFile("forms.pdf", false) == 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)

        {

            int formID = gdpicturePDF.AddPushButtonFormField(1, 1, 6, 2, "PushButton", "GO!", fontResName, 20, 255, 69, 0);

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

            {

                PdfFormFieldType formType = gdpicturePDF.GetFormFieldType(formID);

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

                    (gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) == GdPictureStatus.OK) &&

                    (gdpicturePDF.SetFormFieldBorderColor(formID, 0, 0, 0) == GdPictureStatus.OK) &&

                    (gdpicturePDF.SetFormFieldBorderStyle(formID, 0.2f, PdfAnnotationBorderStyle.PdfAnnotationBorderStyleDashed, 0.4f, 0.2f) == GdPictureStatus.OK))

                {

                    int actionID = gdpicturePDF.NewActionURI("http://www.gdpicture.com", false);

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

                        (gdpicturePDF.SetFormFieldAction(formID, actionID) == GdPictureStatus.OK))

                    {

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

                            MessageBox.Show("The file has been saved successfully.", caption);

                        else

                            MessageBox.Show("The file can't be saved. Status: " + gdpicturePDF.GetStat().ToString(), caption);

                    }

                    else

                        MessageBox.Show("Creating an action has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);

                }

                else

                    MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);

            }

            else

                MessageBox.Show("The AddPushButtonFormField() 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();
Example
How to set the dashed border for the newly added push button. Dim caption As String = "Example: SetFormFieldBorderStyle" Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF() If gdpicturePDF.LoadFromFile("forms.pdf", False) = 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 Dim formID As Integer = gdpicturePDF.AddPushButtonFormField(1, 1, 6, 2, "PushButton", "GO!", fontResName, 20, 255, 69, 0) If gdpicturePDF.GetStat() = GdPictureStatus.OK Then Dim formType As PdfFormFieldType = gdpicturePDF.GetFormFieldType(formID) If (gdpicturePDF.GetStat() = GdPictureStatus.OK) AndAlso (gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) = GdPictureStatus.OK) AndAlso (gdpicturePDF.SetFormFieldBorderColor(formID, 0, 0, 0) = GdPictureStatus.OK) AndAlso (gdpicturePDF.SetFormFieldBorderStyle(formID, 0.2F, PdfAnnotationBorderStyle.PdfAnnotationBorderStyleDashed, 0.4F, 0.2F) = GdPictureStatus.OK) Then Dim actionID As Integer = gdpicturePDF.NewActionURI("http://www.gdpicture.com", False) If (gdpicturePDF.GetStat() = GdPictureStatus.OK) AndAlso (gdpicturePDF.SetFormFieldAction(formID, actionID) = GdPictureStatus.OK) Then If gdpicturePDF.SaveToFile("forms_updated.pdf") = GdPictureStatus.OK Then MessageBox.Show("The file has been saved successfully.", caption) Else MessageBox.Show("The file can't be saved. Status: " + gdpicturePDF.GetStat().ToString(), caption) End If Else MessageBox.Show("Creating an action has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption) End If Else MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption) End If Else MessageBox.Show("The AddPushButtonFormField() 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: SetFormFieldBorderStyle"; GdPicturePDF gdpicturePDF = new GdPicturePDF(); if (gdpicturePDF.LoadFromFile("forms.pdf", false) == 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) { int formID = gdpicturePDF.AddPushButtonFormField(1, 1, 6, 2, "PushButton", "GO!", fontResName, 20, 255, 69, 0); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) { PdfFormFieldType formType = gdpicturePDF.GetFormFieldType(formID); if ((gdpicturePDF.GetStat() == GdPictureStatus.OK) && (gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) == GdPictureStatus.OK) && (gdpicturePDF.SetFormFieldBorderColor(formID, 0, 0, 0) == GdPictureStatus.OK) && (gdpicturePDF.SetFormFieldBorderStyle(formID, 0.2f, PdfAnnotationBorderStyle.PdfAnnotationBorderStyleDashed, 0.4f, 0.2f) == GdPictureStatus.OK)) { int actionID = gdpicturePDF.NewActionURI("http://www.gdpicture.com", false); if ((gdpicturePDF.GetStat() == GdPictureStatus.OK) && (gdpicturePDF.SetFormFieldAction(formID, actionID) == GdPictureStatus.OK)) { if (gdpicturePDF.SaveToFile("forms_updated.pdf") == GdPictureStatus.OK) MessageBox.Show("The file has been saved successfully.", caption); else MessageBox.Show("The file can't be saved. Status: " + gdpicturePDF.GetStat().ToString(), caption); } else MessageBox.Show("Creating an action has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption); } else MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption); } else MessageBox.Show("The AddPushButtonFormField() 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();
See Also

Reference

GdPicturePDF Class
GdPicturePDF Members
Overload List
GetMeasurementUnit Method
SetMeasurementUnit Method
GetFormFieldId Method
GetFormFieldChildID Method
SetMeasurementUnit Method
GetFormFieldBorderStyle(Int32,Single,PdfAnnotationBorderStyle,Single,Single) 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